xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/LeakDetector_v1.xml (revision 5ecf7b4e1bb6988dd3403fa80b723afbe2be30ae)

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  LeakDetector v1.5.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://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
    <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
  </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/PhysicalContext_v1.xml">
    <edmx:Include Namespace="PhysicalContext"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Control_v1.xml">
    <edmx:Include Namespace="Control"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Redundancy_v1.xml">
    <edmx:Include Namespace="Redundancy"/>
  </edmx:Reference>

  <edmx:DataServices>

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

      <EntityType Name="LeakDetector" BaseType="Resource.v1_0_0.Resource" Abstract="true">
        <Annotation Term="OData.Description" String="The `LeakDetector` schema describes a state-based or digital-value leak detector and its properties."/>
        <Annotation Term="OData.LongDescription" String="This resource shall represent a state-based or digital-value leak detector 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="true"/>
          </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/LeakDetectors/{LeakDetectorId}</String>
            <String>/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/LeakDetection/LeakDetectors/{LeakDetectorId}</String>
            <String>/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/LeakDetection/LeakDetectors/{LeakDetectorId}</String>
            <String>/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/LeakDetection/LeakDetectors/{LeakDetectorId}</String>
            <String>/redfish/v1/Chassis/{ChassisId}/LeakDetectors/{LeakDetectorId}</String>
          </Collection>
        </Annotation>
        <Annotation Term="Redfish.DeprecatedUris">
          <Collection>
            <String>/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/LeakDetection/LeakDetectors/{LeakDetectorId}</String>
            <String>/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/LeakDetection/LeakDetectors/{LeakDetectorId}</String>
            <String>/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/LeakDetection/LeakDetectors/{LeakDetectorId}</String>
            <String>/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/LeakDetection/LeakDetectors/{LeakDetectorId}</String>
          </Collection>
        </Annotation>
      </EntityType>
    </Schema>

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

      <EntityType Name="LeakDetector" BaseType="LeakDetector.LeakDetector">
        <Property Name="LeakDetectorType" Type="LeakDetector.v1_0_0.LeakDetectorType">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The type of leak detection sensor."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the reading type of the leak detection sensor."/>
        </Property>
        <Property Name="DataSourceUri" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The link to the resource that provides the data for this leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy."/>
          <Annotation Term="OData.IsURL"/>
          <Annotation Term="Redfish.ExcerptCopyOnly"/>
        </Property>
        <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="DetectorState" Type="LeakDetector.v1_0_0.DetectorState">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The state of the leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the state of the leak detector.  The value of this property should equate to the value of `Health` in `Status` when the detector is enabled and functional.  If a fault occurs with the detector itself, such as a short or a disconnected cable, the `Conditions` property in `Status` should indicate the type of fault detected."/>
          <Annotation Term="Redfish.Excerpt"/>
        </Property>
        <Property Name="PhysicalContext" Type="PhysicalContext.PhysicalContext">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The area or device to which this leak detector applies."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a description of the affected component or region within the equipment to which this leak detector applies."/>
          <Annotation Term="Redfish.Excerpt" String="Array"/>
        </Property>
        <Property Name="PhysicalSubContext" Type="PhysicalContext.PhysicalSubContext">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The usage or location within a device to which this leak detector applies."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a description of the usage or sub-region within the equipment to which this leak detector applies.  This property generally differentiates multiple leak detectors within the same `PhysicalContext` instance."/>
          <Annotation Term="Redfish.Excerpt" String="Array"/>
        </Property>
        <Property Name="Location" Type="Resource.Location" Nullable="false">
          <Annotation Term="OData.Description" String="The location information for this leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the location information for this leak detector."/>
        </Property>
        <Property Name="SensingFrequency" Type="Edm.Decimal">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The time interval between readings of the physical leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the time interval between readings of the physical leak detector."/>
        </Property>
        <Property Name="Manufacturer" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The manufacturer of this leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the name of the organization responsible for producing the leak detector.  This organization may be the entity from whom the leak detector is purchased, but this is not necessarily true."/>
        </Property>
        <Property Name="Model" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The model number of the leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the name by which the manufacturer generally refers to the leak detector."/>
        </Property>
        <Property Name="SKU" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The SKU of the leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the stock-keeping unit number for this leak detector."/>
        </Property>
        <Property Name="SerialNumber" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The serial number of the leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a manufacturer-allocated number that identifies the leak detector."/>
        </Property>
        <Property Name="PartNumber" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The part number of the leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the leak detector."/>
        </Property>
        <Property Name="SparePartNumber" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The spare part number of the leak detector."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the spare part number of the leak detector."/>
        </Property>
        <Property Name="Actions" Type="LeakDetector.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="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="LeakDetector.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>

      <EnumType Name="LeakDetectorType">
        <Member Name="Moisture">
          <Annotation Term="OData.Description" String="A moisture sensor."/>
        </Member>
        <Member Name="FloatSwitch">
          <Annotation Term="OData.Description" String="A float switch."/>
        </Member>
      </EnumType>

      <EnumType Name="DetectorState">
        <Member Name="OK">
          <Annotation Term="OData.Description" String="Normal."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate that there is no leak detected and the detector is operating normally."/>
        </Member>
        <Member Name="Warning">
          <Annotation Term="OData.Description" String="A warning-level leak is detected."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate that a warning-level leak is detected."/>
        </Member>
        <Member Name="Critical">
          <Annotation Term="OData.Description" String="A critical leak is detected."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate that a critical-level leak is detected."/>
        </Member>
        <Member Name="Unavailable">
          <Annotation Term="OData.Description" String="No data is available from the detector."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate that no valid data can be acquired from the detector, due to a fault condition within the detector, a disconnected cable, or the detector is disabled."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="v1_5_0"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
        <Member Name="Absent">
          <Annotation Term="OData.Description" String="The detector is not present."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate that the implementation supports a leak detector, but no leak detector is installed or configured."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="v1_5_0"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
      </EnumType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetector.v1_0_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
      <EntityType Name="LeakDetector" BaseType="LeakDetector.v1_0_0.LeakDetector"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetector.v1_0_2">
      <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="LeakDetector" BaseType="LeakDetector.v1_0_1.LeakDetector"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetector.v1_0_3">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to clarify that the value of `DetectorState` should reflect the `Health` of the detector."/>
      <EntityType Name="LeakDetector" BaseType="LeakDetector.v1_0_2.LeakDetector"/>
    </Schema>

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

      <EntityType Name="LeakDetector" BaseType="LeakDetector.v1_0_2.LeakDetector">
        <Property Name="UserLabel" Type="Edm.String" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="A user-assigned label."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a user-assigned label used to identify this resource.  If a value has not been assigned by a user, the value of this property shall be an empty string."/>
        </Property>
      </EntityType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetector.v1_1_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to clarify that the value of `DetectorState` should reflect the `Health` of the detector."/>
      <EntityType Name="LeakDetector" BaseType="LeakDetector.v1_1_0.LeakDetector"/>
    </Schema>

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

      <EntityType Name="LeakDetector" BaseType="LeakDetector.v1_1_1.LeakDetector">
        <Property Name="DeviceName" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The name of the device."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the name of the device associated with this leak detector.  If the device is represented by a resource, the value shall contain the value of the `Name` property of the associated resource."/>
          <Annotation Term="Redfish.Excerpt" String="Array"/>
          <Annotation Term="Redfish.ExcerptCopyOnly"/>
        </Property>
      </EntityType>
    </Schema>

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

      <EntityType Name="LeakDetector" BaseType="LeakDetector.v1_2_0.LeakDetector">
        <Property Name="Enabled" Type="Edm.Boolean">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="Indicates whether the leak detector is enabled and provides a status."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate whether the leak detector is enabled.  The value `true` shall indicate the leak detector is enabled.  The value `false` shall indicate the leak detector is disabled.  When disabled, `DetectorState` shall contain `Unavailable` and the leak detector shall not trigger events, logging, or other functionality.  This property allows a user to disable a faulty leak detector or to otherwise remove it from use."/>
        </Property>
      </EntityType>
    </Schema>

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

      <EntityType Name="LeakDetector" BaseType="LeakDetector.v1_3_0.LeakDetector">
        <Property Name="CriticalReactionType" Type="LeakDetector.v1_4_0.ReactionType" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The reaction to perform when a critical leak is detected."/>
          <Annotation Term="OData.LongDescription" String="The reaction that shall be performed when the `DetectorState` property changes to `Critical`."/>
        </Property>
        <Property Name="WarningReactionType" Type="LeakDetector.v1_4_0.ReactionType" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The reaction to perform when a warning-level leak is detected."/>
          <Annotation Term="OData.LongDescription" String="The reaction that shall be performed when the `DetectorState` property changes to `Warning`."/>
        </Property>
        <Property Name="ReactionDelaySeconds" Type="Edm.Int64" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The delay in seconds after a leak is detected before the selected reaction is executed."/>
          <Annotation Term="OData.LongDescription" String="The value shall indicate the number of seconds to delay after the `DetectorState` changes before the selected reaction is executed.  If the `DetectorState` returns to `OK` prior to the delay value, the service shall not perform the reaction."/>
          <Annotation Term="Measures.Unit" String="s"/>
        </Property>
      </EntityType>

      <EnumType Name="ReactionType">
        <Member Name="None">
          <Annotation Term="OData.Description" String="No reaction."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate no reaction occurs when a leak is detected."/>
        </Member>
        <Member Name="ForceOff">
          <Annotation Term="OData.Description" String="Forcefully shut down the device, equipment, or system."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate that the associated device, equipment, or system monitored by this leak detector is forcefully shut down when a leak is detected."/>
        </Member>
        <Member Name="GracefulShutdown">
          <Annotation Term="OData.Description" String="Gracefully shut down the device, equipment, or system."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate that the associated device, equipment, or system monitored by this leak detector is gracefully shut down when a leak is detected."/>
        </Member>
      </EnumType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LeakDetector.v1_5_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2025.3"/>
      <Annotation Term="OData.Description" String="This version was created to add `Unavailable` and `Absent` values to `DetectorState`.  It was also created to clarify the behavior of `DetectorState` when a fault condition occurs with a detector or when the `Enabled` property is set to `false`."/>

      <EntityType Name="LeakDetector" BaseType="LeakDetector.v1_4_0.LeakDetector"/>
    </Schema>

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