blob: 237727f27fda23a7e593fa1669a66f2f5bcddff2 [file] [log] [blame]
{
"$id": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.v1_1_1.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",
"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.",
"patternProperties": {
"^([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",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"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.",
"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."
},
"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.",
"readonly": true
}
},
"required": [
"CapabilitiesObject",
"UseCase",
"Links"
],
"type": "object"
},
"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.",
"patternProperties": {
"^([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",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Capabilities": {
"description": "This property contains 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.",
"type": "array"
}
},
"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.",
"patternProperties": {
"^([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",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"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."
},
"RelatedItem": {
"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"
},
"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.",
"readonly": true,
"type": "array"
},
"RelatedItem@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.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.",
"readonly": true
}
},
"required": [
"TargetCollection"
],
"type": "object"
},
"UseCase": {
"enum": [
"ComputerSystemComposition",
"ComputerSystemConstrainedComposition",
"VolumeCreation"
],
"enumDescriptions": {
"ComputerSystemComposition": "This capability describes a client creating a new ComputerSystem instance from a set of disaggregated hardware.",
"ComputerSystemConstrainedComposition": "This capability describes a client creating a new ComputerSystem instance from a set of constraints.",
"VolumeCreation": "This capability describes a client creating a new Volume instance as part of an existing storage subsystem."
},
"enumVersionAdded": {
"ComputerSystemConstrainedComposition": "v1_1_0"
},
"type": "string"
}
},
"owningEntity": "DMTF",
"release": "2018.2",
"title": "#CollectionCapabilities.v1_1_1"
}