xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/LeakDetection_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  LeakDetection v1.1.0                                                -->
<!--#                                                                                      -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
<!--# available at http://www.dmtf.org/standards/redfish                                   -->
<!--# Copyright 2014-2025 DMTF.                                                            -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################       -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
    <edmx:Include Namespace="Resource"/>
    <edmx:Include Namespace="Resource.v1_0_0"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Sensor_v1.xml">
    <edmx:Include Namespace="Sensor"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LeakDetector_v1.xml">
    <edmx:Include Namespace="LeakDetector"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LeakDetectorCollection_v1.xml">
    <edmx:Include Namespace="LeakDetectorCollection"/>
  </edmx:Reference>

  <edmx:DataServices>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetection">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Language" String="en"/>

      <EntityType Name="LeakDetection" BaseType="Resource.v1_0_0.Resource" Abstract="true">
        <Annotation Term="OData.Description" String="The `LeakDetection` schema contains definitions for reporting leaks in liquid cooling systems or other equipment."/>
        <Annotation Term="OData.LongDescription" String="This resource shall represent the leak detection functionality present in a service for a Redfish implementation."/>
        <Annotation Term="Capabilities.InsertRestrictions">
          <Record>
            <PropertyValue Property="Insertable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.UpdateRestrictions">
          <Record>
            <PropertyValue Property="Updatable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.DeleteRestrictions">
          <Record>
            <PropertyValue Property="Deletable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Redfish.Uris">
          <Collection>
            <String>/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/LeakDetection</String>
            <String>/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/LeakDetection</String>
            <String>/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/LeakDetection</String>
            <String>/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/LeakDetection</String>
            <String>/redfish/v1/ThermalEquipment/RPUs/{CoolingUnitId}/LeakDetection</String>
          </Collection>
        </Annotation>
      </EntityType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetection.v1_0_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2023.1"/>

      <EntityType Name="LeakDetection" BaseType="LeakDetection.LeakDetection">
        <Property Name="Status" Type="Resource.Status" Nullable="false">
          <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
        </Property>
        <Property Name="LeakDetectorGroups" Type="Collection(LeakDetection.v1_0_0.LeakDetectorGroup)" Nullable="false">
          <Annotation Term="OData.Description" String="The groups of leak detection equipment."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain an array of leak detection groups."/>
        </Property>
        <NavigationProperty Name="LeakDetectors" Type="LeakDetectorCollection.LeakDetectorCollection" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The link to the collection of leak detectors within this subsystem."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `LeakDetectorCollection`."/>
          <Annotation Term="OData.AutoExpandReferences"/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
                <PropertyValue Property="Version" String="v1_1_0"/>
                <PropertyValue Property="Description" String="This property has been deprecated in favor of the `LeakDetectors` property in the related `Chassis` resource."/>
              </Record>
            </Collection>
          </Annotation>
        </NavigationProperty>
        <Property Name="Actions" Type="LeakDetection.v1_0_0.Actions" Nullable="false">
          <Annotation Term="OData.Description" String="The available actions for this resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
        </Property>
      </EntityType>

      <ComplexType Name="LeakDetectorGroup">
        <Annotation Term="OData.Description" String="A group of leak detection equipment."/>
        <Annotation Term="OData.LongDescription" String="This object shall contain a group of leak detection equipment that reports a unified status."/>
        <Property Name="GroupName" Type="Edm.String" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description"  String="The name of this leak detector group."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the name used to describe this group of leak detectors and related equipment."/>
        </Property>
        <NavigationProperty Name="HumidityPercent" Type="Sensor.Sensor">
          <Annotation Term="Redfish.ExcerptCopy"/>
          <Annotation Term="OData.Description" String="Humidity (percent)."/>
          <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`."/>
        </NavigationProperty>
        <NavigationProperty Name="Detectors" Type="Collection(LeakDetector.LeakDetector)">
          <Annotation Term="Redfish.ExcerptCopy" String="Array"/>
          <Annotation Term="OData.Description" String="The leak detection states from all related leak detection devices in this group."/>
          <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`."/>
        </NavigationProperty>
      </ComplexType>

      <ComplexType Name="Actions">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The available actions for this resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
        <Property Name="Oem" Type="LeakDetection.v1_0_0.OemActions" Nullable="false">
          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
        </Property>
      </ComplexType>

      <ComplexType Name="OemActions">
        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetection.v1_0_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <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."/>
      <EntityType Name="LeakDetection" BaseType="LeakDetection.v1_0_0.LeakDetection"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetection.v1_1_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2024.3"/>
      <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."/>

      <EntityType Name="LeakDetection" BaseType="LeakDetection.v1_0_1.LeakDetection"/>

      <ComplexType Name="LeakDetectorGroup" BaseType="LeakDetection.v1_0_0.LeakDetectorGroup">
        <Property Name="Status" Type="Resource.Status" Nullable="false">
          <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
          <Annotation Term="Redfish.Required"/>
        </Property>
      </ComplexType>
    </Schema>

  </edmx:DataServices>
</edmx:Edmx>