diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json | 186 |
1 files changed, 93 insertions, 93 deletions
diff --git a/static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json b/static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json index b76c7a134e..a49ab4328c 100644 --- a/static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json +++ b/static/redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ServiceRoot.v1_5_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ServiceRoot.v1_5_2.json", "$ref": "#/definitions/ServiceRoot", "$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": { "Expand": { "additionalProperties": false, - "description": "Contains information about the use of $expand in the service.", - "longDescription": "This type, as described by the Redfish Specification, shall contain information about the support of the $expand query parameter by the service.", + "description": "The information about the use of $expand in the service.", + "longDescription": "This type shall contain information about the support of the $expand query parameter by the service.", "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", @@ -24,29 +24,29 @@ }, "properties": { "ExpandAll": { - "description": "This indicates whether the $expand support of asterisk (expand all entries) is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of asterisk (expand all entries) as a value for the $expand query parameter as described by the specification.", + "description": "An indication of whether the service supports the asterisk (`*`) option of the $expand query parameter.", + "longDescription": "This property shall indicate whether this service supports the asterisk (`*`) option of the $expand query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "Levels": { - "description": "This indicates whether the expand support of the $levels qualifier is supported by the service.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of $levels as a value for the $expand query parameter as described by the specification.", + "description": "An indication of whether the service supports the $levels option of the $expand query parameter.", + "longDescription": "This property shall indicate whether the service supports the $levels option of the $expand query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "Links": { - "description": "This indicates whether the $expand support of tilde (expand only entries in the Links section) is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of tilde (expand only entries in the Links section) as a value for the $expand query parameter as described by the specification.", + "description": "An indication of whether this service supports the tilde (`~`) option of the $expand query parameter.", + "longDescription": "This property shall indicate whether this service supports the supports the tilde (~) option of the $expand query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "MaxLevels": { - "description": "This indicates the maximum number value of the $levels qualifier in $expand operations.", - "longDescription": "The value of this property shall be the maximum value of the $levels qualifier supported by the service and shall only be included if the value of the Levels property is true.", + "description": "The maximum $levels option value in the $expand query parameter.", + "longDescription": "This property shall contain the maximum $levels option value in the $expand query parameter. Shall be included only if $levels is true.", "maximum": 6, "minimum": 1, "readonly": true, @@ -54,8 +54,8 @@ "versionAdded": "v1_3_0" }, "NoLinks": { - "description": "This indicates whether the $expand support of period (expand only entries not in the Links section) is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of period (expand only entries not in the Links section) as a value for the $expand query parameter as described by the specification.", + "description": "An indication of whether the service supports the period (`.`) option of the $expand query parameter.", + "longDescription": "This property shall indicate whether the service supports the period (`.`) option of the $expand query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" @@ -65,10 +65,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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", @@ -84,13 +84,13 @@ "properties": { "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." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." }, "Sessions": { "$ref": "http://redfish.dmtf.org/schemas/v1/SessionCollection.json#/definitions/SessionCollection", - "description": "Link to a collection of Sessions.", - "longDescription": "This property shall contain the link to a collection of Sessions.", + "description": "The link to a collection of Sessions.", + "longDescription": "This property shall contain a link to a Resource Collection of type SessionCollection.", "readonly": true } }, @@ -101,10 +101,10 @@ }, "ProtocolFeaturesSupported": { "additionalProperties": false, - "description": "Contains information about protocol features supported by the service.", - "longDescription": "This type contains information about protocol features supported by the service.", + "description": "The information about protocol features that the service supports.", + "longDescription": "This type shall contain information about protocol features that the service supports.", "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", @@ -119,35 +119,35 @@ }, "properties": { "ExcerptQuery": { - "description": "This indicates whether the 'excerpt' query parameter is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of the 'excerpt' query parameter as described by the specification.", + "description": "An indication of whether the service supports the excerpt query parameter.", + "longDescription": "This property shall indicate whether this service supports the excerpt query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_4_0" }, "ExpandQuery": { "$ref": "#/definitions/Expand", - "description": "Contains information about the use of $expand in the service.", - "longDescription": "This type, as described by the Redfish Specification, shall contain information about the support of the $expand query parameter by the service.", + "description": "The information about the use of $expand in the service.", + "longDescription": "This property shall contain information about the support of the $expand query parameter by the service.", "versionAdded": "v1_3_0" }, "FilterQuery": { - "description": "This indicates whether the $filter query parameter is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of the $filter query parameter as described by the specification.", + "description": "An indication of whether the service supports the $filter query parameter.", + "longDescription": "This property shall indicate whether this service supports the $filter query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "OnlyMemberQuery": { - "description": "This indicates whether the 'only' query parameter is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of the 'only' query parameter as described by the specification.", + "description": "An indication of whether the service supports the only query parameter.", + "longDescription": "This property shall indicate whether this service supports the only query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_4_0" }, "SelectQuery": { - "description": "This indicates whether the $select query parameter is supported.", - "longDescription": "The value of this property shall be a boolean indicating whether this service supports the use of the $select query parameter as described by the specification.", + "description": "An indication of whether the service supports the $select query parameter.", + "longDescription": "This property shall indicate whether this service supports the $select query parameter.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" @@ -157,10 +157,10 @@ }, "ServiceRoot": { "additionalProperties": false, - "description": "This object represents the root Redfish service.", - "longDescription": "This object represents the root Redfish service. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification.", + "description": "The ServiceRoot schema describes the root of the Redfish Service, located at the '/redfish/v1' URI. All other Resources accessible through the Redfish interface on this device are linked directly or indirectly from the Service Root.", + "longDescription": "This Resource represents the root Redfish Service. All values that this schema describes for Resources shall comply with the Redfish Specification-described requirements.", "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", @@ -175,40 +175,40 @@ }, "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" }, "AccountService": { "$ref": "http://redfish.dmtf.org/schemas/v1/AccountService.json#/definitions/AccountService", - "description": "This is a link to the Account Service.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the AccountService schema.", + "description": "The link to the Account Service.", + "longDescription": "This property shall contain a link to a Resource of type AccountService.", "readonly": true }, "CertificateService": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateService.json#/definitions/CertificateService", - "description": "This is a link to the CertificateService.", - "longDescription": "The value shall be a link to the CertificateService.", + "description": "The link to the Certificate Service.", + "longDescription": "This property shall contain a link to a Resource of type CertificateService.", "readonly": true, "versionAdded": "v1_5_0" }, "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/ChassisCollection.json#/definitions/ChassisCollection", - "description": "This is a link to a collection of Chassis.", - "longDescription": "This object shall only contain a reference to a collection of resources that comply to the Chassis schema.", + "description": "The link to a collection of chassis.", + "longDescription": "This property shall contain a link to a Resource Collection of type ChassisCollection.", "readonly": true }, "CompositionService": { "$ref": "http://redfish.dmtf.org/schemas/v1/CompositionService.json#/definitions/CompositionService", - "description": "This is a link to the CompositionService.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the CompositionService schema.", + "description": "The link to the Composition Service.", + "longDescription": "This property shall contain a link to a Resource of type CompositionService.", "readonly": true, "versionAdded": "v1_2_0" }, @@ -225,14 +225,14 @@ }, "EventService": { "$ref": "http://redfish.dmtf.org/schemas/v1/EventService.json#/definitions/EventService", - "description": "This is a link to the EventService.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the EventService schema.", + "description": "The link to the Event Service.", + "longDescription": "This property shall contain a link to a Resource of type EventService.", "readonly": true }, "Fabrics": { "$ref": "http://redfish.dmtf.org/schemas/v1/FabricCollection.json#/definitions/FabricCollection", - "description": "A link to a collection of all fabric entities.", - "longDescription": "The referenced collection shall contain references to all Fabric instances.", + "description": "The link to a collection of all fabric entities.", + "longDescription": "This property shall contain a link to a Resource Collection of type FabricCollection.", "readonly": true, "versionAdded": "v1_1_0" }, @@ -242,26 +242,26 @@ }, "JobService": { "$ref": "http://redfish.dmtf.org/schemas/v1/JobService.json#/definitions/JobService", - "description": "This is a link to the JobService.", - "longDescription": "The classes structure shall only contain a reference to a resource that conforms to the JobService schema.", + "description": "The link to the JobService.", + "longDescription": "This property shall contain a link to a Resource of type JobService.", "readonly": true, "versionAdded": "v1_4_0" }, "JsonSchemas": { "$ref": "http://redfish.dmtf.org/schemas/v1/JsonSchemaFileCollection.json#/definitions/JsonSchemaFileCollection", - "description": "This is a link to a collection of Json-Schema files.", - "longDescription": "This object shall only contain a reference to a collection of resources that comply to the SchemaFile schema where the files are Json-Schema files.", + "description": "The link to a collection of JSON Schema files.", + "longDescription": "This property shall contain a link to a Resource Collection of type JsonSchemaFileCollection.", "readonly": true }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource." }, "Managers": { "$ref": "http://redfish.dmtf.org/schemas/v1/ManagerCollection.json#/definitions/ManagerCollection", - "description": "This is a link to a collection of Managers.", - "longDescription": "This object shall only contain a reference to a collection of resources that comply to the Managers schema.", + "description": "The link to a collection of managers.", + "longDescription": "This property shall contain a link to a Resource Collection of type ManagerCollection.", "readonly": true }, "Name": { @@ -270,12 +270,12 @@ }, "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." }, "Product": { - "description": "The product associated with this Redfish service.", - "longDescription": "The value of this string shall include the name of the product represented by this Redfish service.", + "description": "The product associated with this Redfish Service.", + "longDescription": "This property shall include the name of the product represented by this Redfish Service.", "readonly": true, "type": [ "string", @@ -285,66 +285,66 @@ }, "ProtocolFeaturesSupported": { "$ref": "#/definitions/ProtocolFeaturesSupported", - "description": "Contains information about protocol features supported by the service.", - "longDescription": "This type contains information about protocol features supported by the service.", + "description": "The information about protocol features that the service supports.", + "longDescription": "This property shall contain information about protocol features that the service supports.", "versionAdded": "v1_3_0" }, "RedfishVersion": { - "description": "The version of the Redfish service.", - "longDescription": "The value of this string shall represent the version of the Redfish service. The format of this string shall be of the format majorversion.minorversion.errata in compliance with Protocol Version section of the Redfish specification.", + "description": "The version of the Redfish Service.", + "longDescription": "This property shall represent the Redfish protocol version, as specified in the Protocol Version clause of the Redfish Specification, to which this Service conforms.", "pattern": "^\\d+\\.\\d+\\.\\d+$", "readonly": true, "type": "string" }, "Registries": { "$ref": "http://redfish.dmtf.org/schemas/v1/MessageRegistryFileCollection.json#/definitions/MessageRegistryFileCollection", - "description": "This is a link to a collection of Registries.", - "longDescription": "This object shall contain a reference to Message Registry.", + "description": "The link to a collection of Registries.", + "longDescription": "This property shall contain a link to a Resource Collection of type MessageRegistryFileCollection.", "readonly": true }, "ResourceBlocks": { "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlockCollection.json#/definitions/ResourceBlockCollection", - "description": "A link to a collection of all resource block entities. This collection is intended for implementations that do not contain a Composition Service, but will expose resources to an orchestrator that implements a Composition Service.", - "longDescription": "The referenced collection shall contain references to all Resource Block instances.", + "description": "The link to a collection of all Resource Block Resources. This collection is intended for implementations that do not contain a Composition Service but that expose Resources to an orchestrator that implements a Composition Service.", + "longDescription": "This property shall contain a link to a Resource Collection of type ResourceBlockCollection.", "readonly": true, "versionAdded": "v1_5_0" }, "SessionService": { "$ref": "http://redfish.dmtf.org/schemas/v1/SessionService.json#/definitions/SessionService", - "description": "This is a link to the Sessions Service.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the SessionService schema.", + "description": "The link to the Sessions Service.", + "longDescription": "This property shall contain a link to a Resource of type SessionService.", "readonly": true }, "StorageServices": { "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageServiceCollection.json#/definitions/StorageServiceCollection", - "description": "A link to a collection of all storage service entities.", - "longDescription": "The referenced collection shall contain references to all StorageService instances.", + "description": "The link to a collection of all storage service entities.", + "longDescription": "This property shall contain a link to a Resource Collection of type StorageServiceCollection.", "readonly": true, "versionAdded": "v1_1_0" }, "StorageSystems": { "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageSystemCollection.json#/definitions/StorageSystemCollection", - "description": "This is a link to a collection of storage systems.", - "longDescription": "The referenced collection shall contain computer systems that act as storage servers. The HostingRoles attribute of each such computer system shall have an entry for StorageServer.", + "description": "The link to a collection of storage systems.", + "longDescription": "This property shall contain a link to a Resource Collection of type StorageSystemCollection. This collection shall contain computer systems that act as storage servers. The HostingRoles attribute of each such computer system shall have a StorageServer entry.", "readonly": true, "versionAdded": "v1_1_0" }, "Systems": { "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystemCollection.json#/definitions/ComputerSystemCollection", - "description": "This is a link to a collection of Systems.", - "longDescription": "This object shall only contain a reference to a collection of resources that comply to the Systems schema.", + "description": "The link to a collection of systems.", + "longDescription": "This property shall contain a link to a Resource Collection of type ComputerSystemCollection.", "readonly": true }, "Tasks": { "$ref": "http://redfish.dmtf.org/schemas/v1/TaskService.json#/definitions/TaskService", - "description": "This is a link to the Task Service.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the TaskService schema.", + "description": "The link to the Task Service.", + "longDescription": "This property shall contain a link to a Resource of type TaskService.", "readonly": true }, "TelemetryService": { "$ref": "http://redfish.dmtf.org/schemas/v1/TelemetryService.json#/definitions/TelemetryService", - "description": "This is a link to the TelemetryService.", - "longDescription": "The value shall be a link to the TelemetryService.", + "description": "The link to the Telemetry Service.", + "longDescription": "This property shall contain a link to a Resource of type TelemetryService.", "readonly": true, "versionAdded": "v1_4_0" }, @@ -357,20 +357,20 @@ "type": "null" } ], - "description": "Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.", - "longDescription": "The value of this string shall represent the id of the Redfish service instance. The format of this string shall be a 32-byte value in the form 8-4-4-4-12. If SSDP is used, this value shall be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery. RFC4122 describes methods that can be used to create a UUID value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID.", + "description": "Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200 OK from an SSDP M-SEARCH request during discovery.", + "longDescription": "This property shall represent the id of the Redfish Service instance. The format of this string shall contain a 32-byte value in the form 8-4-4-4-12. If SSDP is used, this value shall be an exact match of the UUID value returned in a 200 OK from an SSDP M-SEARCH request during discovery. RFC4122 describes methods to use to create a UUID value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID.", "readonly": true }, "UpdateService": { "$ref": "http://redfish.dmtf.org/schemas/v1/UpdateService.json#/definitions/UpdateService", - "description": "This is a link to the UpdateService.", - "longDescription": "The classes structure shall only contain a reference to a resource that complies to the UpdateService schema.", + "description": "The link to the Update Service.", + "longDescription": "This property shall contain a link to a Resource of type UpdateService.", "readonly": true, "versionAdded": "v1_1_0" }, "Vendor": { - "description": "The vendor or manufacturer associated with this Redfish service.", - "longDescription": "The value of this string shall include the name of the manufacturer or vendor represented by this Redfish service. If this property is supported, the vendor name shall not be included in the value of the Product property.", + "description": "The vendor or manufacturer associated with this Redfish Service.", + "longDescription": "This property shall include the name of the manufacturer or vendor represented by this Redfish Service. If this property is supported, the vendor name shall not be included in the Product property value.", "readonly": true, "type": [ "string", @@ -391,5 +391,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#ServiceRoot.v1_5_0.ServiceRoot" + "title": "#ServiceRoot.v1_5_2.ServiceRoot" }
\ No newline at end of file |