summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/redfish-schema/redfish-schema.json
blob: 7308bf7b2ea76f1c6fea5926bbb26c03930f44d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
{
    "id": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_4_0",
    "type": "object",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_4_0",
    "title": "Redfish Schema Extension",
    "description": "The properties defined in this schema shall adhere to the requirements of the Redfish Specification and the semantics of the descriptions in this file.",
    "allOf": [
        {
            "$ref": "http://json-schema.org/draft-04/schema"
        }
    ],
    "definitions": {
        "readonly": {
            "type": "boolean",
            "description": "This property shall designate a property to be readonly when set to true."
        },
        "requiredOnCreate": {
            "type": "array",
            "items": {
                "type": "boolean"
            },
            "description": "This property is required to be specified in the body of a POST request to create the resource."
        },
        "requiredParameter": {
            "type": "boolean",
            "description": "This property specifies that an action parameter is required to be provided by the client as part of the action request when set to true.  Parameters not containing this property with the value of true can be left out of the client's action request."
        },
        "longDescription": {
            "type": "string",
            "description": "This attribute shall contain normative language relating to the Redfish Specification and documentation."
        },
        "copyright": {
            "type": "string",
            "description": "This attribute shall contain the copyright notice for the schema."
        },
        "deprecated": {
            "type": "string",
            "description": "The term shall be applied to a property in order to specify that the property is deprecated.  The value of the string should explain the deprecation, including new property or properties to be used. The property can be supported in new and existing implementations, but usage in new implementations is discouraged.  Deprecated properties are likely to be removed in a future major version of the schema."
        },
        "enumDescriptions": {
            "type": "object",
            "description": "This attribute shall contain informative language related to the enumeration values of the property."
        },
        "enumLongDescriptions": {
            "type": "object",
            "description": "This attribute shall contain normative language relating to the enumeration values of the property."
        },
        "enumDeprecated": {
            "type": "object",
            "description": "The term shall be applied to a value in order to specify that the value is deprecated.  The value of the string should explain the deprecation, including new value to be used.  The value can be supported in new and existing implementations, but usage in new implementations is discouraged.  Deprecated values are likely to be removed in a future major version of the schema."
        },
        "units": {
            "type": "string",
            "description": "This attribute shall contain the units of measure used by the value of the property."
        },
        "owningEntity": {
            "type": "string",
            "description": "Indicates the name of the entity responsible for development, publication and maintenance of a given schema.  Possible values include DMTF, SNIA or an OEM label such as is used in a Redfish OEM extension section."
        }
    },
    "properties": {
        "readonly": {
            "$ref": "#/definitions/readonly"
        },
        "requiredOnCreate": {
            "$ref": "#/definitions/requiredOnCreate"
        },
        "requiredParameter": {
            "$ref": "#/definitions/requiredParameter"
        },
        "longDescription": {
            "$ref": "#/definitions/longDescription"
        },
        "copyright": {
            "$ref": "#/definitions/copyright"
        },
        "deprecated": {
            "$ref": "#/definitions/deprecated"
        },
        "enumDescriptions": {
            "$ref": "#/definitions/enumDescriptions"
        },
        "enumLongDescriptions": {
            "$ref": "#/definitions/enumLongDescriptions"
        },
        "enumDeprecated": {
            "$ref": "#/definitions/enumDeprecated"
        },
        "units": {
            "$ref": "#/definitions/units"
        },
        "parameters": {
            "type": "object",
            "description": "This term shall contain parameter definitions for a given action.",
            "additionalProperties": { "$ref": "#" }
        },
        "owningEntity": {
            "$ref": "#/definitions/owningEntity"
        }
    }
}