blob: e930174f4f5a65f8d3b1abf3b27a8e538172e606 [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: TaskService v1.1.2-->
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/Resource_v1.xml">
21 <edmx:Include Namespace="Resource"/>
22 <edmx:Include Namespace="Resource.v1_0_0"/>
23 </edmx:Reference>
24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
25 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/TaskCollection_v1.xml">
28 <edmx:Include Namespace="TaskCollection"/>
29 </edmx:Reference>
30
31 <edmx:DataServices>
32
33 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService">
34 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
35
36 <EntityType Name="TaskService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
37 <Annotation Term="OData.Description" String="The Task Service of a Redfish service allows scheduling and execution of long-duration processes. It represents the properties for the Task Service itself and has links to the actual collection of Task resources."/>
38 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a task service for a Redfish implementation."/>
39 <Annotation Term="Capabilities.InsertRestrictions">
40 <Record>
41 <PropertyValue Property="Insertable" Bool="false"/>
42 </Record>
43 </Annotation>
44 <Annotation Term="Capabilities.UpdateRestrictions">
45 <Record>
46 <PropertyValue Property="Updatable" Bool="true"/>
47 <Annotation Term="OData.Description" String="Task Service can be updated to enable or disable the service, though some implemenations may not allow the operation to succeed."/>
48 </Record>
49 </Annotation>
50 <Annotation Term="Capabilities.DeleteRestrictions">
51 <Record>
52 <PropertyValue Property="Deletable" Bool="false"/>
53 </Record>
54 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -080055 <Annotation Term="Redfish.Uris">
56 <Collection>
57 <String>/redfish/v1/TaskService</String>
58 </Collection>
59 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070060 </EntityType>
61
62 </Schema>
63
64 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_0">
65 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
66
67 <EntityType Name="TaskService" BaseType="TaskService.TaskService">
68 <Annotation Term="OData.Description" String="This is the schema definition for the Task Service. It represents the properties for the service itself and has links to the actual list of tasks."/>
69 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a task service for a Redfish implementation."/>
70 <Property Name="CompletedTaskOverWritePolicy" Type="TaskService.v1_0_0.OverWritePolicy" Nullable="false">
71 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
72 <Annotation Term="OData.Description" String="Overwrite policy of completed tasks."/>
73 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate how completed tasks are handled should the task service need to track more tasks."/>
74 </Property>
75 <Property Name="DateTime" Type="Edm.DateTimeOffset">
76 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
77 <Annotation Term="OData.Description" String="The current DateTime (with offset) setting that the task service is using."/>
78 <Annotation Term="OData.LongDescription" String="The value of this property shall represent the current DateTime value for the TaskService, with offset from UTC, in Redfish Timestamp format."/>
79 </Property>
80 <Property Name="LifeCycleEventOnTaskStateChange" Type="Edm.Boolean" Nullable="false">
81 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
82 <Annotation Term="OData.Description" String="Send an Event upon Task State Change."/>
83 <Annotation Term="OData.LongDescription" String="The value of this property, if set to true, shall indicate that the service shall send a Life cycle event to Event Destinations Subscriptions registered for such events upon change of task state. Life cycle events are defined in the Eventing section of the Redfish Specification."/>
84 </Property>
85 <Property Name="ServiceEnabled" Type="Edm.Boolean">
86 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
87 <Annotation Term="OData.Description" String="This indicates whether this service is enabled."/>
88 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this service is enabled."/>
89 </Property>
Ed Tanous530520e2019-01-02 13:41:37 -080090 <Property Name="Status" Type="Resource.Status" Nullable="false">
91 <Annotation Term="OData.Description" String="This property describes the status and health of the resource and its children."/>
92 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
93 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -070094 <NavigationProperty Name="Tasks" Type="TaskCollection.TaskCollection" ContainsTarget="true" Nullable="false">
95 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
96 <Annotation Term="OData.Description" String="References to the Tasks collection."/>
97 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a resource of type TaskCollection."/>
98 <Annotation Term="OData.AutoExpandReferences"/>
99 </NavigationProperty>
100 </EntityType>
101
102 <EnumType Name="OverWritePolicy">
103 <Member Name="Manual">
104 <Annotation Term="OData.Description" String="Completed tasks are not automatically overwritten."/>
105 </Member>
106 <Member Name="Oldest">
107 <Annotation Term="OData.Description" String="Oldest completed tasks are overwritten."/>
108 </Member>
109 </EnumType>
110
111 </Schema>
112
113 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_2">
114 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
115 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
116 <EntityType Name="TaskService" BaseType="TaskService.v1_0_0.TaskService"/>
117 </Schema>
118
119 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_3">
120 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
121 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/>
122 <EntityType Name="TaskService" BaseType="TaskService.v1_0_2.TaskService"/>
123 </Schema>
124
125 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_4">
126 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
127 <Annotation Term="OData.Description" String="This version was created to correct the LongDescription for LifeCycleEventOnTaskStateChange."/>
128 <EntityType Name="TaskService" BaseType="TaskService.v1_0_3.TaskService"/>
129 </Schema>
130
Ed Tanous530520e2019-01-02 13:41:37 -0800131 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_5">
132 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
133 <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."/>
134 <EntityType Name="TaskService" BaseType="TaskService.v1_0_4.TaskService"/>
135 </Schema>
136
Jason M. Billsea4aa752018-06-05 13:29:11 -0700137 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_1_0">
138 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
139 <EntityType Name="TaskService" BaseType="TaskService.v1_0_3.TaskService">
140 <Property Name="Actions" Type="TaskService.v1_1_0.Actions" Nullable="false">
141 <Annotation Term="OData.Description" String="The available actions for this resource."/>
142 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800143 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700144 </EntityType>
145
146 <ComplexType Name="Actions">
147 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
148 <Annotation Term="OData.Description" String="The available actions for this resource."/>
149 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800150 <Property Name="Oem" Type="TaskService.v1_1_0.OemActions" Nullable="false">
151 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
152 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
153 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700154 </ComplexType>
155
156 <ComplexType Name="OemActions">
157 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
158 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
159 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
160 </ComplexType>
161 </Schema>
162
163 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_1_1">
164 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
165 <Annotation Term="OData.Description" String="This version was created to correct the LongDescription for LifeCycleEventOnTaskStateChange."/>
166 <EntityType Name="TaskService" BaseType="TaskService.v1_1_0.TaskService"/>
167 </Schema>
168
Ed Tanous530520e2019-01-02 13:41:37 -0800169 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_1_2">
170 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
171 <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."/>
172 <EntityType Name="TaskService" BaseType="TaskService.v1_1_1.TaskService"/>
173 </Schema>
174
Jason M. Billsea4aa752018-06-05 13:29:11 -0700175 </edmx:DataServices>
176</edmx:Edmx>