openstack
/
api-site
Code Issues Proposed changes

Add missing server-metadata extension to Compute v2.1 

Change-Id: I02b39ca4f524126e2b650c246b4b331f6db635a4
Closes-Bug: #1205245
This commit is contained in:
Diane Fleming 2015-08-23 16:44:03 -05:00
parent 3a1ebe96f9
commit a939859681
6 changed files with 87 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
api-ref/src/docbkx/ch_compute-v2.1.xml
View File

@ -206,6 +206,20 @@
href="../wadls/compute-api/src/v2.1/wadl/server-ips-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="server-metadata-v2.1">
<title>Server metadata (servers, metadata)</title>
<para>
Lists metadata, creates or replaces one or more metadata
items, and updates one or more metadata items for a server.
</para>
<para>
Shows details for, creates or replaces, and updates a specified
metadata item, by key, for a server.
</para>
<wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/server-metadata-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-config-drive-v2.1">
<title>Servers configuration drive (servers, os-config-drive)</title>
<para>

2
api-ref/src/wadls/common_project.ent
View File

@ -36,4 +36,4 @@
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!ENTITY nbsp "&#160;">

2
api-ref/src/wadls/compute-api/src/v2.1/api_samples/server-metadata/server-metadata-req.json
View File

@ -1,5 +1,5 @@
{
"metadata": {
"meta": {
"foo": "Bar Value"
}
}

2
api-ref/src/wadls/compute-api/src/v2.1/api_samples/server-metadata/server-metadata-resp.json
View File

@ -1,5 +1,5 @@
{
"metadata": {
"meta": {
"foo": "Foo Value"
}
}

14
api-ref/src/wadls/compute-api/src/v2.1/common.ent
View File

@ -257,7 +257,9 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The tenant ID in a multi-tenancy cloud.</para>
</wadl:doc>
</param>
</param>'>
<!-- statusRequestParameter -->
<!ENTITY statusRequestParameter '
<param name="status" style="query" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -423,6 +425,16 @@
<para>The UUID for the server.</para>
</wadl:doc>
</param>'>
<!-- keyRequestParameter -->
<!ENTITY keyRequestParameter '
<param name="key" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The metadata key.</para>
</wadl:doc>
</param>'>
<!-- Server List Parameters -->
<!ENTITY serverListParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"

97
api-ref/src/wadls/compute-api/src/v2.1/wadl/server-metadata-v2.1.wadl
View File

@ -9,30 +9,38 @@
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
<resources base="https://servers.api.openstack.com"
xml:id="server-metadata-v2.1">
<resource id="v2.1" path="//v2.1">
<resource id="servers" path="servers">
<resource id="server_id" path="{server_id}">
<resource id="server_metadata" path="metadata" type="#ServerMetadataDetails">
<method href="#showServerMetadata"/>
<method href="#createServerMetadata"/>
<method href="#updateServerMetadata"/>
<resource id="ServerMetadataKey" path="{key}">
<method href="#getServerMetadataItem"/>
<method href="#setServerMetadataItem"/>
<method href="#deleteServerMetadataItem"/>
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<resource id="servers" path="servers">
<resource id="server_id" path="{server_id}">
&serverIdRequestParameter;
<resource id="server_metadata" path="metadata"
type="#ServerMetadataDetails">
<method href="#listServerMetadata"/>
<method href="#createServerMetadata"/>
<method href="#updateServerMetadata"/>
<resource id="ServerMetadataKey" path="{key}">
&keyRequestParameter;
<method href="#getServerMetadataItem"/>
<method href="#setServerMetadataItem"/>
<method href="#deleteServerMetadataItem"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="showServerMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Show server metadata">
<method name="GET" id="listServerMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List all metadata">
<para role="shortdesc">
Shows metadata for a specified server.
Lists all metadata for a specified server.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -51,18 +59,19 @@
</method>
<method name="POST" id="updateServerMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update server metadata items">
title="Update metadata items">
<para role="shortdesc">
Updates metadata items by key for a specified server.
Updates one or more metadata items for a specified
server.
</para>
<para>
Replaces items that match the specified keys and does not
modify items not specified in the request.
Replaces metadata items that match the specified keys. Does
not modify items that are not specified in the request.
</para>
<para>
If this operation causes the quota for metadata items to be
exceeded, the API throws a <errorcode>413</errorcode>
overLimit fault.
exceeded, the API throws the API throws an <code>overLimit (413)</code>
fault.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -74,32 +83,34 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/server-metadata/server-metadata-req.json"/>
<xsdxt:code href="../api_samples/server-metadata/server-metadata-all-req.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/server-metadata/server-metadata-resp.json"/>
<xsdxt:code href="../api_samples/server-metadata/server-metadata-all-resp.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="PUT" id="createServerMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create or replace server metadata items">
title="Create or replace metadata items">
<para role="shortdesc">
Creates or replaces metadata items for a specified server.
Creates or replaces one or more specified metadata items for a specified server.
</para>
<para>
All existing metadata items are removed and completely
replaced by the metadata items in the request.
Creates any metadata items that do not already exist in the
server. Removes and completely replaces any metadata items
that already exist in the server with the metadata items in
the request.
</para>
<para>
If this operation causes the quota for metadata items to be
exceeded, the API throws a <errorcode>413</errorcode>
overLimit fault.
exceeded, the API throws the API throws an <code>overLimit (413)</code>
fault.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -111,24 +122,24 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/server-metadata/server-metadata-req.json"/>
<xsdxt:code href="../api_samples/server-metadata/server-metadata-all-req.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/server-metadata/server-metadata-resp.json"/>
<xsdxt:code href="../api_samples/server-metadata/server-metadata-all-resp.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getServerMetadataItem">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show server metadata item details">
title="Show metadata item details">
<para role="shortdesc">
Shows details for a metadata item by key for a specified
server.
Shows details for a specified metadata item, by key, for a
specified server.
</para>
<para>
Policy defaults enable only users with the administrative role
@ -147,16 +158,22 @@
</method>
<method name="PUT" id="setServerMetadataItem">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create or update server metadata item">
title="Create or update metadata item">
<para role="shortdesc">
Sets a metadata item by key for a specified server.
Creates or replaces a specified metadata item, by key, for a specified server.
</para>
<para>
Creates a metadata item that does not already exist in the
server. Removes and completely replaces a metadata item
that already exists in the server with the metadata item in
the request.
</para>
<para>
If this operation causes the quota for metadata items to be
exceeded, the API throws a <errorcode>413</errorcode>
overLimit fault.
exceeded, the API throws the API throws an <code>overLimit (413)</code>
fault.
</para>
<para>
<para>
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
@ -180,9 +197,9 @@
</method>
<method name="DELETE" id="deleteServerMetadataItem">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete server metadata item">
title="Delete metadata item">
<para role="shortdesc">
Deletes a metadata item by key for a specified server.
Deletes a specified metadata item, by key, from a specified server.
</para>
<para>
Policy defaults enable only users with the administrative role