xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/LeakDetection_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################       -->
4<!--# Redfish Schema:  LeakDetection v1.1.0                                                -->
5<!--#                                                                                      -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
7<!--# available at http://www.dmtf.org/standards/redfish                                   -->
8<!--# Copyright 2014-2025 DMTF.                                                            -->
9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################       -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16  </edmx:Reference>
17  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19  </edmx:Reference>
20  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22  </edmx:Reference>
23  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24    <edmx:Include Namespace="Resource"/>
25    <edmx:Include Namespace="Resource.v1_0_0"/>
26  </edmx:Reference>
27  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Sensor_v1.xml">
28    <edmx:Include Namespace="Sensor"/>
29  </edmx:Reference>
30  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LeakDetector_v1.xml">
31    <edmx:Include Namespace="LeakDetector"/>
32  </edmx:Reference>
33  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LeakDetectorCollection_v1.xml">
34    <edmx:Include Namespace="LeakDetectorCollection"/>
35  </edmx:Reference>
36
37  <edmx:DataServices>
38
39    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetection">
40      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
41      <Annotation Term="Redfish.Language" String="en"/>
42
43      <EntityType Name="LeakDetection" BaseType="Resource.v1_0_0.Resource" Abstract="true">
44        <Annotation Term="OData.Description" String="The `LeakDetection` schema contains definitions for reporting leaks in liquid cooling systems or other equipment."/>
45        <Annotation Term="OData.LongDescription" String="This resource shall represent the leak detection functionality present in a service for a Redfish implementation."/>
46        <Annotation Term="Capabilities.InsertRestrictions">
47          <Record>
48            <PropertyValue Property="Insertable" Bool="false"/>
49          </Record>
50        </Annotation>
51        <Annotation Term="Capabilities.UpdateRestrictions">
52          <Record>
53            <PropertyValue Property="Updatable" Bool="false"/>
54          </Record>
55        </Annotation>
56        <Annotation Term="Capabilities.DeleteRestrictions">
57          <Record>
58            <PropertyValue Property="Deletable" Bool="false"/>
59          </Record>
60        </Annotation>
61        <Annotation Term="Redfish.Uris">
62          <Collection>
63            <String>/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/LeakDetection</String>
64            <String>/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/LeakDetection</String>
65            <String>/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/LeakDetection</String>
66            <String>/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/LeakDetection</String>
67            <String>/redfish/v1/ThermalEquipment/RPUs/{CoolingUnitId}/LeakDetection</String>
68          </Collection>
69        </Annotation>
70      </EntityType>
71    </Schema>
72
73    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetection.v1_0_0">
74      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
75      <Annotation Term="Redfish.Release" String="2023.1"/>
76
77      <EntityType Name="LeakDetection" BaseType="LeakDetection.LeakDetection">
78        <Property Name="Status" Type="Resource.Status" Nullable="false">
79          <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
80          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
81        </Property>
82        <Property Name="LeakDetectorGroups" Type="Collection(LeakDetection.v1_0_0.LeakDetectorGroup)" Nullable="false">
83          <Annotation Term="OData.Description" String="The groups of leak detection equipment."/>
84          <Annotation Term="OData.LongDescription" String="This property shall contain an array of leak detection groups."/>
85        </Property>
86        <NavigationProperty Name="LeakDetectors" Type="LeakDetectorCollection.LeakDetectorCollection" Nullable="false">
87          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
88          <Annotation Term="OData.Description" String="The link to the collection of leak detectors within this subsystem."/>
89          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `LeakDetectorCollection`."/>
90          <Annotation Term="OData.AutoExpandReferences"/>
91          <Annotation Term="Redfish.Revisions">
92            <Collection>
93              <Record>
94                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
95                <PropertyValue Property="Version" String="v1_1_0"/>
96                <PropertyValue Property="Description" String="This property has been deprecated in favor of the `LeakDetectors` property in the related `Chassis` resource."/>
97              </Record>
98            </Collection>
99          </Annotation>
100        </NavigationProperty>
101        <Property Name="Actions" Type="LeakDetection.v1_0_0.Actions" Nullable="false">
102          <Annotation Term="OData.Description" String="The available actions for this resource."/>
103          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
104        </Property>
105      </EntityType>
106
107      <ComplexType Name="LeakDetectorGroup">
108        <Annotation Term="OData.Description" String="A group of leak detection equipment."/>
109        <Annotation Term="OData.LongDescription" String="This object shall contain a group of leak detection equipment that reports a unified status."/>
110        <Property Name="GroupName" Type="Edm.String" Nullable="false">
111          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
112          <Annotation Term="OData.Description"  String="The name of this leak detector group."/>
113          <Annotation Term="OData.LongDescription" String="This property shall contain the name used to describe this group of leak detectors and related equipment."/>
114        </Property>
115        <NavigationProperty Name="HumidityPercent" Type="Sensor.Sensor">
116          <Annotation Term="Redfish.ExcerptCopy"/>
117          <Annotation Term="OData.Description" String="Humidity (percent)."/>
118          <Annotation Term="OData.LongDescription" String="This property shall contain the humidity, in percent units, for this resource.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Humidity`."/>
119        </NavigationProperty>
120        <NavigationProperty Name="Detectors" Type="Collection(LeakDetector.LeakDetector)">
121          <Annotation Term="Redfish.ExcerptCopy" String="Array"/>
122          <Annotation Term="OData.Description" String="The leak detection states from all related leak detection devices in this group."/>
123          <Annotation Term="OData.LongDescription" String="This property shall contain the states of all leak detection devices in this detector group.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `LeakDetector`."/>
124        </NavigationProperty>
125      </ComplexType>
126
127      <ComplexType Name="Actions">
128        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
129        <Annotation Term="OData.Description" String="The available actions for this resource."/>
130        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
131        <Property Name="Oem" Type="LeakDetection.v1_0_0.OemActions" Nullable="false">
132          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
133          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
134        </Property>
135      </ComplexType>
136
137      <ComplexType Name="OemActions">
138        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
139        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
140        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
141      </ComplexType>
142    </Schema>
143
144    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetection.v1_0_1">
145      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
146      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
147      <EntityType Name="LeakDetection" BaseType="LeakDetection.v1_0_0.LeakDetection"/>
148    </Schema>
149
150    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetection.v1_1_0">
151      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
152      <Annotation Term="Redfish.Release" String="2024.3"/>
153      <Annotation Term="OData.Description" String="This version was created to deprecate the `LeakDetectors` property in favor of placing leak detectors under the related `Chassis` resource."/>
154
155      <EntityType Name="LeakDetection" BaseType="LeakDetection.v1_0_1.LeakDetection"/>
156
157      <ComplexType Name="LeakDetectorGroup" BaseType="LeakDetection.v1_0_0.LeakDetectorGroup">
158        <Property Name="Status" Type="Resource.Status" Nullable="false">
159          <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
160          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
161          <Annotation Term="Redfish.Required"/>
162        </Property>
163      </ComplexType>
164    </Schema>
165
166  </edmx:DataServices>
167</edmx:Edmx>
168