xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/redfish-error.v1_0_2.json (revision f2a8e57ede74a8252100b2281e3f4d170aa69391)
1*f2a8e57eSGunnar Mills{
2*f2a8e57eSGunnar Mills    "$id": "http://redfish.dmtf.org/schemas/v1/redfish-error.v1_0_2.json",
3*f2a8e57eSGunnar Mills    "$ref": "#/definitions/RedfishError",
4*f2a8e57eSGunnar Mills    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5*f2a8e57eSGunnar Mills    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6*f2a8e57eSGunnar Mills    "definitions": {
7*f2a8e57eSGunnar Mills        "RedfishError": {
8*f2a8e57eSGunnar Mills            "additionalProperties": false,
9*f2a8e57eSGunnar Mills            "description": "The error payload from a Redfish service.",
10*f2a8e57eSGunnar Mills            "longDescription": "The Redfish Specification-described type shall contain an error payload from a Redfish service.",
11*f2a8e57eSGunnar Mills            "properties": {
12*f2a8e57eSGunnar Mills                "error": {
13*f2a8e57eSGunnar Mills                    "$ref": "#/definitions/RedfishErrorContents",
14*f2a8e57eSGunnar Mills                    "description": "The properties that describe an error from a Redfish service.",
15*f2a8e57eSGunnar Mills                    "longDescription": "This property, as described by the Redfish Specification, shall contain properties that describe an error from a Redfish service."
16*f2a8e57eSGunnar Mills                }
17*f2a8e57eSGunnar Mills            },
18*f2a8e57eSGunnar Mills            "required": [
19*f2a8e57eSGunnar Mills                "error"
20*f2a8e57eSGunnar Mills            ],
21*f2a8e57eSGunnar Mills            "type": "object"
22*f2a8e57eSGunnar Mills        },
23*f2a8e57eSGunnar Mills        "RedfishErrorContents": {
24*f2a8e57eSGunnar Mills            "additionalProperties": false,
25*f2a8e57eSGunnar Mills            "description": "The properties that describe an error from a Redfish service.",
26*f2a8e57eSGunnar Mills            "longDescription": "The Redfish Specification-described type shall contain properties that describe an error from a Redfish service.",
27*f2a8e57eSGunnar Mills            "properties": {
28*f2a8e57eSGunnar Mills                "code": {
29*f2a8e57eSGunnar Mills                    "description": "A string indicating a specific `MessageId` from a message registry.",
30*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain a string indicating a specific `MessageId` from a message registry.",
31*f2a8e57eSGunnar Mills                    "readonly": true,
32*f2a8e57eSGunnar Mills                    "type": "string"
33*f2a8e57eSGunnar Mills                },
34*f2a8e57eSGunnar Mills                "message": {
35*f2a8e57eSGunnar Mills                    "description": "A human-readable error message corresponding to the message in a message registry.",
36*f2a8e57eSGunnar Mills                    "longDescription": "This property shall contain a human-readable error message corresponding to the message in a message registry.",
37*f2a8e57eSGunnar Mills                    "readonly": true,
38*f2a8e57eSGunnar Mills                    "type": "string"
39*f2a8e57eSGunnar Mills                },
40*f2a8e57eSGunnar Mills                "@Message.ExtendedInfo": {
41*f2a8e57eSGunnar Mills                    "description": "An array of messages describing one or more error messages.",
42*f2a8e57eSGunnar Mills                    "longDescription": "This property shall be an array of message objects describing one or more error messages.",
43*f2a8e57eSGunnar Mills                    "type": "array",
44*f2a8e57eSGunnar Mills                    "items": {
45*f2a8e57eSGunnar Mills                        "$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message"
46*f2a8e57eSGunnar Mills                    }
47*f2a8e57eSGunnar Mills                }
48*f2a8e57eSGunnar Mills            },
49*f2a8e57eSGunnar Mills            "required": [
50*f2a8e57eSGunnar Mills                "code",
51*f2a8e57eSGunnar Mills                "message"
52*f2a8e57eSGunnar Mills            ],
53*f2a8e57eSGunnar Mills            "type": "object"
54*f2a8e57eSGunnar Mills        }
55*f2a8e57eSGunnar Mills    },
56*f2a8e57eSGunnar Mills    "language": "en",
57*f2a8e57eSGunnar Mills    "owningEntity": "DMTF",
58*f2a8e57eSGunnar Mills    "title": "redfish-error.v1_0_2"
59*f2a8e57eSGunnar Mills}
60