blob: 8edea71056b6a2bd2fb49154daa443d709b654a1 [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills9d424662021-09-22 21:56:16 -05004<!--# Redfish Schema: ActionInfo v1.2.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 -->
Gunnar Mills10f270b2021-05-19 15:34:06 -05008<!--# Copyright 2014-2021 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://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24 <edmx:Include Namespace="Resource.v1_0_0"/>
25 </edmx:Reference>
26
27 <edmx:DataServices>
28
29 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo">
30 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
31
32 <EntityType Name="ActionInfo" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Gunnar Mills9d424662021-09-22 21:56:16 -050033 <Annotation Term="OData.Description" String="The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among resource instances. This data can ensure that action requests from applications contain supported parameters."/>
34 <Annotation Term="OData.LongDescription" String="This resource shall represent the supported parameters and other information for a Redfish action on a target within a Redfish implementation. Supported parameters can differ among vendors and even among resource instances. This data can ensure that action requests from applications contain supported parameters."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070035 <Annotation Term="Capabilities.InsertRestrictions">
36 <Record>
37 <PropertyValue Property="Insertable" Bool="false"/>
38 </Record>
39 </Annotation>
40 <Annotation Term="Capabilities.UpdateRestrictions">
41 <Record>
42 <PropertyValue Property="Updatable" Bool="false"/>
43 </Record>
44 </Annotation>
45 <Annotation Term="Capabilities.DeleteRestrictions">
46 <Record>
47 <PropertyValue Property="Deletable" Bool="false"/>
48 </Record>
49 </Annotation>
50 </EntityType>
Jason M. Billsea4aa752018-06-05 13:29:11 -070051 </Schema>
52
53 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_0">
54 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060055 <Annotation Term="Redfish.Release" String="2016.2"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070056
57 <EntityType Name="ActionInfo" BaseType="ActionInfo.ActionInfo">
58 <Property Name="Parameters" Type="Collection(ActionInfo.v1_0_0.Parameters)" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -070059 <Annotation Term="OData.Description" String="The list of parameters included in the specified Redfish action."/>
Gunnar Mills9d424662021-09-22 21:56:16 -050060 <Annotation Term="OData.LongDescription" String="This property shall list the parameters included in the specified Redfish action for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070061 </Property>
62 </EntityType>
63
64 <ComplexType Name="Parameters">
65 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Mills9d424662021-09-22 21:56:16 -050066 <Annotation Term="OData.Description" String="The information about a parameter included in a Redfish action for this resource."/>
67 <Annotation Term="OData.LongDescription" String="This property shall contain information about a parameter included in a Redfish action for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070068 <Property Name="Name" Type="Edm.String" Nullable="false">
69 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070070 <Annotation Term="OData.Description" String="The name of the parameter for this action."/>
71 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the parameter included in a Redfish action."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070072 <Annotation Term="Redfish.Required"/>
73 </Property>
74 <Property Name="Required" Type="Edm.Boolean" Nullable="false">
75 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070076 <Annotation Term="OData.Description" String="An indication of whether the parameter is required to complete this action."/>
77 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the parameter is required to complete this action."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070078 </Property>
79 <Property Name="DataType" Type="ActionInfo.v1_0_0.ParameterTypes">
80 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070081 <Annotation Term="OData.Description" String="The JSON property type for this parameter."/>
82 <Annotation Term="OData.LongDescription" String="This property shall contain the JSON property type for this parameter."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070083 </Property>
84 <Property Name="ObjectDataType" Type="Edm.String">
85 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070086 <Annotation Term="OData.Description" String="The data type of an object-based parameter."/>
87 <Annotation Term="OData.LongDescription" String="This property shall describe the entity type definition in `@odata.type` format for the parameter. This property shall be required for parameters with a data type of `Object` or `ObjectArray`, and shall not be present for parameters with other data types."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070088 </Property>
89 <Property Name="AllowableValues" Type="Collection(Edm.String)">
90 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070091 <Annotation Term="OData.Description" String="The allowable values for this parameter as applied to this action target."/>
Gunnar Mills9d424662021-09-22 21:56:16 -050092 <Annotation Term="OData.LongDescription" String="This property shall indicate the allowable values for this parameter as applied to this action target. For arrays, this property shall represent the allowable values for each array member."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070093 </Property>
94 </ComplexType>
95
96 <EnumType Name="ParameterTypes">
97 <Member Name="Boolean">
Ed Tanouscb103132019-10-08 11:34:22 -070098 <Annotation Term="OData.Description" String="A boolean."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070099 </Member>
100 <Member Name="Number">
101 <Annotation Term="OData.Description" String="A number."/>
102 </Member>
103 <Member Name="NumberArray">
104 <Annotation Term="OData.Description" String="An array of numbers."/>
105 </Member>
106 <Member Name="String">
107 <Annotation Term="OData.Description" String="A string."/>
108 </Member>
109 <Member Name="StringArray">
110 <Annotation Term="OData.Description" String="An array of strings."/>
111 </Member>
112 <Member Name="Object">
113 <Annotation Term="OData.Description" String="An embedded JSON object."/>
114 </Member>
115 <Member Name="ObjectArray">
116 <Annotation Term="OData.Description" String="An array of JSON objects."/>
117 </Member>
118 </EnumType>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700119 </Schema>
120
121 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_1">
122 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500123 <Annotation Term="OData.Description" String="This version was created to add explicit permissions annotations to all properties for clarity."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700124 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_0.ActionInfo"/>
125 </Schema>
126
127 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_2">
128 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
129 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
130 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_1.ActionInfo"/>
131 </Schema>
132
133 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_3">
134 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700135 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700136 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_2.ActionInfo"/>
137 </Schema>
138
Ed Tanous530520e2019-01-02 13:41:37 -0800139 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_4">
140 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
141 <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."/>
142 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_3.ActionInfo"/>
143 </Schema>
144
Ed Tanouscb103132019-10-08 11:34:22 -0700145 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_5">
146 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
147 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
148 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_4.ActionInfo"/>
149 </Schema>
150
151 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_6">
152 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
153 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
154 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_5.ActionInfo"/>
155 </Schema>
156
Gunnar Mills9d424662021-09-22 21:56:16 -0500157 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_7">
158 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
159 <Annotation Term="OData.Description" String="This version was created to clarify the behavior of AllowableValues for array parameters."/>
160 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_6.ActionInfo"/>
161 </Schema>
162
Ed Tanous530520e2019-01-02 13:41:37 -0800163 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_1_0">
164 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600165 <Annotation Term="Redfish.Release" String="2018.2"/>
Ed Tanous530520e2019-01-02 13:41:37 -0800166 <Annotation Term="OData.Description" String="This version was created to add properties to specify parameter minimum and maximum values."/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500167
Ed Tanous530520e2019-01-02 13:41:37 -0800168 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_4.ActionInfo"/>
169
170 <ComplexType Name="Parameters" BaseType="ActionInfo.v1_0_0.Parameters">
171 <Property Name="MinimumValue" Type="Edm.Decimal">
172 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
173 <Annotation Term="OData.Description" String="The minimum supported value for this parameter."/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500174 <Annotation Term="OData.LongDescription" String="This integer or number property shall contain the minimum value that this service supports. For arrays, this property shall represent the minimum value for each array member. This property shall not be present for non-integer or number parameters."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800175 </Property>
176 <Property Name="MaximumValue" Type="Edm.Decimal">
177 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700178 <Annotation Term="OData.Description" String="The maximum supported value for this parameter."/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500179 <Annotation Term="OData.LongDescription" String="This integer or number property shall contain the maximum value that this service supports. For arrays, this property shall represent the maximum value for each array member. This property shall not be present for non-integer or number parameters."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800180 </Property>
181 </ComplexType>
182 </Schema>
183
Ed Tanouscb103132019-10-08 11:34:22 -0700184 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_1_1">
185 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
186 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
187 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_1_0.ActionInfo"/>
188 </Schema>
189
190 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_1_2">
191 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
192 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
193 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_1_1.ActionInfo"/>
194 </Schema>
195
Gunnar Mills9d424662021-09-22 21:56:16 -0500196 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_1_3">
197 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
198 <Annotation Term="OData.Description" String="This version was created to clarify the behavior of AllowableValues, MinimumValue, and MaximumValue for array parameters."/>
199 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_1_2.ActionInfo"/>
200 </Schema>
201
202 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_2_0">
203 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
204 <Annotation Term="Redfish.Release" String="2021.2"/>
205
206 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_1_3.ActionInfo"/>
207
208 <ComplexType Name="Parameters" BaseType="ActionInfo.v1_1_0.Parameters">
209 <Property Name="ArraySizeMinimum" Type="Edm.Int64">
210 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
211 <Annotation Term="OData.Description" String="The minimum number of array elements required for this parameter."/>
212 <Annotation Term="OData.LongDescription" String="This property shall contain the minimum number of array elements required by this service for this parameter. This property shall not be present for non-array parameters."/>
213 </Property>
214 <Property Name="ArraySizeMaximum" Type="Edm.Int64">
215 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
216 <Annotation Term="OData.Description" String="The maximum number of array elements allowed for this parameter."/>
217 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum number of array elements that this service supports for this parameter. This property shall not be present for non-array parameters."/>
218 </Property>
219 </ComplexType>
220 </Schema>
221
Jason M. Billsea4aa752018-06-05 13:29:11 -0700222 </edmx:DataServices>
223</edmx:Edmx>