Collection Capabilities Annotation

The Collection Capabilities annotation allows a client to discover which collections in the service support compositions, how the POST request for the collection is formatted, as well as what properties are required.
"@Redfish.Collection Capabilities" is available under the following resources:
- Systems Collection - "redfish/v1/Systems"
- Resource Zone Instance - "redfish/v1/CompositionService/ResourceZones/1"
The following attributes are available in @Redfish.CollectionCapabilities annotation.

Table 1. Collection Capabilities Annotation Property List
Name	Type	Read-only	Description
Capabilities	Array	True	This property shall contain an array of objects that describe the capabilities of this resource collection. Refer to Capabilities Annotation Property List
MaxMembers	Integer	True	The maximum number of members allowed in this collection.

Table 2. Capabilities Annotation Property List
Name	Type	Read-only	Description
UseCase	String	True	This property represents the use case in which a client may issue a POST request to the collection.
			Enum	Description
			ComputerSystemComposition	This capability describes a client creating a new ComputerSystem instance from a set of disaggregated hardware.
Links(M)	Object	True	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.
			Name	Type	Read-only	Description
			RelatedItem	Array	True	The ID(s) of the resources associated with this capability.
			TargetCollection(M)	Array	True	Reference to the collection that this capabilities structure is describing.
CapabilitiesObject	Object	True	Reference to the resource the client may GET to understand how to form a POST request for a given collection.

Give feedback