diff options
| author | Ed Tanous <ed.tanous@intel.com> | 2018-07-26 12:47:19 -0700 |
|---|---|---|
| committer | Ed Tanous <ed.tanous@intel.com> | 2018-09-17 16:25:06 +0000 |
| commit | 683f7276576dbf0bf7770570190f6b5b4e84d4c9 (patch) | |
| tree | 5ce732faa82e8360367006c510e9797bb7ee51d1 /static/redfish/v1/JsonSchemas/TaskService | |
| parent | cc340dd933d38095214a0eeb7c1ee77510bd30cd (diff) | |
| download | bmcweb-683f7276576dbf0bf7770570190f6b5b4e84d4c9.tar.gz bmcweb-683f7276576dbf0bf7770570190f6b5b4e84d4c9.zip | |
Implement JsonSchema endpoint
This patchset implements JsonSchema support, and automates our update
of the XML metadata, and Json schema files in the future by way of a
python script.
Change-Id: Iec6f580d10736678149db18d87be2f140b535be9
Signed-off-by: Ed Tanous <ed.tanous@intel.com>
Signed-off-by: James Feist <james.feist@linux.intel.com>
Diffstat (limited to 'static/redfish/v1/JsonSchemas/TaskService')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/TaskService/index.json | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/static/redfish/v1/JsonSchemas/TaskService/index.json b/static/redfish/v1/JsonSchemas/TaskService/index.json new file mode 100644 index 0000000..4dc1ea3 --- /dev/null +++ b/static/redfish/v1/JsonSchemas/TaskService/index.json @@ -0,0 +1,166 @@ +{ + "$ref": "#/definitions/TaskService", + "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json", + "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "definitions": { + "Actions": { + "additionalProperties": false, + "description": "The available actions for this resource.", + "longDescription": "This type shall contain the available actions for this resource.", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": { + "Oem": { + "$ref": "#/definitions/OemActions" + } + }, + "type": "object" + }, + "OemActions": { + "additionalProperties": true, + "description": "The available OEM specific actions for this resource.", + "longDescription": "This type shall contain any additional OEM actions for this resource.", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": {}, + "type": "object" + }, + "OverWritePolicy": { + "enum": [ + "Manual", + "Oldest" + ], + "enumDescriptions": { + "Manual": "Completed tasks are not automatically overwritten.", + "Oldest": "Oldest completed tasks are overwritten." + }, + "type": "string" + }, + "TaskService": { + "additionalProperties": false, + "description": "This is the schema definition for the Task Service. It represents the properties for the service itself and has links to the actual list of tasks.", + "longDescription": "This resource shall be used to represent a task service for a Redfish implementation.", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": { + "@odata.context": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context" + }, + "@odata.id": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id" + }, + "@odata.type": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type" + }, + "Actions": { + "$ref": "#/definitions/Actions", + "description": "The available actions for this resource.", + "longDescription": "The Actions property shall contain the available actions for this resource." + }, + "CompletedTaskOverWritePolicy": { + "$ref": "#/definitions/OverWritePolicy", + "description": "Overwrite policy of completed tasks.", + "longDescription": "The value of this property shall indicate how completed tasks are handled should the task service need to track more tasks.", + "readonly": true + }, + "DateTime": { + "description": "The current DateTime (with offset) setting that the task service is using.", + "format": "date-time", + "longDescription": "The value of this property shall represent the current DateTime value for the TaskService, with offset from UTC, in Redfish Timestamp format.", + "readonly": true, + "type": [ + "string", + "null" + ] + }, + "Description": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" + }, + { + "type": "null" + } + ], + "readonly": true + }, + "Id": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", + "readonly": true + }, + "LifeCycleEventOnTaskStateChange": { + "description": "Send an Event upon Task State Change.", + "longDescription": "The value of this property, if set to true, shall indicate that the service shall send a Life cycle event to Event Destinations Subscriptions registered for such events upon change of task state. Life cycle events are defined in the Eventing section of the Redfish Specification.", + "readonly": true, + "type": "boolean" + }, + "Name": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", + "readonly": true + }, + "Oem": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", + "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.", + "longDescription": "The value of this string shall be of the format for the reserved word *Oem*." + }, + "ServiceEnabled": { + "description": "This indicates whether this service is enabled.", + "longDescription": "The value of this property shall be a boolean indicating whether this service is enabled.", + "readonly": false, + "type": [ + "boolean", + "null" + ] + }, + "Status": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status" + }, + "Tasks": { + "$ref": "http://redfish.dmtf.org/schemas/v1/TaskCollection.json#/definitions/TaskCollection", + "description": "References to the Tasks collection.", + "longDescription": "The value of this property shall be a link to a resource of type TaskCollection.", + "readonly": true + } + }, + "required": [ + "Id", + "Name" + ], + "type": "object" + } + }, + "title": "#TaskService.v1_1_1.TaskService" +}
\ No newline at end of file |

