summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json
diff options
context:
space:
mode:
Diffstat (limited to 'static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json')
-rw-r--r--static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json64
1 files changed, 36 insertions, 28 deletions
diff --git a/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json b/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json
index 237727f27f..6ae64becbf 100644
--- a/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json
+++ b/static/redfish/v1/JsonSchemas/CollectionCapabilities/CollectionCapabilities.json
@@ -1,14 +1,14 @@
{
- "$id": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.v1_1_1.json",
+ "$id": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.v1_2_0.json",
"$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": {
"Capability": {
"additionalProperties": false,
- "description": "This type describes a specific capability of a collection for a given use case.",
- "longDescription": "This type shall describe a specific capability of a collection in terms of how a client is able to create new resources within the collection for the specified use case.",
+ "description": "This type describes a capability of a collection for a specific use case.",
+ "longDescription": "This type shall describe a capability of a Resource Collection in terms of how a client can create Resources within the collection for the specified use case.",
"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",
@@ -23,20 +23,20 @@
},
"properties": {
"CapabilitiesObject": {
- "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef",
- "description": "Reference to the resource the client may GET to in order to understand how to form a POST request for a given collection.",
- "longDescription": "The value of this property shall be a reference to a Resource that matches the type for the given collection and shall contain annotations that describe the properties allowed in the POST request.",
+ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef",
+ "description": "The link to the Resource the client may GET to understand how to form a POST request for a collection.",
+ "longDescription": "This property shall contain a link to a Resource that matches the type for a Resource Collection and shall contain annotations that describe the properties allowed in the POST request.",
"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."
},
"UseCase": {
"$ref": "#/definitions/UseCase",
- "description": "This property represents the use case in which a client may issue a POST request to the collection.",
- "longDescription": "The value of this property shall be an enumerated value describing the use case for this capability instance.",
+ "description": "The use case in which a client may issue a POST request to the collection.",
+ "longDescription": "This property shall contain an enumerated value that describes the use case for this capability instance.",
"readonly": true
}
},
@@ -50,9 +50,9 @@
"CollectionCapabilities": {
"additionalProperties": false,
"description": "This type describes the capabilities of a collection.",
- "longDescription": "This type shall describe any capabilities of a collection in terms of how a client is able to create new resources within the collection.",
+ "longDescription": "This type shall describe any capabilities of a Resource Collection in terms of how a client can create Resources within the Resource Collection.",
"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",
@@ -67,22 +67,30 @@
},
"properties": {
"Capabilities": {
- "description": "This property contains the list of capabilities supported by this resource.",
+ "description": "The list of capabilities supported by this Resource.",
"items": {
"$ref": "#/definitions/Capability"
},
- "longDescription": "The value of this property shall be an array of Capability structures.",
+ "longDescription": "This property shall contain an array of Capability structures.",
"type": "array"
+ },
+ "MaxMembers": {
+ "description": "The maximum number of members allowed in this collection.",
+ "longDescription": "This integer property shall contain the maximum number of members allowed in this Resource Collection.",
+ "minimum": 1,
+ "readonly": true,
+ "type": "integer",
+ "versionAdded": "v1_2_0"
}
},
"type": "object"
},
"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",
@@ -98,25 +106,25 @@
"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."
},
"RelatedItem": {
- "description": "The ID(s) of the resources associated with this capability.",
+ "description": "The ID(s) of the Resources associated with this capability.",
"items": {
- "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef"
+ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
},
- "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is related to this capability.",
+ "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the Resource that is related to this capability.",
"readonly": true,
"type": "array"
},
"RelatedItem@odata.count": {
- "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
+ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"TargetCollection": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResourceCollection",
"description": "Reference to the collection that this capabilities structure is describing.",
- "longDescription": "The value of this property shall be a reference to a Resource Collection that this structure is describing. This structure may be used by a client in order to understand how to form the POST request for the given collection.",
+ "longDescription": "This property shall contain a link to a Resource Collection that this structure describes. A client may use this structure to understand how to form the POST request for the collection.",
"readonly": true
}
},
@@ -143,6 +151,6 @@
}
},
"owningEntity": "DMTF",
- "release": "2018.2",
- "title": "#CollectionCapabilities.v1_1_1"
+ "release": "2019.2",
+ "title": "#CollectionCapabilities.v1_2_0"
} \ No newline at end of file