xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/UpdateServiceCapabilities.v1_0_0.json (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/UpdateServiceCapabilities.v1_0_0.json",
3    "$ref": "#/definitions/UpdateServiceCapabilities",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
30                }
31            },
32            "type": "object"
33        },
34        "OemActions": {
35            "additionalProperties": true,
36            "description": "The available OEM-specific actions for this resource.",
37            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {},
53            "type": "object"
54        },
55        "UpdateServiceCapabilities": {
56            "additionalProperties": false,
57            "description": "The `UpdateServiceCapabilities` schema contains capabilities of the update service.",
58            "longDescription": "This resource shall represent the update service capabilities for a Redfish implementation.",
59            "patternProperties": {
60                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
61                    "description": "This property shall specify a valid odata or Redfish property.",
62                    "type": [
63                        "array",
64                        "boolean",
65                        "integer",
66                        "number",
67                        "null",
68                        "object",
69                        "string"
70                    ]
71                }
72            },
73            "properties": {
74                "@odata.context": {
75                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
76                },
77                "@odata.etag": {
78                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
79                },
80                "@odata.id": {
81                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
82                },
83                "@odata.type": {
84                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
85                },
86                "Actions": {
87                    "$ref": "#/definitions/Actions",
88                    "description": "The available actions for this resource.",
89                    "longDescription": "This property shall contain the available actions for this resource."
90                },
91                "AllowableStaging": {
92                    "description": "The allowable URIs that a client can specify in the `Targets` parameter for update requests when requesting to stage an image on target devices.",
93                    "items": {
94                        "type": "string"
95                    },
96                    "longDescription": "This property shall contain an array of the allowable URIs that a client can specify in the `Targets` parameter for `SimpleUpdate` or `MultipartHttpPushUri` update requests with `Stage` set to `true`.",
97                    "readonly": true,
98                    "type": "array"
99                },
100                "AllowableTargets": {
101                    "description": "The allowable URIs that a client can specify in the `Targets` parameter for update requests.",
102                    "items": {
103                        "type": "string"
104                    },
105                    "longDescription": "This property shall contain an array of the allowable URIs that a client can specify in the `Targets` parameter for `SimpleUpdate` or `MultipartHttpPushUri` update requests.",
106                    "readonly": true,
107                    "type": "array"
108                },
109                "Description": {
110                    "anyOf": [
111                        {
112                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
113                        },
114                        {
115                            "type": "null"
116                        }
117                    ],
118                    "readonly": true
119                },
120                "Id": {
121                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
122                    "readonly": true
123                },
124                "Name": {
125                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
126                    "readonly": true
127                },
128                "Oem": {
129                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
130                    "description": "The OEM extension property.",
131                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
132                }
133            },
134            "required": [
135                "@odata.id",
136                "@odata.type",
137                "Id",
138                "Name"
139            ],
140            "type": "object"
141        }
142    },
143    "language": "en",
144    "owningEntity": "DMTF",
145    "release": "2025.2",
146    "title": "#UpdateServiceCapabilities.v1_0_0.UpdateServiceCapabilities"
147}