diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/EventService/EventService.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/EventService/EventService.json | 233 |
1 files changed, 130 insertions, 103 deletions
diff --git a/static/redfish/v1/JsonSchemas/EventService/EventService.json b/static/redfish/v1/JsonSchemas/EventService/EventService.json index 8d9923d041..f616f392bb 100644 --- a/static/redfish/v1/JsonSchemas/EventService/EventService.json +++ b/static/redfish/v1/JsonSchemas/EventService/EventService.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/EventService.v1_4_0.json", "$ref": "#/definitions/EventService", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", - "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "copyright": "Copyright 2014-2019 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.", + "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)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -27,8 +28,8 @@ }, "Oem": { "$ref": "#/definitions/OemActions", - "description": "This property contains the available OEM specific actions for this resource.", - "longDescription": "This property shall contain any additional OEM actions for this resource." + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This property shall contain the available OEM-specific actions for this Resource." } }, "type": "object" @@ -39,17 +40,17 @@ "MetricReport" ], "enumDescriptions": { - "Event": "The subscription destination will receive JSON Bodies of the Resource Type Event.", - "MetricReport": "The subscription destination will receive JSON Bodies of the Resource Type MetricReport." + "Event": "The subscription destination receives JSON bodies of the Event type.", + "MetricReport": "The subscription destination receives JSON bodies of the MetricReport type." }, "type": "string" }, "EventService": { "additionalProperties": false, - "description": "The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions (called Event Destinations).", - "longDescription": "This resource shall be used to represent an event service for a Redfish implementation.", + "description": "The EventService schema contains properties for managing event subcriptions and generates the events sent to subscribers. The Resource has links to the actual collection of subscriptions, which are called event destinations.", + "longDescription": "This Resource shall represent an Event Service for a Redfish implementation.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -64,31 +65,31 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.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." + "description": "The available actions for this Resource.", + "longDescription": "This property shall contain the available actions for this Resource." }, "DeliveryRetryAttempts": { - "description": "This is the number of attempts an event posting is retried before the subscription is terminated. This retry is at the service level, meaning the HTTP POST to the Event Destination was returned by the HTTP operation as unsuccessful (4xx or 5xx return code) or an HTTP timeout occurred this many times before the Event Destination subscription is terminated.", - "longDescription": "The value of this property shall be the number of retrys attempted for any given event to the subscription destination before the subscription is terminated. This retry is at the service level, meaning the HTTP POST to the Event Destination was returned by the HTTP operation as unsuccessful (4xx or 5xx return code) or an HTTP timeout occurred this many times before the Event Destination subscription is terminated.", + "description": "The number of times that the POST of an event is retried before the subscription terminates. This retry occurs at the service level, which means that the HTTP POST to the event destination fails with an HTTP `4XX` or `5XX` status code or an HTTP timeout occurs this many times before the event destination subscription terminates.", + "longDescription": "This property shall contain the number of times that the POST of an event is retried before the subscription terminates. This retry occurs at the service level, which means that the HTTP POST to the event destination fails with an HTTP `4XX` or `5XX` status code or an HTTP timeout occurs this many times before the event destination subscription terminates.", "readonly": false, "type": "integer" }, "DeliveryRetryIntervalSeconds": { - "description": "This represents the number of seconds between retry attempts for sending any given Event.", - "longDescription": "The value of this property shall be the interval in seconds between the retry attempts for any given event to the subscription destination.", + "description": "The interval, in seconds, between retry attempts for sending any event.", + "longDescription": "This property shall contain the interval, in seconds, between the retry attempts for any event sent to the subscription destination.", "readonly": false, "type": "integer", "units": "s" @@ -105,7 +106,7 @@ "readonly": true }, "EventFormatTypes": { - "description": "Indicates the content types of the message that this service can send to the event destination.", + "description": "The content types of the message that this service can send to the event destination.", "items": { "anyOf": [ { @@ -116,18 +117,21 @@ } ] }, - "longDescription": "The value of this property shall indicate the the content types of the message that this service can send to the event destination. If this property is not present, the EventFormatType shall be assumed to be Event.", + "longDescription": "This property shall contain the content types of the message that this service can send to the event destination. If this property is not present, the EventFormatType shall be assumed to be `Event`.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" }, "EventTypesForSubscription": { - "description": "This is the types of Events that can be subscribed to.", + "deprecated": "This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.", + "description": "The types of events to which a client can subscribe.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType" }, - "longDescription": "The value of this property shall be the types of events that subscriptions can subscribe to. The semantics associated with the enumerations values are defined in the Redfish specification.", + "longDescription": "This property shall contain the types of events to which a client can subscribe. The semantics associated with the enumeration values are defined in the Redfish Specification.", "readonly": true, - "type": "array" + "type": "array", + "versionDeprecated": "v1_3_0" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -139,48 +143,52 @@ }, "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*." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." }, "RegistryPrefixes": { - "description": "A list of the Prefixes of the Message Registries that can be used for the RegistryPrefix property on a subscription.", + "description": "The list of the prefixes of the Message Registries that can be used for the RegistryPrefix property on a subscription. If this property is absent or contains an empty array, the service does not support RegistryPrefix-based subscriptions.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property is the array of the Prefixes of the Message Registries that shall be allowed for an Event Subscription.", + "longDescription": "This property shall contain the array of the prefixes of the Message Registries that shall be allowed for an event subscription.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" }, "ResourceTypes": { - "description": "A list of @odata.type values (Schema names) that can be specified in a ResourceType on a subscription.", + "description": "The list of @odata.type values, or Schema names, that can be specified in the ResourceTypes array in a subscription. If this property is absent or contains an empty array, the service does not support Resource type-based subscriptions.", "items": { "type": [ "string", "null" ] }, - "longDescription": "The value of this property shall specify an array of the valid @odata.type values that can be used for an Event Subscription.", + "longDescription": "This property shall specify an array of the valid @odata.type values that can be used for an event subscription.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_2_0" }, "SSEFilterPropertiesSupported": { "$ref": "#/definitions/SSEFilterPropertiesSupported", - "description": "Contains a set of properties that indicate which properties are supported in the $filter query parameter for the ServerSentEventUri.", - "longDescription": "The value of this property shall contain a set of properties that indicate which properties are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property." + "description": "The set of properties that are supported in the $filter query parameter for the ServerSentEventUri.", + "longDescription": "This property shall contain the properties that are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property.", + "versionAdded": "v1_2_0" }, "ServerSentEventUri": { - "description": "Link to a URI for receiving Sever Sent Event representations of the events generated by this service.", - "format": "uri", - "longDescription": "The value of this property shall be a URI that specifies an HTML5 Server-Sent Event conformant endpoint.", + "description": "The link to a URI for receiving Server-Sent Event representations for the events that this service generates.", + "format": "uri-reference", + "longDescription": "This property shall contain a URI that specifies an HTML5 Server-Sent Event-conformant endpoint.", "readonly": true, - "type": "string" + "type": "string", + "versionAdded": "v1_1_0" }, "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.", + "description": "An indication of whether this service is enabled.", + "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", @@ -189,22 +197,23 @@ }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "description": "The status and health of the Resource and its subordinate or dependent Resources.", + "longDescription": "This property shall contain any status or health properties of the Resource." }, "SubordinateResourcesSupported": { - "description": "This indicates if the service supports the SubordinateResource property on Event Subscriptions.", - "longDescription": "When set to true, the service is indicating that it supports the SubordinateResource property on Event Subscriptions and on generated Events.", + "description": "An indication of whether the service supports the SubordinateResource property on both event subscriptions and generated events.", + "longDescription": "This property shall indicate whether the service supports the SubordinateResource property on both event subscriptions and generated events.", "readonly": true, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_2_0" }, "Subscriptions": { "$ref": "http://redfish.dmtf.org/schemas/v1/EventDestinationCollection.json#/definitions/EventDestinationCollection", - "description": "This is a reference to a collection of Event Destination resources.", - "longDescription": "The value of this property shall contain the link to a collection of type EventDestinationCollection.", + "description": "The link to a collection of event destination Resources.", + "longDescription": "This property shall contain the link to a Resource Collection of type EventDestinationCollection.", "readonly": true } }, @@ -218,10 +227,10 @@ }, "OemActions": { "additionalProperties": true, - "description": "The available OEM specific actions for this resource.", - "longDescription": "This type shall contain any additional OEM actions for this resource.", + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This type shall contain the available OEM-specific actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -239,10 +248,10 @@ }, "SSEFilterPropertiesSupported": { "additionalProperties": false, - "description": "Contains a set of properties that indicate which properties are supported in the $filter query parameter for the ServerSentEventUri.", - "longDescription": "The type shall contain a set of properties that indicate which properties are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property.", + "description": "The set of properties that are supported in the $filter query parameter for the ServerSentEventUri.", + "longDescription": "The type shall contain a set of properties that are supported in the $filter query parameter for the URI indicated by the ServerSentEventUri property.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -257,111 +266,128 @@ }, "properties": { "EventFormatType": { - "description": "This indicates if the EventFormatType property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the EventFormatType property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the EventFormatType property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the EventFormatType property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "EventType": { - "description": "This indicates if the EventType property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the EventType property in the $filter query parameter as described by the specification.", + "deprecated": "This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.", + "description": "An indication of whether the service supports the EventType property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the EventType property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0", + "versionDeprecated": "v1_3_0" }, "MessageId": { - "description": "This indicates if the MessageId property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the MessageId property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the MessageId property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the MessageId property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "MetricReportDefinition": { - "description": "This indicates if the MetricReportDefinition property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the MetricReportDefinition property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the MetricReportDefinition property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the MetricReportDefinition property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "OriginResource": { - "description": "This indicates if the OriginResource property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the OriginResource property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the OriginResource property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the OriginResource property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "RegistryPrefix": { - "description": "This indicates if the RegistryPrefix property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the RegistryPrefix property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the RegistryPrefix property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the RegistryPrefix property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_2_0" }, "ResourceType": { - "description": "This indicates if the ResourceType property is supported.", - "longDescription": "The value of this property shall be a boolean indicating if this service supports the use of the ResourceType property in the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the ResourceType property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the ResourceType property in the $filter query parameter, as described by the Redfish Specification.", + "readonly": true, + "type": "boolean", + "versionAdded": "v1_2_0" + }, + "SubordinateResources": { + "description": "An indication of whether the service supports the SubordinateResources property in the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the SubordinateResources property in the $filter query parameter, as described by the Redfish Specification.", "readonly": true, - "type": "boolean" + "type": "boolean", + "versionAdded": "v1_4_0" } }, "type": "object" }, "SubmitTestEvent": { "additionalProperties": false, - "description": "This action is used to generate a test event.", - "longDescription": "This action shall add a test event to the event service with the event data specified in the action parameters. This message should then be sent to any appropriate ListenerDestination targets.", + "description": "This action generates a test event.", + "longDescription": "This action shall add a test event to the Event Service with the event data specified in the action parameters. Then, this message should be sent to any appropriate event destinations.", "parameters": { + "EventGroupId": { + "description": "The group ID for the event.", + "longDescription": "The parameter shall contain the group ID for the event. It has the same semantics as the EventGroupId property in the Event schema for Redfish.", + "type": "integer", + "versionAdded": "v1_3_0" + }, "EventId": { - "description": "This is the ID of event to be added.", - "longDescription": "This parameter shall have the same semantics as the EventId property in the Event schema for Redfish.", - "requiredParameter": true, + "description": "The ID for the event to add.", + "longDescription": "This parameter shall have the same semantics as the EventId property in the Event schema for Redfish. A service may ignore this value and replace it with its own.", "type": "string" }, "EventTimestamp": { - "description": "This is the time stamp of event to be added.", + "description": "The date and time stamp for the event to add.", "format": "date-time", - "longDescription": "This parameter shall have the same semantics as the EventTimestamp property in the Event schema for Redfish.", - "requiredParameter": true, + "longDescription": "This parameter shall contain the date and time stamp for the event to add and have the same semantics as the EventTimestamp property in the Event schema for Redfish.", "type": "string" }, "EventType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType", - "description": "This is the type of event to be added.", - "longDescription": "This parameter shall define the property name for which the following allowable values apply.", - "requiredParameter": true + "deprecated": "This parameter has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.", + "description": "The type for the event to add.", + "longDescription": "This parameter shall contain the property name for which the following allowable values apply.", + "versionDeprecated": "v1_3_0" }, "Message": { - "description": "This is the human readable message of event to be added.", + "description": "The human-readable message for the event to add.", "longDescription": "This parameter shall have the same semantics as the Message property in the Event schema for Redfish.", - "requiredParameter": true, "type": "string" }, "MessageArgs": { - "description": "This is the array of message arguments of the event to be added.", + "description": "An array of message arguments for the event to add.", "items": { "type": "string" }, "longDescription": "This parameter shall have the same semantics as the MessageArgs property in the Event schema for Redfish.", - "requiredParameter": true, "type": "array" }, "MessageId": { - "description": "This is the message ID of event to be added.", - "longDescription": "This parameter shall have the same semantics as the MessageId property in the Event schema for Redfish.", + "description": "The MessageId for the event to add.", + "longDescription": "This parameter shall contain the MessageId for the event to add and have the same semantics as the MessageId property in the Event schema for Redfish.", "requiredParameter": true, "type": "string" }, "OriginOfCondition": { - "description": "This is the string of the URL within the OriginOfCondition property of the event to be added. It is not a reference object.", - "format": "uri", + "description": "The URL in the OriginOfCondition property of the event to add. It is not a reference object.", + "format": "uri-reference", "longDescription": "This parameter shall be a string that represents the URL contained by the OriginOfCondition property in the Event schema for Redfish.", - "requiredParameter": true, "type": "string" }, "Severity": { - "description": "This is the Severity of event to be added.", - "longDescription": "This parameter shall have the same semantics as the Severity property in the Event schema for Redfish.", - "requiredParameter": true, + "description": "The severity for the event to add.", + "longDescription": "This parameter shall contain the severity for the event to add and have the same semantics as the Severity property in the Event schema for Redfish.", "type": "string" } }, "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -377,7 +403,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -389,5 +415,6 @@ } }, "owningEntity": "DMTF", - "title": "#EventService.v1_2_0.EventService" + "release": "2019.2", + "title": "#EventService.v1_4_0.EventService" }
\ No newline at end of file |