blob: c2296b5e0deed898158b207d67431ba7657bb9b2 [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanous530520e2019-01-02 13:41:37 -08004<!--# Redfish Schema: CollectionCapabilities v1.1.0-->
Jason M. Billsea4aa752018-06-05 13:29:11 -07005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Ed Tanous530520e2019-01-02 13:41:37 -08008<!--# Copyright 2014-2018 DMTF. -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07009<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
18 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource"/>
22 </edmx:Reference>
23
24 <edmx:DataServices>
25
26 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="CollectionCapabilities">
27 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
28 <ComplexType Name="CollectionCapabilities" Abstract="true"/>
29 </Schema>
30
31 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="CollectionCapabilities.v1_0_0">
32 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
33
34 <ComplexType Name="CollectionCapabilities" BaseType="CollectionCapabilities.CollectionCapabilities">
35 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
36 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
37 <Annotation Term="OData.Description" String="This type describes the capabilities of a collection."/>
38 <Annotation Term="OData.LongDescription" String="This type shall describe any capabilities of a collection in terms of how a client is able to create new resources within the collection."/>
39 <Property Name="Capabilities" Type="Collection(CollectionCapabilities.v1_0_0.Capability)" Nullable="false">
40 <Annotation Term="OData.Description" String="This property contains the list of capabilities supported by this resource."/>
41 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array of Capability structures."/>
42 </Property>
43 </ComplexType>
44
45 <ComplexType Name="Capability">
46 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
47 <Annotation Term="OData.Description" String="This type describes a specific capability of a collection for a given use case."/>
48 <Annotation Term="OData.LongDescription" String="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."/>
49 <NavigationProperty Name="CapabilitiesObject" Type="Resource.Item" Nullable="false">
50 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
51 <Annotation Term="OData.Description" String="Reference to the resource the client may GET to in order to understand how to form a POST request for a given collection."/>
52 <Annotation Term="OData.LongDescription" String="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."/>
53 <Annotation Term="OData.AutoExpandReferences"/>
54 <Annotation Term="Redfish.Required"/>
55 </NavigationProperty>
56 <Property Name="UseCase" Type="CollectionCapabilities.v1_0_0.UseCase" Nullable="false">
57 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
58 <Annotation Term="OData.Description" String="This property represents the use case in which a client may issue a POST request to the collection."/>
59 <Annotation Term="OData.LongDescription" String="The value of this property shall be an enumerated value describing the use case for this capability instance."/>
60 <Annotation Term="Redfish.Required"/>
61 </Property>
62 <Property Name="Links" Type="CollectionCapabilities.v1_0_0.Links" Nullable="false">
63 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
64 <Annotation Term="OData.LongDescription" String="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."/>
65 <Annotation Term="Redfish.Required"/>
66 </Property>
67 </ComplexType>
68
69 <EnumType Name="UseCase">
70 <Member Name="ComputerSystemComposition">
71 <Annotation Term="OData.Description" String="This capability describes a client creating a new ComputerSystem instance from a set of disaggregated hardware."/>
72 </Member>
Ed Tanous530520e2019-01-02 13:41:37 -080073 <Member Name="ComputerSystemConstrainedComposition">
74 <Annotation Term="OData.Description" String="This capability describes a client creating a new ComputerSystem instance from a set of constraints."/>
75 </Member>
Jason M. Billsea4aa752018-06-05 13:29:11 -070076 <Member Name="VolumeCreation">
77 <Annotation Term="OData.Description" String="This capability describes a client creating a new Volume instance as part of an existing storage subsystem."/>
78 </Member>
79 </EnumType>
80
81 <ComplexType Name="Links" BaseType="Resource.Links">
82 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
83 <Annotation Term="OData.LongDescription" String="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."/>
84 <NavigationProperty Name="TargetCollection" Type="Resource.ResourceCollection" Nullable="false">
85 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
86 <Annotation Term="OData.Description" String="Reference to the collection that this capabilities structure is describing."/>
87 <Annotation Term="OData.LongDescription" String="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."/>
88 <Annotation Term="OData.AutoExpandReferences"/>
89 <Annotation Term="Redfish.Required"/>
90 </NavigationProperty>
91 <NavigationProperty Name="RelatedItem" Type="Collection(Resource.Item)">
92 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
93 <Annotation Term="OData.Description" String="The ID(s) of the resources associated with this capability."/>
94 <Annotation Term="OData.LongDescription" String="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."/>
95 <Annotation Term="OData.AutoExpandReferences"/>
96 </NavigationProperty>
97 </ComplexType>
98
99 </Schema>
100
Ed Tanous530520e2019-01-02 13:41:37 -0800101 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="CollectionCapabilities.v1_0_1">
102 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
103 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
104 <ComplexType Name="CollectionCapabilities" BaseType="CollectionCapabilities.v1_0_0.CollectionCapabilities"/>
105 </Schema>
106
107 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="CollectionCapabilities.v1_1_0">
108 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
109 <Annotation Term="OData.Description" String="This version was created to add ComputerSystemConstrainedComposition to the UseCase enum."/>
110 <ComplexType Name="CollectionCapabilities" BaseType="CollectionCapabilities.v1_0_1.CollectionCapabilities"/>
111 </Schema>
112
Jason M. Billsea4aa752018-06-05 13:29:11 -0700113 </edmx:DataServices>
114</edmx:Edmx>