diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json | 114 |
1 files changed, 57 insertions, 57 deletions
diff --git a/static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json b/static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json index 1e4ae88e46..783e010b4d 100644 --- a/static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json +++ b/static/redfish/v1/JsonSchemas/TelemetryService/TelemetryService.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/TelemetryService.v1_1_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/TelemetryService.v1_1_2.json", "$ref": "#/definitions/TelemetryService", "$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", @@ -28,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" @@ -56,7 +56,7 @@ "description": "A metric value.", "longDescription": "A metric value in the context of a Metric.", "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", @@ -72,14 +72,14 @@ "properties": { "MetricDefinition": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinition.json#/definitions/MetricDefinition", - "description": "A link to the Metric Definition.", - "longDescription": "The value shall be reference to the Metric Definition resource that describes what this Metric Report is capturing.", + "description": "The link to the metric.", + "longDescription": "The link to the Metric Definition Resource that describes what this metric report captures.", "readonly": true, "versionAdded": "v1_1_0" }, "MetricId": { "description": "The metric definitions identifier for this metric.", - "longDescription": "The value shall be the same as the Id property of the source metric within the associated MetricDefinition.", + "longDescription": "This property shall contain the same as the Id property of the source metric within the associated MetricDefinition.", "readonly": true, "type": [ "string", @@ -89,8 +89,8 @@ }, "MetricProperty": { "description": "The URI for the property from which this metric is derived.", - "format": "uri", - "longDescription": "The value shall be URI to the a property following the JSON fragment notation, as defined by RFC6901, to identify an individual property in a Redfish resource.", + "format": "uri-reference", + "longDescription": "This property shall contain the URI to the property, which follows the RFC6901-defined JSON fragment notation, to identify an individual property in a Redfish Resource.", "readonly": true, "type": [ "string", @@ -99,8 +99,8 @@ "versionAdded": "v1_1_0" }, "MetricValue": { - "description": "The value identifies this resource.", - "longDescription": "The value of the metric represented as a string.", + "description": "The metric value, as a string.", + "longDescription": "This property shall contain the metric value, as a string.", "readonly": true, "type": [ "string", @@ -109,9 +109,9 @@ "versionAdded": "v1_1_0" }, "Timestamp": { - "description": "The time when the value of the metric is obtained. A management application may establish a time series of metric data by retrieving the instances of metric value and sorting them according to their Timestamp.", + "description": "The time when the metric value is obtained. A management application may establish a time series of metric data by retrieving the instances of metric value and sorting them according to their Timestamp.", "format": "date-time", - "longDescription": "The value shall time when the metric value was obtained. Note that this may be different from the time when this instance is created.", + "longDescription": "This property shall contain the time when the metric value was obtained. Note that this may be different from the time when this instance is created.", "readonly": true, "type": [ "string", @@ -124,10 +124,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", @@ -145,8 +145,8 @@ }, "SubmitTestMetricReport": { "additionalProperties": false, - "description": "This action is used to generate a metric report.", - "longDescription": "This action shall cause the event service to immediately generate the metric report, as an Alert Event. This message should then be sent to any appropriate ListenerDestination targets.", + "description": "This action generates a metric report.", + "longDescription": "This action shall cause the Event Service to immediately generate the metric report as an alert event. Then, this message should be sent to any appropriate event destinations.", "parameters": { "GeneratedMetricReportValues": { "description": "The content of the MetricReportValues in the generated metric report.", @@ -159,21 +159,21 @@ "versionAdded": "v1_1_0" }, "MetricReportName": { - "description": "The Name property of the metric report in generated metric report.", - "longDescription": "This parameter shall be the value of the Name property in the generated metric report.", + "description": "The name of the metric report in generated metric report.", + "longDescription": "This parameter shall contain the name of the generated metric report.", "requiredParameter": true, "type": "string" }, "MetricReportValues": { - "deprecated": "This property has been Deprecated in favor of using the property 'GeneratedMetricReportValues'.", - "description": "The content of MetricReportValues array in generated metric report.", + "deprecated": "This property has been deprecated in favor of using the property 'GeneratedMetricReportValues'.", + "description": "The contents of MetricReportValues array in the generated metric report.", "longDescription": "This parameter shall contain the contents of the MetricReportValues array property in the generated metric report.", "type": "string", "versionDeprecated": "v1_1_0" } }, "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", @@ -189,7 +189,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -201,10 +201,10 @@ }, "TelemetryService": { "additionalProperties": false, - "description": "This is the schema definition for the Metrics Service. It represents the properties for the service itself and has links to collections of metric definitions and metric report definitions.", - "longDescription": "This resource shall be used to represent an Metrics Service for a Redfish implementation. It represents the properties that affect the service itself.", + "description": "The TelemetryService schema describes a Telemetry Service. The Telemetry Service is used to for collecting and reporting metric data within the Redfish Service.", + "longDescription": "This Resource contains a Telemetry 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", @@ -219,21 +219,21 @@ }, "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." }, "Description": { "anyOf": [ @@ -252,13 +252,13 @@ }, "LogService": { "$ref": "http://redfish.dmtf.org/schemas/v1/LogService.json#/definitions/LogService", - "description": "This is a reference to a Log Service used by the Telemetry Service.", - "longDescription": "The value of this property shall contain a reference to a LogService for the use by this Telemetry Service.", + "description": "The link to a Log Service that the Telemetry Service uses. This service may be a dedicated Log Service or a pointer a Log Service under another entity, such as Manager.", + "longDescription": "This property shall contain a link to a Log Service that this Telemetry Service uses.", "readonly": true }, "MaxReports": { - "description": "The maximum number of metric reports supported by this service.", - "longDescription": "The value shall be the maximum number of metric reports supported by this service.", + "description": "The maximum number of metric reports that this service supports.", + "longDescription": "This property shall contain the maximum number of metric reports that this service supports.", "readonly": true, "type": [ "integer", @@ -267,25 +267,25 @@ }, "MetricDefinitions": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricDefinitionCollection.json#/definitions/MetricDefinitionCollection", - "description": "A link to the collection of Metric Definitions.", - "longDescription": "The entries of shall be resources of type MetricDefinitionCollection.", + "description": "The link to the collection of metric definitions.", + "longDescription": "This property shall contain a link to a Resource Collection of type MetricDefinitionCollection.", "readonly": true }, "MetricReportDefinitions": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportDefinitionCollection.json#/definitions/MetricReportDefinitionCollection", - "description": "A link to the collection of Metric Report Definitions.", - "longDescription": "The value shall be a link to a resource of type MetricReportDefinitionCollection.", + "description": "The link to the collection of metric report definitions.", + "longDescription": "This property shall contain a link to a Resource Collection of type MetricReportDefinitionCollection.", "readonly": true }, "MetricReports": { "$ref": "http://redfish.dmtf.org/schemas/v1/MetricReportCollection.json#/definitions/MetricReportCollection", - "description": "A link to the collection of Metric Reports.", - "longDescription": "The value shall be a link to a resource of type MetricReportCollection.", + "description": "The link to the collection of metric reports.", + "longDescription": "This property shall contain a link to a Resource Collection of type MetricReportCollection.", "readonly": true }, "MinCollectionInterval": { - "description": "The minimum time interval between collections supported by this service.", - "longDescription": "The value shall be the minimum time interval between collections supported by this service. The value shall conform to the Duration format.", + "description": "The minimum time interval between gathering metric data that this service allows.", + "longDescription": "This property shall contain the minimum time interval between gathering metric data that this service allows.", "pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?", "readonly": true, "type": [ @@ -299,13 +299,13 @@ }, "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." }, "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." }, "SupportedCollectionFunctions": { "description": "The functions that can be performed over each metric.", @@ -319,14 +319,14 @@ } ] }, - "longDescription": "The value shall define the function to apply over the collection duration.", + "longDescription": "This property shall contain the function to apply over the collection duration.", "readonly": false, "type": "array" }, "Triggers": { "$ref": "http://redfish.dmtf.org/schemas/v1/TriggersCollection.json#/definitions/TriggersCollection", - "description": "A link to the collection of Triggers, which apply to metrics.", - "longDescription": "The value shall be a link to a resource of type TriggersCollection.", + "description": "The link to the collection of triggers, which apply to metrics.", + "longDescription": "This property shall contain a link to a Resource Collection of type TriggersCollection.", "readonly": true } }, @@ -341,5 +341,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#TelemetryService.v1_1_0.TelemetryService" + "title": "#TelemetryService.v1_1_2.TelemetryService" }
\ No newline at end of file |