summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/LogService/LogService.json
diff options
context:
space:
mode:
Diffstat (limited to 'static/redfish/v1/JsonSchemas/LogService/LogService.json')
-rw-r--r--static/redfish/v1/JsonSchemas/LogService/LogService.json93
1 files changed, 48 insertions, 45 deletions
diff --git a/static/redfish/v1/JsonSchemas/LogService/LogService.json b/static/redfish/v1/JsonSchemas/LogService/LogService.json
index 9699883c87..c933052b4c 100644
--- a/static/redfish/v1/JsonSchemas/LogService/LogService.json
+++ b/static/redfish/v1/JsonSchemas/LogService/LogService.json
@@ -1,14 +1,15 @@
{
+ "$id": "http://redfish.dmtf.org/schemas/v1/LogService.v1_1_3.json",
"$ref": "#/definitions/LogService",
"$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,19 +28,19 @@
},
"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"
},
"ClearLog": {
"additionalProperties": false,
- "description": "This action is used to clear the log for this Log Service.",
+ "description": "The action to clear the log for this Log Service.",
"longDescription": "This action shall delete all entries found in the Entries collection for this Log Service.",
"parameters": {},
"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",
@@ -55,7 +56,7 @@
"properties": {
"target": {
"description": "Link to invoke action",
- "format": "uri",
+ "format": "uri-reference",
"type": "string"
},
"title": {
@@ -73,8 +74,8 @@
"OEM"
],
"enumDescriptions": {
- "Event": "The log contains Redfish-defined messages (events).",
- "Multiple": "The log contains multiple Log Entry types or a single entry type cannot be guaranteed by the Log Service.",
+ "Event": "The log contains Redfish-defined messages.",
+ "Multiple": "The log contains multiple log entry types and, therefore, the Log Service cannot guarantee a single entry type.",
"OEM": "The log contains entries in an OEM-defined format.",
"SEL": "The log contains legacy IPMI System Event Log (SEL) entries."
},
@@ -82,10 +83,10 @@
},
"LogService": {
"additionalProperties": false,
- "description": "This resource represents the log service for the resource or service to which it is associated.",
- "longDescription": "This resource shall be used to represent a log service for a Redfish implementation.",
+ "description": "The LogService schema contains properties for monitoring and configuring a Log Service.",
+ "longDescription": "This Resource shall represent a Log 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",
@@ -100,26 +101,26 @@
},
"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."
},
"DateTime": {
- "description": "The current DateTime (with offset) for the log service, used to set or read time.",
+ "description": "The current date and time, with UTC offset, that the Log Service uses to set or read time.",
"format": "date-time",
- "longDescription": "The value of this property shall represent the current DateTime value that the log service is using, with offset from UTC, in Redfish Timestamp format.",
+ "longDescription": "This property shall represent the current DateTime value, with UTC offset, in Redfish Timestamp format that the Log Service uses to set or read time.",
"readonly": false,
"type": [
"string",
@@ -127,9 +128,9 @@
]
},
"DateTimeLocalOffset": {
- "description": "The time offset from UTC that the DateTime property is set to in format: +06:00 .",
- "longDescription": "The value is property shall represent the offset from UTC time that the current value of DataTime property contains.",
- "pattern": "([-+][0-1][0-9]:[0-5][0-9])",
+ "description": "The UTC offset that the current DateTime property value contains in the `+HH:MM` format.",
+ "longDescription": "This property shall represent the UTC offset that the current DateTime property value contains.",
+ "pattern": "^([-+][0-1][0-9]:[0-5][0-9])$",
"readonly": false,
"type": [
"string",
@@ -149,8 +150,8 @@
},
"Entries": {
"$ref": "http://redfish.dmtf.org/schemas/v1/LogEntryCollection.json#/definitions/LogEntryCollection",
- "description": "References to the log entry collection.",
- "longDescription": "The value of this property shall reference a collection of resources of type LogEntry.",
+ "description": "The link to the log entry collection.",
+ "longDescription": "This property shall contain a link to a Resource Collection of type LogEntryCollection.",
"readonly": true
},
"Id": {
@@ -166,13 +167,14 @@
"type": "null"
}
],
- "description": "The format of the Entries of this log.",
- "longDescription": "The value of this property shall represent the EntryType of all LogEntry resources contained in the Entries collection. If a single EntryType for all LogEntry resources cannot be determined or guaranteed by the Service, the value of this property shall be 'Multiple'.",
- "readonly": true
+ "description": "The format of the log entries.",
+ "longDescription": "This property shall represent the EntryType of all LogEntry Resources contained in the Entries collection. If the service cannot determine or guarantee a single EntryType for all LogEntry Resources, this property's value shall be `Multiple`.",
+ "readonly": true,
+ "versionAdded": "v1_1_0"
},
"MaxNumberOfRecords": {
- "description": "The maximum number of log entries this service can have.",
- "longDescription": "The value of this property shall be the maximum numbers of LogEntry resources in the Entries collection for this service.",
+ "description": "The maximum number of log entries that this service can have.",
+ "longDescription": "This property shall contain the maximum number of LogEntry Resources in the Entries collection for this service.",
"minimum": 0,
"readonly": true,
"type": "integer"
@@ -183,18 +185,18 @@
},
"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."
},
"OverWritePolicy": {
"$ref": "#/definitions/OverWritePolicy",
"description": "The overwrite policy for this service that takes place when the log is full.",
- "longDescription": "The value of this property shall indicate the policy of the log service when the MaxNumberOfRecords has been reached. Unknown indicates the log overwrite policy is unknown. WrapsWhenFull indicates that the log overwrites its entries with new entries when the log has reached its maximum capacity. NeverOverwrites indicates that the log never overwrites its entries by the new entries and ceases logging when the limit has been reached.",
+ "longDescription": "This property shall indicate the policy of the Log Service when the MaxNumberOfRecords has been reached.",
"readonly": true
},
"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",
@@ -203,8 +205,8 @@
},
"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."
}
},
"required": [
@@ -217,10 +219,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",
@@ -243,13 +245,14 @@
"NeverOverWrites"
],
"enumDescriptions": {
- "NeverOverWrites": "When full, new entries to the Log will be discarded.",
+ "NeverOverWrites": "When full, new entries to the log are discarded.",
"Unknown": "The overwrite policy is not known or is undefined.",
- "WrapsWhenFull": "When full, new entries to the Log will overwrite previous entries."
+ "WrapsWhenFull": "When full, new entries to the log overwrite earlier entries."
},
"type": "string"
}
},
"owningEntity": "DMTF",
- "title": "#LogService.v1_1_1.LogService"
+ "release": "2017.3",
+ "title": "#LogService.v1_1_3.LogService"
} \ No newline at end of file