blob: 38ba465018a6ab872a1b7ec252f226cd8996c1ee [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
2 "$ref": "#/definitions/CompositionService",
Ed Tanous530520e2019-01-02 13:41:37 -08003 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
4 "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07005 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -080011 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070012 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080016 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070017 "number",
18 "null",
19 "object",
20 "string"
21 ]
22 }
23 },
24 "properties": {
25 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -080026 "$ref": "#/definitions/OemActions",
27 "description": "This property contains the available OEM specific actions for this resource.",
28 "longDescription": "This property shall contain any additional OEM actions for this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -070029 }
30 },
31 "type": "object"
32 },
33 "CompositionService": {
34 "additionalProperties": false,
35 "description": "The CompositionService schema defines a Composition Service which represents the properties for the service and links to the resources available for composition.",
36 "longDescription": "This resource shall be used to represent the Composition Service Properties for a Redfish implementation.",
37 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -080038 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070039 "description": "This property shall specify a valid odata or Redfish property.",
40 "type": [
41 "array",
42 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080043 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070044 "number",
45 "null",
46 "object",
47 "string"
48 ]
49 }
50 },
51 "properties": {
52 "@odata.context": {
Ed Tanous530520e2019-01-02 13:41:37 -080053 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
54 },
55 "@odata.etag": {
56 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -070057 },
58 "@odata.id": {
Ed Tanous530520e2019-01-02 13:41:37 -080059 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -070060 },
61 "@odata.type": {
Ed Tanous530520e2019-01-02 13:41:37 -080062 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -070063 },
64 "Actions": {
65 "$ref": "#/definitions/Actions",
66 "description": "The available actions for this resource.",
67 "longDescription": "The Actions property shall contain the available actions for this resource."
68 },
Ed Tanous530520e2019-01-02 13:41:37 -080069 "AllowOverprovisioning": {
70 "description": "This indicates whether this service is allowed to overprovision a composition relative to the composition request.",
71 "longDescription": "The value of this property shall be a boolean indicating whether this service is allowed to overprovision a composition relative to the composition request.",
72 "readonly": false,
73 "type": [
74 "boolean",
75 "null"
76 ]
77 },
78 "AllowZoneAffinity": {
79 "description": "This indicates whether a client is allowed to request that given composition request is fulfilled by a specified Resource Zone.",
80 "longDescription": "The value of this property shall be a boolean indicating whether a client is allowed to request that given composition request is fulfilled by a specified Resource Zone.",
81 "readonly": true,
82 "type": [
83 "boolean",
84 "null"
85 ]
86 },
Ed Tanous118b1c72018-09-13 13:45:51 -070087 "Description": {
88 "anyOf": [
89 {
90 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
91 },
92 {
93 "type": "null"
94 }
95 ],
96 "readonly": true
97 },
98 "Id": {
99 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
100 "readonly": true
101 },
102 "Name": {
103 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
104 "readonly": true
105 },
106 "Oem": {
107 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
108 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
109 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
110 },
111 "ResourceBlocks": {
112 "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlockCollection.json#/definitions/ResourceBlockCollection",
113 "description": "The resource blocks available on the service.",
114 "longDescription": "This property shall contain the link to a collection of type ResourceBlockCollection.",
115 "readonly": true
116 },
117 "ResourceZones": {
118 "$ref": "http://redfish.dmtf.org/schemas/v1/ZoneCollection.json#/definitions/ZoneCollection",
119 "description": "The resource zones available on the service.",
120 "longDescription": "This property shall contain the link to a collection of type ZoneCollection.",
121 "readonly": true
122 },
123 "ServiceEnabled": {
124 "description": "This indicates whether this service is enabled.",
125 "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.",
126 "readonly": false,
127 "type": [
128 "boolean",
129 "null"
130 ]
131 },
132 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800133 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
134 "description": "This property describes the status and health of the resource and its children.",
135 "longDescription": "This property shall contain any status or health properties of the resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700136 }
137 },
138 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800139 "@odata.id",
140 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700141 "Id",
142 "Name"
143 ],
144 "type": "object"
145 },
146 "OemActions": {
147 "additionalProperties": true,
148 "description": "The available OEM specific actions for this resource.",
149 "longDescription": "This type shall contain any additional OEM actions for this resource.",
150 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800151 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700152 "description": "This property shall specify a valid odata or Redfish property.",
153 "type": [
154 "array",
155 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800156 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700157 "number",
158 "null",
159 "object",
160 "string"
161 ]
162 }
163 },
164 "properties": {},
165 "type": "object"
166 }
167 },
Ed Tanous530520e2019-01-02 13:41:37 -0800168 "owningEntity": "DMTF",
169 "title": "#CompositionService.v1_1_0.CompositionService"
Ed Tanous118b1c72018-09-13 13:45:51 -0700170}