1description: >
2    Implement to provide attributes for leak detector.
3
4properties:
5    - name: PrettyName
6      type: string
7      description: >
8          The human readable name of the leak detector.
9      flags:
10          - readonly
11    - name: State
12      type: enum[self.DetectorState]
13      description: >
14          The state of the leak detector.
15      flags:
16          - readonly
17    - name: Type
18      type: enum[self.DetectorType]
19      description: >
20          The type of the leak detector.
21
22enumerations:
23    - name: DetectorType
24      description: >
25          This indicates the type of leak detector as in Redfish LeakDetector
26          schema https://redfish.dmtf.org/schemas/v1/LeakDetector.v1_2_0.json.
27      values:
28          - name: LeakSensingCable
29            description: >
30                A leak sensing cable.
31          - name: Unknown
32            description: >
33                An unknown detector type
34    - name: DetectorState
35      description: >
36          This indicates the state of the leak detector
37      values:
38          - name: Normal
39            description: >
40                The state is normal as no leaks have been detected by the leak
41                detector.
42          - name: Abnormal
43            description: >
44                A leak has been detected by the leak detector, indicating an
45                abnormal leak state.
46          - name: Unknown
47            description: >
48                The state cannot be determined as the detector may be faulty.
49
50associations:
51    - name: monitoring
52      description: >
53          Leak detectors can optionally implement the 'monitoring' association
54          with the inventory item related to it.
55      reverse_name: monitored_by
56      required_endpoint_interfaces:
57          - xyz.openbmc_project.Inventory.Item
58
59paths:
60    - namespace: /xyz/openbmc_project/state/leak
61      description: >
62          The root path for state of all leak objects.
63      segments:
64          - name: Detector
65            description: >
66                The leak detector.
67            value: detector
68