1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.v1_4_1.json", 3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 4 "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", 5 "definitions": { 6 "Capability": { 7 "additionalProperties": false, 8 "description": "This type describes a capability of a collection for a specific use case.", 9 "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.", 10 "patternProperties": { 11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 12 "description": "This property shall specify a valid odata or Redfish property.", 13 "type": [ 14 "array", 15 "boolean", 16 "integer", 17 "number", 18 "null", 19 "object", 20 "string" 21 ] 22 } 23 }, 24 "properties": { 25 "CapabilitiesObject": { 26 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef", 27 "description": "The link to the resource the client can issue a `GET` request against to understand how to form a `POST` request for a collection.", 28 "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.", 29 "readonly": true 30 }, 31 "Links": { 32 "$ref": "#/definitions/Links", 33 "description": "The links to other resources that are related to this resource.", 34 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." 35 }, 36 "UseCase": { 37 "$ref": "#/definitions/UseCase", 38 "description": "The use case in which a client can issue a `POST` request to the collection.", 39 "longDescription": "This property shall contain an enumerated value that describes the use case for this capability instance.", 40 "readonly": true 41 } 42 }, 43 "required": [ 44 "CapabilitiesObject", 45 "UseCase", 46 "Links" 47 ], 48 "type": "object" 49 }, 50 "CollectionCapabilities": { 51 "additionalProperties": false, 52 "description": "This type describes the capabilities of a collection.", 53 "longDescription": "This type shall describe any capabilities of a resource collection in terms of how a client can create resources within the resource collection.", 54 "patternProperties": { 55 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 56 "description": "This property shall specify a valid odata or Redfish property.", 57 "type": [ 58 "array", 59 "boolean", 60 "integer", 61 "number", 62 "null", 63 "object", 64 "string" 65 ] 66 } 67 }, 68 "properties": { 69 "Capabilities": { 70 "description": "The list of capabilities supported by this resource.", 71 "items": { 72 "$ref": "#/definitions/Capability" 73 }, 74 "longDescription": "This property shall contain an array of objects that describe the capabilities of this resource collection.", 75 "type": "array" 76 }, 77 "MaxMembers": { 78 "description": "The maximum number of members allowed in this collection.", 79 "longDescription": "This property shall contain the maximum number of members allowed in this resource collection.", 80 "minimum": 1, 81 "readonly": true, 82 "type": "integer", 83 "versionAdded": "v1_2_0" 84 } 85 }, 86 "type": "object" 87 }, 88 "Links": { 89 "additionalProperties": false, 90 "description": "The links to other resources that are related to this resource.", 91 "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.", 92 "patternProperties": { 93 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 94 "description": "This property shall specify a valid odata or Redfish property.", 95 "type": [ 96 "array", 97 "boolean", 98 "integer", 99 "number", 100 "null", 101 "object", 102 "string" 103 ] 104 } 105 }, 106 "properties": { 107 "Oem": { 108 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 109 "description": "The OEM extension property.", 110 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 111 }, 112 "RelatedItem": { 113 "description": "An array of links to resources associated with this capability.", 114 "items": { 115 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" 116 }, 117 "longDescription": "This property shall contain an array of links to resources that are related to this capability.", 118 "readonly": true, 119 "type": "array" 120 }, 121 "RelatedItem@odata.count": { 122 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 123 }, 124 "TargetCollection": { 125 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResourceCollection", 126 "description": "The link to the collection that this capabilities structure is describing.", 127 "longDescription": "This property shall contain a link to a resource collection that this structure describes. A client can use this structure to understand how to form the `POST` request for the collection.", 128 "readonly": true 129 } 130 }, 131 "required": [ 132 "TargetCollection" 133 ], 134 "type": "object" 135 }, 136 "UseCase": { 137 "enum": [ 138 "ComputerSystemComposition", 139 "ComputerSystemConstrainedComposition", 140 "VolumeCreation", 141 "ResourceBlockComposition", 142 "ResourceBlockConstrainedComposition", 143 "RegisterResourceBlock" 144 ], 145 "enumDescriptions": { 146 "ComputerSystemComposition": "This capability describes a client creating a new computer system resource from a set of disaggregated hardware.", 147 "ComputerSystemConstrainedComposition": "This capability describes a client creating a new computer system resource from a set of constraints.", 148 "RegisterResourceBlock": "This capability describes a client creating a new resource block from an existing computer system to enable it to be used by the composition service.", 149 "ResourceBlockComposition": "This capability describes a client creating a new resource block from a set of other resource blocks.", 150 "ResourceBlockConstrainedComposition": "This capability describes a client creating a new resource block from a set of constraints.", 151 "VolumeCreation": "This capability describes a client creating a new volume resource as part of an existing storage subsystem." 152 }, 153 "enumVersionAdded": { 154 "ComputerSystemConstrainedComposition": "v1_1_0", 155 "RegisterResourceBlock": "v1_4_0", 156 "ResourceBlockComposition": "v1_3_0", 157 "ResourceBlockConstrainedComposition": "v1_3_0" 158 }, 159 "type": "string" 160 } 161 }, 162 "language": "en", 163 "owningEntity": "DMTF", 164 "release": "2022.1", 165 "title": "#CollectionCapabilities.v1_4_1" 166}