xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/RedfishError_v1.xml (revision d125652e8a30dfeaad88bbfa5b1e04a80610469c)
1720c9898SEd Tanous<?xml version="1.0" encoding="UTF-8"?>
2720c9898SEd Tanous<!---->
3720c9898SEd Tanous<!--################################################################################       -->
4f2a8e57eSGunnar Mills<!--# Redfish Schema:  RedfishError v1.0.2                                                 -->
5720c9898SEd Tanous<!--#                                                                                      -->
6720c9898SEd Tanous<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
7720c9898SEd Tanous<!--# available at http://www.dmtf.org/standards/redfish                                   -->
8*d125652eSGunnar Mills<!--# Copyright 2014-2025 DMTF.                                                            -->
9720c9898SEd Tanous<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10720c9898SEd Tanous<!--################################################################################       -->
11720c9898SEd Tanous<!---->
12720c9898SEd Tanous<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13720c9898SEd Tanous
14720c9898SEd Tanous  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15720c9898SEd Tanous    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16720c9898SEd Tanous  </edmx:Reference>
17720c9898SEd Tanous  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
18720c9898SEd Tanous    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
19720c9898SEd Tanous  </edmx:Reference>
20720c9898SEd Tanous
21720c9898SEd Tanous  <edmx:DataServices>
22720c9898SEd Tanous
23720c9898SEd Tanous    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm"  Namespace="RedfishError.v1_0_0">
24720c9898SEd Tanous      <Annotation Term="RedfishExtensions.v1_0_0.OwningEntity" String="DMTF"/>
25f2a8e57eSGunnar Mills      <Annotation Term="Redfish.Language" String="en"/>
26720c9898SEd Tanous
27720c9898SEd Tanous      <ComplexType Name="RedfishError">
28720c9898SEd Tanous        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
29f2a8e57eSGunnar Mills        <Annotation Term="OData.Description" String="The error payload from a Redfish service."/>
30f2a8e57eSGunnar Mills        <Annotation Term="OData.LongDescription" String="The Redfish Specification-described type shall contain an error payload from a Redfish service."/>
31720c9898SEd Tanous        <Property Name="error" Type="RedfishError.v1_0_0.RedfishErrorContents" Nullable="false">
32f2a8e57eSGunnar Mills          <Annotation Term="OData.Description" String="The properties that describe an error from a Redfish service."/>
33f2a8e57eSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property, as described by the Redfish Specification, shall contain properties that describe an error from a Redfish service."/>
34720c9898SEd Tanous          <Annotation Term="Redfish.Required"/>
35720c9898SEd Tanous        </Property>
36720c9898SEd Tanous      </ComplexType>
37720c9898SEd Tanous
38720c9898SEd Tanous      <ComplexType Name="RedfishErrorContents">
39720c9898SEd Tanous        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
40f2a8e57eSGunnar Mills        <Annotation Term="OData.Description" String="The properties that describe an error from a Redfish service."/>
41f2a8e57eSGunnar Mills        <Annotation Term="OData.LongDescription" String="The Redfish Specification-described type shall contain properties that describe an error from a Redfish service."/>
42720c9898SEd Tanous        <Property Name="code" Type="Edm.String" Nullable="false">
43720c9898SEd Tanous          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
44f2a8e57eSGunnar Mills          <Annotation Term="OData.Description" String="A string indicating a specific `MessageId` from a message registry."/>
45f2a8e57eSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain a string indicating a specific `MessageId` from a message registry."/>
46720c9898SEd Tanous          <Annotation Term="Redfish.Required"/>
47720c9898SEd Tanous        </Property>
48720c9898SEd Tanous        <Property Name="message" Type="Edm.String" Nullable="false">
49720c9898SEd Tanous          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
50f2a8e57eSGunnar Mills          <Annotation Term="OData.Description" String="A human-readable error message corresponding to the message in a message registry."/>
51f2a8e57eSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain a human-readable error message corresponding to the message in a message registry."/>
52720c9898SEd Tanous          <Annotation Term="Redfish.Required"/>
53720c9898SEd Tanous        </Property>
54720c9898SEd Tanous      </ComplexType>
55720c9898SEd Tanous    </Schema>
56720c9898SEd Tanous
57720c9898SEd Tanous    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="RedfishError.v1_0_1">
58720c9898SEd Tanous      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
59720c9898SEd Tanous      <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
60f2a8e57eSGunnar Mills      <ComplexType Name="RedfishError" BaseType="RedfishError.v1_0_0.RedfishError"/>
61f2a8e57eSGunnar Mills    </Schema>
62f2a8e57eSGunnar Mills
63f2a8e57eSGunnar Mills    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="RedfishError.v1_0_2">
64f2a8e57eSGunnar Mills      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
65f2a8e57eSGunnar Mills      <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."/>
66f2a8e57eSGunnar Mills      <ComplexType Name="RedfishError" BaseType="RedfishError.v1_0_1.RedfishError"/>
67720c9898SEd Tanous    </Schema>
68720c9898SEd Tanous
69720c9898SEd Tanous  </edmx:DataServices>
70720c9898SEd Tanous</edmx:Edmx>
71