xref: /openbmc/bmcweb/redfish-core/schema/dmtf/csdl/RedfishExtensions_v1.xml (revision f2a8e57e)

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  RedfishExtensions v1.0.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-2024 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://redfish.dmtf.org/schemas/v1/Settings_v1.xml">
    <edmx:Include Namespace="Settings"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/CollectionCapabilities_v1.xml">
    <edmx:Include Namespace="CollectionCapabilities"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Certificate_v1.xml">
    <edmx:Include Namespace="Certificate"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ResourceBlock_v1.xml">
    <edmx:Include Namespace="ResourceBlock"/>
  </edmx:Reference>

  <edmx:DataServices>

    <!--These terms extend the schema language for Redfish-specific information-->
    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm"  Namespace="RedfishExtensions.v1_0_0">
      <Annotation Term="RedfishExtensions.v1_0_0.OwningEntity" String="DMTF"/>

      <Term Name="AllowableValues" Type="Collection(Edm.String)" Nullable="false">
        <Annotation Term="OData.Description" String="The set of allowable values for an action parameter or read-write property."/>
      </Term>
      <Term Name="AllowableNumbers" Type="Collection(Edm.String)" Nullable="false">
        <Annotation Term="OData.Description" String="The term specifies the numeric values or duration values, inclusive ranges of values, and incremental step values for a read-write property that are supported by the service, as defined in the 'Allowable values for numbers and durations' clause of the Redfish Specification."/>
      </Term>
      <Term Name="AllowablePattern" Type="Edm.String" Nullable="false">
        <Annotation Term="OData.Description" String="The term specifies a regular expression that describes the allowable values for a read-write property as supported by the service."/>
      </Term>
      <Term Name="WriteableProperties" Type="Collection(Edm.String)" Nullable="false">
        <Annotation Term="OData.Description" String="The term specifies the properties supported as read-write.  The values contained are the names of the writable properties as defined in the Redfish schema that are available as read-write given the implementation, current configuration, and state of the resource.  This term might appear at the root level of a resource, or within an object.  For arrays of objects, the term might only appear in the first element of the array to indicate identical capabilities for every element in the array."/>
      </Term>
      <Term Name="Required" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="OData.Description" String="This term specifies that a property is required to be supported by services.  Properties not annotated as required are optional."/>
      </Term>
      <Term Name="RequiredOnCreate" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="OData.Description" String="The term specifies that a property is required to be specified in the body of a `POST` request to create the resource."/>
      </Term>
      <Term Name="Settings" Type="Settings.Settings">
        <Annotation Term="OData.Description" String="The link to the settings resource that represents the settings to apply to this resource."/>
      </Term>
      <Term Name="AutoExpandReferences" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="RedfishExtensions.v1_0_0.Deprecated" String="This term has been deprecated in favor of `OData.AutoExpandReferences`."/>
        <Annotation Term="OData.Description" String="This term can be applied to a navigation property to specify that the default behavior for the service is to expand the links to the related resource or resource collection in responses."/>
      </Term>
      <Term Name="AutoExpand" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="RedfishExtensions.v1_0_0.Deprecated" String="This term has been deprecated in favor of `OData.AutoExpand`."/>
        <Annotation Term="OData.Description" String="The term can be applied to a navigation property to specify that the default behavior for the service is to expand the related resource or resource collection in responses."/>
      </Term>
      <Term Name="IPv6Format" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="OData.Description" String="The term can be applied to a property or parameter to specify that IPv6 addressing rules apply to that property or parameter."/>
      </Term>
      <Term Name="Copyright" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term is applied to Redfish payload samples to specify copyright information.  It would not generally be used in production payloads."/>
      </Term>
      <Term Name="Deprecated" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term is applied to a property or value to specify that the property or value is deprecated.  The string value should explain the deprecation, including new property or properties or value to use.  The property or value can be supported in new and existing implementations, but usage in new implementations is discouraged.  Deprecated properties and values are likely to be removed in a future major version of the schema."/>
      </Term>
      <Term Name="ActionInfo" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term can be applied to an action to specify a URI to an `ActionInfo` resource that describes the parameters supported by this instance of the action."/>
        <Annotation Term="OData.IsURL"/>
      </Term>
      <Term Name="DynamicPropertyPatterns" Type="Collection(RedfishExtensions.v1_0_0.PropertyPattern)" Nullable="false"/>
      <Term Name="SetOnlyOnCreate" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="OData.Description" String="The term specifies that a property can only be set when a client creates an instance of a resource through `POST`."/>
      </Term>
      <Term Name="OptionalOnCreate" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="OData.Description" String="The term specifies that a property can be set when a client creates an instance of a resource through `POST`."/>
      </Term>
      <Term Name="UpdatableAfterCreate" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="OData.Description" String="The term specifies that a property can be set by a client that uses `PATCH` after it creates an instance of a resource through `POST`."/>
      </Term>
      <Term Name="CollectionCapabilities" Type="CollectionCapabilities.CollectionCapabilities">
        <Annotation Term="OData.Description" String="The link to the resource that represents the `POST` capabilities of a collection."/>
      </Term>
      <Term Name="Confidential" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term specifies that a schema or property is un-released and confidential material that is not meant for public disclosure."/>
      </Term>
      <Term Name="Release" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term specifies the version of the release bundle in which this schema or versioned namespace was first released."/>
      </Term>
      <Term Name="ReleaseStatus" Type="RedfishExtensions.v1_0_0.ReleaseStatusType">
        <Annotation Term="OData.Description" String="The term specifies the public release status of a property or schema."/>
      </Term>
      <Term Name="SettingsApplyTime" Type="Settings.PreferredApplyTime">
        <Annotation Term="OData.Description" String="The configuration settings for when the values in the settings object are applied to a resource."/>
      </Term>
      <Term Name="OperationApplyTime" Type="Settings.OperationApplyTime">
        <Annotation Term="OData.Description" String="The requested apply time from a client when performing a create, delete, or action operation."/>
      </Term>
      <Term Name="OperationApplyTimeSupport" Type="Settings.OperationApplyTimeSupport">
        <Annotation Term="OData.Description" String="An indication of whether a client can request an apply time for a create, delete, or action operation of a resource through the `OperationApplyTime` term."/>
      </Term>
      <Term Name="MaintenanceWindow" Type="Settings.MaintenanceWindow">
        <Annotation Term="OData.Description" String="The maintenance window configuration for a resource for when to apply settings or operations."/>
      </Term>
      <Term Name="OwningEntity" Type="Edm.String">
        <Annotation Term="OData.Description" String="The name of the entity responsible for development, publication, and maintenance of a schema.  Possible values include `DMTF` or `SNIA`, or an OEM label from a Redfish OEM extension section."/>
      </Term>
      <Term Name="Uris" Type="Collection(Edm.String)">
        <Annotation Term="OData.Description" String="The term specifies the URIs that a service can use for the resource."/>
      </Term>
      <Term Name="DeprecatedUris" Type="Collection(Edm.String)">
        <Annotation Term="OData.Description" String="The term specifies the deprecated URIs that a service can use for the resource.  Each URI listed is also specified in the `Uris` term."/>
      </Term>
      <Term Name="RequestedCount" Type="Edm.Int64">
        <Annotation Term="OData.Description" String="The term is used by a client to specify a request for a quantity of items."/>
      </Term>
      <Term Name="RequestedCountRequired" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="OData.Description" String="The term specifies that a client is required to provide the `@Redfish.RequestedCount` term as part of the payload to specify a quantity of items."/>
      </Term>
      <Term Name="AllowOverprovisioning" Type="Edm.Boolean" DefaultValue="false">
        <Annotation Term="OData.Description" String="The term specifies that a client allows the service to provide more resources than requested, which includes, but is not limited to, a larger quantity of items, larger capacity, and faster devices."/>
        <Annotation Term="OData.LongDescription" String="The term shall specify that a client allows the service to provide more resources than requested, which includes, but is not limited to, a larger quantity of items, larger capacity, and faster devices.  If not specified by the client, the service shall treat this as `false`."/>
      </Term>
      <Term Name="ZoneAffinity" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term specifies that a client requests that the service fulfills a request with resources available within a specific zone resource.  The term value is the `Id` property of the zone resource."/>
        <Annotation Term="OData.LongDescription" String="The term shall specify that a client requests that the service fulfills a request with resources available in a specific zone resource.  The term value shall contain the `Id` property of the zone resource.  This term shall only be at the root level of the request payload."/>
      </Term>
      <Term Name="Filter" Type="Edm.String">
        <Annotation Term="OData.Description" String="The filter to apply to an array of objects when the values are copies of data elsewhere in the data model."/>
        <Annotation Term="OData.LongDescription" String="The term shall specify a filter to apply to a set of objects used as the data source for an array.  The term value shall follow the Redfish Specification-specified filter query parameter format.  Items that match the filter shall appear in the resulting array, while items that do not match the filter shall be excluded from the results."/>
      </Term>
      <Term Name="Excerpt" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term specifies that the property is an excerpt data element that appears in objects marked as an excerpt copy when the term value matches the excerpt copy term type.  The value contains a property name to use as a key, and the `key` property value, and only one key property can be defined for each resource.  If the term value is unspecified, the property appears in all excerpt copy instances."/>
      </Term>
      <Term Name="ExcerptCopy" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term specifies that the object or property definition is a copy of data from a source elsewhere in the data model, and that only properties marked as excerpt in that linked definition are included.  The term value contains the name of the specific excerpt from the linked definition.  If the term value is not defined, all excerpt properties are copied from the linked definition."/>
      </Term>
      <Term Name="ExcerptCopyOnly" Type="Edm.Boolean" DefaultValue="true">
        <Annotation Term="OData.Description" String="The term specifies that the property is a data element that appears only when the resource definition is used as a copy, using the excerpt copy term, and does not appear in the original data resource."/>
      </Term>
      <Term Name="SupportedCertificates" Type="Collection(Certificate.CertificateType)">
        <Annotation Term="OData.Description" String="The term specifies the supported certificate formats for a given certificate collection."/>
      </Term>
      <Term Name="ResourceBlockLimits" Type="ResourceBlock.ResourceBlockLimits">
        <Annotation Term="OData.Description" String="The term specifies the allowable quantities of types of resource blocks for a composition request."/>
      </Term>
      <Term Name="Language" Type="Edm.String" DefaultValue="en">
        <Annotation Term="OData.Description" String="The term specifies the ISO 639-1 language code (Alpha-2) that matches the language used for the descriptive text in this schema file.  If this term is not present, the default value is English (en)."/>
      </Term>
      <Term Name="Translation" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term specifies a translated language (localized) version of the property name, parameter, or enumeration string.  The language matches the `Redfish.Language` value for this schema."/>
      </Term>
      <Term Name="License" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term specifies licensing information for a Redfish schema or registry."/>
      </Term>
      <Term Name="URISegment" Type="Edm.String">
        <Annotation Term="OData.Description" String="The term specifies the segment appended to the URI of the resource when constructing the URI of a subordinate resource if the segment differs from the property name."/>
      </Term>
      <Term Name="IsEmail" Type="Edm.Boolean" DefaultValue="false">
        <Annotation Term="OData.Description" String="The term specifies that a property is an email address and will match email address formatting when specified."/>
      </Term>

      <EnumType Name="ReleaseStatusType">
        <Member Name="Standard">
          <Annotation Term="OData.Description" String="Released as normative standard or specification."/>
        </Member>
        <Member Name="Informational">
          <Annotation Term="OData.Description" String="Released as an informational, non-normative document."/>
        </Member>
        <Member Name="WorkInProgress">
          <Annotation Term="OData.Description" String="Released as Work In Progress, subject to change perhaps profoundly and without notice."/>
        </Member>
        <Member Name="InDevelopment">
          <Annotation Term="OData.Description" String="Un-released work product currently under development or review."/>
        </Member>
      </EnumType>

      <ComplexType Name="PropertyPattern">
        <Annotation Term="OData.Description" String="The pattern by which property names must adhere."/>
        <Annotation Term="OData.LongDescription" String="This type shall describe the pattern to which a dynamic property name adheres."/>
        <Property Name="Pattern" Type="Edm.String">
          <Annotation Term="OData.Description" String="The pattern that the property name is allowed to match."/>
          <Annotation Term="OData.LongDescription" String="This shall contain the pattern that the property name is allowed to match."/>
        </Property>
        <Property Name="Type" Type="Edm.String">
          <Annotation Term="OData.Description" String="The data type for any property names matching the pattern."/>
          <Annotation Term="OData.LongDescription" String="This shall contain the data type for any property names matching the pattern."/>
        </Property>
      </ComplexType>

      <Term Name="Revisions" Type="Collection(RedfishExtensions.v1_0_0.RevisionType)" Nullable="false">
        <Annotation Term="OData.Description" String="The list of revisions of a model element."/>
      </Term>

      <ComplexType Name="RevisionType">
        <Annotation Term="OData.Description" String="The structure that contains revision information."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain revision information."/>
        <Property Name="Version" Type="Edm.String" Nullable="true">
          <Annotation Term="OData.Description" String="The schema version with which this revision was first published."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the schema version with which this revision was first published."/>
        </Property>
        <Property Name="Kind" Type="RedfishExtensions.v1_0_0.RevisionKind" Nullable="false">
          <Annotation Term="OData.Description" String="The kind of revision."/>
          <Annotation Term="OData.LongDescription" String="This property shall describe the type of change made."/>
        </Property>
        <Property Name="Description" Type="Edm.String">
          <Annotation Term="OData.Description" String="The reason for the revision."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a description of the change."/>
        </Property>
      </ComplexType>

      <EnumType Name="RevisionKind">
        <Member Name="Added">
          <Annotation Term="OData.Description" String="Model element was added."/>
        </Member>
        <Member Name="Modified">
          <Annotation Term="OData.Description" String="Model element was modified."/>
        </Member>
        <Member Name="Deprecated">
          <Annotation Term="OData.Description" String="Model element was deprecated."/>
        </Member>
      </EnumType>

      <Term Name="Enumeration" Type="Collection(RedfishExtensions.v1_0_0.EnumerationMember)" Nullable="false">
        <Annotation Term="OData.Description" String="The term enumerates the allowable set of legacy, non-standard string values where a standard enumeration cannot be used.  This annotation should not be used for any new values."/>
      </Term>

      <ComplexType Name="EnumerationMember">
        <Annotation Term="OData.Description" String="The member of an enumeration that contains spaces, starts with a number, or otherwise does not comply with OData EnumMember naming rules.  Used for compatibility purposes for enumerations that do not comply with OData rules."/>
        <Annotation Term="OData.LongDescription" String="This type shall describe a member of an enumeration that contains spaces, starts with a number, or otherwise does not comply with OData EnumMember naming rules."/>
        <Property Name="Member" Type="Edm.String">
          <Annotation Term="OData.Description" String="An allowable string member."/>
          <Annotation Term="OData.LongDescription" String="This shall be an allowable string member for the enumeration."/>
        </Property>
      </ComplexType>
    </Schema>

    <!--These terms are used for validating a property value-->
    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm"  Namespace="Validation.v1_0_0">
      <Annotation Term="RedfishExtensions.v1_0_0.OwningEntity" String="DMTF"/>

      <Term Name="Pattern" Type="Edm.String">
        <Annotation Term="OData.Description" String="The pattern that a string property or parameter must match."/>
        <Annotation Term="OData.LongDescription" String="This term shall contain a regular expression that follows the ECMA 262 syntax."/>
      </Term>
      <Term Name="Minimum" Type="Edm.Int64">
        <Annotation Term="OData.Description" String="The minimum value for an integer property or parameter."/>
      </Term>
      <Term Name="Maximum" Type="Edm.Int64">
        <Annotation Term="OData.Description" String="The maximum value for an integer property or parameter."/>
      </Term>

    </Schema>

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