diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/Event/Event.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/Event/Event.json | 294 |
1 files changed, 294 insertions, 0 deletions
diff --git a/static/redfish/v1/JsonSchemas/Event/Event.json b/static/redfish/v1/JsonSchemas/Event/Event.json new file mode 100644 index 0000000000..344cfb0aa8 --- /dev/null +++ b/static/redfish/v1/JsonSchemas/Event/Event.json @@ -0,0 +1,294 @@ +{ + "$ref": "#/definitions/Event", + "$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" + }, + "Event": { + "additionalProperties": false, + "description": "The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. This resource contains data about event(s), including descriptions, severity and MessageId reference to a Message Registry that can be accessed for further information.", + "longDescription": "This resource shall be used to represent an event 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." + }, + "Context": { + "description": "A context can be supplied at subscription time. This property is the context value supplied by the subscriber.", + "longDescription": "This property shall contain a client supplied context for the Event Destination to which this event is being sent.", + "readonly": true, + "type": "string" + }, + "Description": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" + }, + { + "type": "null" + } + ], + "readonly": true + }, + "Events": { + "description": "Each event in this array has a set of properties that describe the event. Since this is an array, more than one event can be sent simultaneously.", + "items": { + "$ref": "#/definitions/EventRecord" + }, + "longDescription": "The value of this resource shall be an array of Event objects used to represent the occurrence of one or more events.", + "type": "array" + }, + "Events@odata.count": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count" + }, + "Id": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", + "readonly": true + }, + "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*." + } + }, + "required": [ + "Events", + "Id", + "Name" + ], + "type": "object" + }, + "EventRecord": { + "additionalProperties": false, + "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": { + "Actions": { + "$ref": "#/definitions/EventRecordActions", + "description": "The available actions for this resource.", + "longDescription": "The Actions property shall contain the available actions for this resource." + }, + "Context": { + "deprecated": "Events are triggered independently from subscriptions to those events. This property has been Deprecated in favor of Event.v1_0_2.Event.Context", + "description": "A context can be supplied at subscription time. This property is the context value supplied by the subscriber.", + "longDescription": "This property shall contain a client supplied context for the Event Destination to which this event is being sent.", + "readonly": true, + "type": "string" + }, + "EventId": { + "description": "This is a unique instance identifier of an event.", + "longDescription": "The value of this property shall indicate a unique identifier for the event, the format of which is implementation dependent.", + "readonly": true, + "type": "string" + }, + "EventTimestamp": { + "description": "This is time the event occurred.", + "format": "date-time", + "longDescription": "The value of this property shall indicate the time the event occurred where the value shall be consistent with the Redfish service time that is also used for the values of the Modified property.", + "readonly": true, + "type": "string" + }, + "EventType": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType", + "description": "This indicates the type of event sent, according to the definitions in the EventService.", + "longDescription": "The value of this property shall indicate the type of event as defined in the EventService schema.", + "readonly": true + }, + "MemberId": { + "description": "This is the identifier for the member within the collection.", + "longDescription": "The value of this string shall uniquely identify the member within the collection.", + "readonly": true, + "type": "string" + }, + "Message": { + "description": "This is the human readable message, if provided.", + "longDescription": "This property shall contain an optional human readable message.", + "readonly": true, + "type": "string" + }, + "MessageArgs": { + "description": "This array of message arguments are substituted for the arguments in the message when looked up in the message registry.", + "items": { + "type": "string" + }, + "longDescription": "This property has the same semantics as the MessageArgs property in the Event schema for Redfish.", + "readonly": true, + "type": "array" + }, + "MessageId": { + "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.", + "pattern": "^[A-Za-z0-9]+\\.\\d+\\.\\d+\\.[A-Za-z0-9.]+$", + "readonly": true, + "type": "string" + }, + "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*." + }, + "OriginOfCondition": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/idRef", + "description": "This indicates the resource that originated the condition that caused the event to be generated.", + "longDescription": "The value of this property shall contain a pointer consistent with JSON pointer syntax to the resource that caused the event to be generated.", + "readonly": true + }, + "Severity": { + "description": "This is the severity of the event.", + "longDescription": "The value of this property shall be the severity of the event, as defined in the Status section of the Redfish specification.", + "readonly": true, + "type": "string" + } + }, + "required": [ + "EventType", + "MessageId" + ], + "type": "object" + }, + "EventRecordActions": { + "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/EventRecordOemActions" + } + }, + "type": "object" + }, + "EventRecordOemActions": { + "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" + }, + "EventType": { + "deprecated": "This definition has been moved to the unversioned namespace so that external references can pick up changes over time.", + "enum": [ + "StatusChange", + "ResourceUpdated", + "ResourceAdded", + "ResourceRemoved", + "Alert" + ], + "enumDescriptions": { + "Alert": "A condition exists which requires attention.", + "ResourceAdded": "A resource has been added.", + "ResourceRemoved": "A resource has been removed.", + "ResourceUpdated": "The value of this resource has been updated.", + "StatusChange": "The status of this resource has changed." + }, + "type": "string" + }, + "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" + } + }, + "title": "#Event.v1_2_1.Event" +}
\ No newline at end of file |