diff options
author | Ed Tanous <ed.tanous@intel.com> | 2018-07-26 22:47:19 +0300 |
---|---|---|
committer | Ed Tanous <ed.tanous@intel.com> | 2018-09-17 19:25:06 +0300 |
commit | 683f7276576dbf0bf7770570190f6b5b4e84d4c9 (patch) | |
tree | 5ce732faa82e8360367006c510e9797bb7ee51d1 /static/redfish/v1/JsonSchemas/Message/index.json | |
parent | cc340dd933d38095214a0eeb7c1ee77510bd30cd (diff) | |
download | bmcweb-683f7276576dbf0bf7770570190f6b5b4e84d4c9.tar.xz |
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/Message/index.json')
-rw-r--r-- | static/redfish/v1/JsonSchemas/Message/index.json | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/static/redfish/v1/JsonSchemas/Message/index.json b/static/redfish/v1/JsonSchemas/Message/index.json new file mode 100644 index 0000000000..deeba60d8c --- /dev/null +++ b/static/redfish/v1/JsonSchemas/Message/index.json @@ -0,0 +1,87 @@ +{ + "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_2_0.json", + "title": "#Message.v1_0_5", + "definitions": { + "Message": { + "type": "object", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ], + "description": "This property shall specify a valid odata or Redfish property." + } + }, + "additionalProperties": false, + "properties": { + "MessageId": { + "type": "string", + "readonly": true, + "description": "This is the key for this message which can be used to look up the message in a message registry.", + "longDescription": "This property shall be a key into message registry as described in the Redfish specification." + }, + "Message": { + "type": [ + "string", + "null" + ], + "readonly": true, + "description": "This is the human readable message, if provided.", + "longDescription": "This property shall contain an optional human readable message." + }, + "RelatedProperties": { + "type": "array", + "items": { + "type": "string" + }, + "readonly": true, + "description": "This is an array of properties described by the message.", + "longDescription": "This property shall contain an array of JSON Pointers indicating the properties described by the message, if appropriate for the message." + }, + "MessageArgs": { + "type": "array", + "items": { + "type": "string" + }, + "readonly": true, + "description": "This array of message arguments are substituted for the arguments in the message when looked up in the message registry.", + "longDescription": "This property shall contain the message substitution arguments for the specific message referenced by the MessageId and shall only be included if the MessageId is present." + }, + "Severity": { + "type": [ + "string", + "null" + ], + "readonly": true, + "description": "This is the severity of the errors.", + "longDescription": "The value of this property shall be the severity of the error, as defined in the Status section of the Redfish specificaiton." + }, + "Resolution": { + "type": [ + "string", + "null" + ], + "readonly": true, + "description": "Used to provide suggestions on how to resolve the situation that caused the error.", + "longDescription": "This property shall contain an override of the Resolution of the message in message registry, if present." + }, + "Oem": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", + "description": "Oem extension object.", + "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification." + } + }, + "required": [ + "MessageId" + ], + "description": "This type describes a Message returned by the Redfish service.", + "longDescription": "This type shall define a Message as described in the Redfish specification." + } + }, + "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright" +} |