xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/UpdateServiceCapabilities_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################       -->
4<!--# Redfish Schema:  UpdateServiceCapabilities v1.0.0                                    -->
5<!--#                                                                                      -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
7<!--# available at http://www.dmtf.org/standards/redfish                                   -->
8<!--# Copyright 2014-2025 DMTF.                                                            -->
9<!--# 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"/>
25    <edmx:Include Namespace="Resource.v1_0_0"/>
26  </edmx:Reference>
27
28  <edmx:DataServices>
29
30    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateServiceCapabilities">
31      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
32      <Annotation Term="Redfish.Language" String="en"/>
33
34      <EntityType Name="UpdateServiceCapabilities" BaseType="Resource.v1_0_0.Resource" Abstract="true">
35        <Annotation Term="OData.Description" String="The `UpdateServiceCapabilities` schema contains capabilities of the update service."/>
36        <Annotation Term="OData.LongDescription" String="This resource shall represent the update service capabilities for a Redfish implementation."/>
37        <Annotation Term="Capabilities.InsertRestrictions">
38          <Record>
39            <PropertyValue Property="Insertable" Bool="false"/>
40          </Record>
41        </Annotation>
42        <Annotation Term="Capabilities.UpdateRestrictions">
43          <Record>
44            <PropertyValue Property="Updatable" Bool="false"/>
45          </Record>
46        </Annotation>
47        <Annotation Term="Capabilities.DeleteRestrictions">
48          <Record>
49            <PropertyValue Property="Deletable" Bool="false"/>
50          </Record>
51        </Annotation>
52        <Annotation Term="Redfish.Uris">
53          <Collection>
54            <String>/redfish/v1/UpdateService/UpdateServiceCapabilities</String>
55          </Collection>
56        </Annotation>
57      </EntityType>
58    </Schema>
59
60    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateServiceCapabilities.v1_0_0">
61      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
62      <Annotation Term="Redfish.Release" String="2025.2"/>
63
64      <EntityType Name="UpdateServiceCapabilities" BaseType="UpdateServiceCapabilities.UpdateServiceCapabilities">
65        <Property Name="AllowableTargets" Type="Collection(Edm.String)" Nullable="false">
66          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
67          <Annotation Term="OData.Description" String="The allowable URIs that a client can specify in the `Targets` parameter for update requests."/>
68          <Annotation Term="OData.LongDescription" String="This property shall contain an array of the allowable URIs that a client can specify in the `Targets` parameter for `SimpleUpdate` or `MultipartHttpPushUri` update requests."/>
69        </Property>
70        <Property Name="AllowableStaging" Type="Collection(Edm.String)" Nullable="false">
71          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
72          <Annotation Term="OData.Description" String="The allowable URIs that a client can specify in the `Targets` parameter for update requests when requesting to stage an image on target devices."/>
73          <Annotation Term="OData.LongDescription" String="This property shall contain an array of the allowable URIs that a client can specify in the `Targets` parameter for `SimpleUpdate` or `MultipartHttpPushUri` update requests with `Stage` set to `true`."/>
74        </Property>
75        <Property Name="Actions" Type="UpdateServiceCapabilities.v1_0_0.Actions" Nullable="false">
76          <Annotation Term="OData.Description" String="The available actions for this resource."/>
77          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
78        </Property>
79      </EntityType>
80
81      <ComplexType Name="Actions">
82        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
83        <Annotation Term="OData.Description" String="The available actions for this resource."/>
84        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
85        <Property Name="Oem" Type="UpdateServiceCapabilities.v1_0_0.OemActions" Nullable="false">
86          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
87          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
88        </Property>
89      </ComplexType>
90
91      <ComplexType Name="OemActions">
92        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
93        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
94        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
95      </ComplexType>
96    </Schema>
97
98  </edmx:DataServices>
99</edmx:Edmx>
100