blob: 97658cea24215d3a392bb3b0431ed0c2550ac136 [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: ActionInfo 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://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">
33 <Annotation Term="OData.Description" String="The ActionInfo schema describes the parameters and other information necessary to perform a Redfish Action on a particular Action target. Parameter support can differ between vendors and even between instances of a resource. This data can be used to ensure Action requests from applications contain supported parameters."/>
34 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent information about the supported parameters for an Action within a Redfish implementation."/>
35 <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>
51
52 </Schema>
53
54 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_0">
55 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060056 <Annotation Term="Redfish.Release" String="2016.2"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070057
58 <EntityType Name="ActionInfo" BaseType="ActionInfo.ActionInfo">
59 <Property Name="Parameters" Type="Collection(ActionInfo.v1_0_0.Parameters)" Nullable="false">
60 <Annotation Term="OData.Description" String="The parameters associated with the specified Redfish Action."/>
61 <Annotation Term="OData.LongDescription" String="This property shall contain a list of parameters associated with a Redfish Action associated with this resource."/>
62 </Property>
63 </EntityType>
64
65 <ComplexType Name="Parameters">
66 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
67 <Annotation Term="OData.Description" String="A parameter associated with the specified Redfish Action."/>
68 <Annotation Term="OData.LongDescription" String="This property shall contain information about a specific parameter associated with a Redfish Action associated with this resource."/>
69 <Property Name="Name" Type="Edm.String" Nullable="false">
70 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
71 <Annotation Term="OData.Description" String="The name of the parameter for this Action."/>
72 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the parameter used by the associated Redfish Action."/>
73 <Annotation Term="Redfish.Required"/>
74 </Property>
75 <Property Name="Required" Type="Edm.Boolean" Nullable="false">
76 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
77 <Annotation Term="OData.Description" String="Indicates whether the parameter is required to perform this Action."/>
78 <Annotation Term="OData.LongDescription" String="This property shall return true if the parameter is required to be present to perform the associated Action, and shall be false if the parameter is not required (optional) to perform the associated Action."/>
79 </Property>
80 <Property Name="DataType" Type="ActionInfo.v1_0_0.ParameterTypes">
81 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
82 <Annotation Term="OData.Description" String="The JSON property type used for this parameter."/>
83 <Annotation Term="OData.LongDescription" String="This property shall indicate the JSON property type of the parameter."/>
84 </Property>
85 <Property Name="ObjectDataType" Type="Edm.String">
86 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
87 <Annotation Term="OData.Description" String="The OData Type of an object-based parameter."/>
88 <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 DataType of Object or ObjectArray, and shall not be present for parameters with other DataType(s)."/>
89 </Property>
90 <Property Name="AllowableValues" Type="Collection(Edm.String)">
91 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
92 <Annotation Term="OData.Description" String="A list of values for this parameter supported by this Action target."/>
93 <Annotation Term="OData.LongDescription" String="This property shall indicate the allowable values for this parameter as applied to this Action target."/>
94 </Property>
95 </ComplexType>
96
97 <EnumType Name="ParameterTypes">
98 <Member Name="Boolean">
99 <Annotation Term="OData.Description" String="A boolean (true or false)."/>
100 </Member>
101 <Member Name="Number">
102 <Annotation Term="OData.Description" String="A number."/>
103 </Member>
104 <Member Name="NumberArray">
105 <Annotation Term="OData.Description" String="An array of numbers."/>
106 </Member>
107 <Member Name="String">
108 <Annotation Term="OData.Description" String="A string."/>
109 </Member>
110 <Member Name="StringArray">
111 <Annotation Term="OData.Description" String="An array of strings."/>
112 </Member>
113 <Member Name="Object">
114 <Annotation Term="OData.Description" String="An embedded JSON object."/>
115 </Member>
116 <Member Name="ObjectArray">
117 <Annotation Term="OData.Description" String="An array of JSON objects."/>
118 </Member>
119 </EnumType>
120
121 </Schema>
122
123 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_1">
124 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
125 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/>
126 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_0.ActionInfo"/>
127 </Schema>
128
129 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_2">
130 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
131 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
132 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_1.ActionInfo"/>
133 </Schema>
134
135 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_3">
136 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanous530520e2019-01-02 13:41:37 -0800137 <Annotation Term="OData.Description" String="This version was created to perform editorial updates of descriptions defined in this schema."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700138 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_2.ActionInfo"/>
139 </Schema>
140
Ed Tanous530520e2019-01-02 13:41:37 -0800141 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_0_4">
142 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
143 <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."/>
144 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_3.ActionInfo"/>
145 </Schema>
146
147 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ActionInfo.v1_1_0">
148 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600149 <Annotation Term="Redfish.Release" String="2018.2"/>
Ed Tanous530520e2019-01-02 13:41:37 -0800150 <Annotation Term="OData.Description" String="This version was created to add properties to specify parameter minimum and maximum values."/>
151 <EntityType Name="ActionInfo" BaseType="ActionInfo.v1_0_4.ActionInfo"/>
152
153 <ComplexType Name="Parameters" BaseType="ActionInfo.v1_0_0.Parameters">
154 <Property Name="MinimumValue" Type="Edm.Decimal">
155 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
156 <Annotation Term="OData.Description" String="The minimum supported value for this parameter."/>
157 <Annotation Term="OData.LongDescription" String="This property shall indicate the minimum value of an integer or number type parameter supported by this service. This property shall not be present for parameters that are of types other than integer or number."/>
158 </Property>
159 <Property Name="MaximumValue" Type="Edm.Decimal">
160 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
161 <Annotation Term="OData.Description" String="The maximum supported value of this parameter."/>
162 <Annotation Term="OData.LongDescription" String="This property shall indicate the maximum value of an integer or number type parameter supported by this service. This property shall not be present for parameters that are of types other than integer or number."/>
163 </Property>
164 </ComplexType>
165 </Schema>
166
Jason M. Billsea4aa752018-06-05 13:29:11 -0700167 </edmx:DataServices>
168</edmx:Edmx>