Compute v2.1 docs clean up (part13) (images related)
Add images/image-metadata/image-size
WADL file is based on v2 (os-compute-2.wadl)
with subtract many items with keeping images/image-metadata
and adds image-size
JSON sample files are not linked one
but add image-size info
P.S.
Previously,
images/image-metadata exists on v2.
image-size exists on v2-ext.
Change-Id: Ia4bd4304c11ebd7134b92c3d68e07dcde9aa4cff
Partial-Bug: #1488144
This commit is contained in:
Atsushi SAKAI
Diane Fleming
parent
1b99fa21aa
commit
0b61d4e89e
|
|
@ -323,6 +323,53 @@
|
|||
href="../wadls/compute-api/src/v2.1/wadl/os-extensions-v2.1.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="compute_images-v2.1">
|
||||
<title>Images</title>
|
||||
<para>
|
||||
Lists, gets details for, and deletes images. Also sets, lists,
|
||||
gets details for, and deletes image metadata.
|
||||
</para>
|
||||
<para>
|
||||
An image is a collection of files that you use to create and
|
||||
rebuild a server. By default, operators provide pre-built
|
||||
operating system images. You can also create custom images. See
|
||||
Compute server actions.
|
||||
</para>
|
||||
<para>
|
||||
If you set the image size policy in the <code>policy.json</code>
|
||||
file, the <code>OS-EXT-IMG-SIZE:size</code> extended attribute is
|
||||
visible.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/images-v2.1.wadl#Images">
|
||||
<wadl:method href="#listImages"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/images-v2.1.wadl#image_detail">
|
||||
<wadl:method href="#listDetailImages"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/images-v2.1.wadl#image_id">
|
||||
<wadl:method href="#getImage"/>
|
||||
<wadl:method href="#deleteImage"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="compute_image_metadata-v2.1">
|
||||
<title>Image metadata</title>
|
||||
<para>Shows details for, sets, updates, and deletes image metadata or metadata items.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/images-v2.1.wadl#image_metadata">
|
||||
<wadl:method href="#showImageMetadata"/>
|
||||
<wadl:method href="#createImageMetadata"/>
|
||||
<wadl:method href="#updateImageMetadata"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/v2.1/wadl/images-v2.1.wadl#imageMetadataKey">
|
||||
<wadl:method href="#getImageMetadataItem"/>
|
||||
<wadl:method href="#setImageMetadataItem"/>
|
||||
<wadl:method href="#deleteImageMetadataItem"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-agents-v2.1">
|
||||
<title>Guest agents (os-agents)</title>
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
{
|
||||
"image": {
|
||||
"OS-EXT-IMG-SIZE:size": "74185822",
|
||||
"created": "2011-01-01T01:02:03Z",
|
||||
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
||||
"links": [
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
{
|
||||
"images": [
|
||||
{
|
||||
"OS-EXT-IMG-SIZE:size": "74185822",
|
||||
"created": "2011-01-01T01:02:03Z",
|
||||
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
||||
"links": [
|
||||
|
|
@ -32,6 +33,7 @@
|
|||
"updated": "2011-01-01T01:02:03Z"
|
||||
},
|
||||
{
|
||||
"OS-EXT-IMG-SIZE:size": "74185821",
|
||||
"created": "2011-01-01T01:02:03Z",
|
||||
"id": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
|
||||
"links": [
|
||||
|
|
|
|||
|
|
@ -1492,3 +1492,86 @@
|
|||
<para>The ID of the virtual network.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!-- Image List Parameters -->
|
||||
<!ENTITY imageListQueryParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="changes-since" style="query" required="false"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the image last changed status.
|
||||
</para>
|
||||
<para>
|
||||
Use this query parameter to check for changes since a previous request
|
||||
rather than re-downloading and re-parsing the full status at each polling
|
||||
interval. If data has changed, the call returns only the items changed
|
||||
since the specified time. If data has not changed since the
|
||||
<code>changes-since</code> time, the call returns an empty list.
|
||||
</para>
|
||||
<para>
|
||||
To enable you to keep track of changes, this filter also displays images
|
||||
that were deleted if the <code>changes-since</code> value specifies a date
|
||||
in the last 30 days. Items deleted more than 30 days ago might be
|
||||
returned, but it is not guaranteed.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, returns the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
<para>For example, <code>2015-08-27T09:49:58-05:00</code>.</para>
|
||||
<para>If you omit the time zone, the UTC time zone is assumed.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="server" style="query" required="false"
|
||||
type="xsd:anyURI">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Name of the server in URL
|
||||
format.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="query" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Name of the image as a
|
||||
string.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="status" style="query" required="false"
|
||||
type="csapi:ImageStatus">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Value of the image statuses.
|
||||
For example, you can filter on <code>ACTIVE</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="type" style="query" required="false"
|
||||
type="xsd:string" default="ALL">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Value of the type of image, such as snapshot
|
||||
or backup.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<option value="snapshot"/>
|
||||
<option value="backup"/>
|
||||
</param>'>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,381 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2012-2015 OpenStack Foundation, All Rights Reserved -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent images-v2.1.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:db="http://docbook.org/ns/docbook"
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
||||
<grammars>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
<!--*******************************************************-->
|
||||
<resources base="https://servers.api.openstack.com" xml:id="images-v2.1">
|
||||
<resource id="versions" path="/">
|
||||
<resource id="version" path="v2.1">
|
||||
<resource id="Images" type="#ImageList" path="images">
|
||||
<resource id="image_detail" path="detail" type="#DetailImageList" />
|
||||
<resource id="image_id" path="{image_id}">
|
||||
<param name="image_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="image_id">
|
||||
<para>The UUID for the image.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getImage" />
|
||||
<method href="#deleteImage" />
|
||||
<resource id="image_metadata" path="metadata" type="#ImageMetadataDetails">
|
||||
<resource id="imageMetadataKey" path="{key}">
|
||||
<param name="key" style="template" type="csapi:imageMetadataKey">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Metadata item key">
|
||||
<para>A string. Maximum length is 255 characters.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getImageMetadataItem" />
|
||||
<method href="#setImageMetadataItem" />
|
||||
<method href="#deleteImageMetadataItem" />
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<!--*******************************************************-->
|
||||
<!-- Resource Types -->
|
||||
<!--*******************************************************-->
|
||||
<resource_type id="DetailImageList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detail image list">
|
||||
<para>A detailed image list.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listDetailImages"/>
|
||||
</resource_type>
|
||||
<resource_type id="ImageList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Image list">
|
||||
<para>
|
||||
A list of images. Each image contains IDs, names, and links.
|
||||
Other attributes are omitted.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<method href="#listImages"/>
|
||||
</resource_type>
|
||||
<resource_type id="ImageMetadataDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Image metadata list">
|
||||
<para>Metadata details for an image.</para>
|
||||
</wadl:doc>
|
||||
<method href="#showImageMetadata"/>
|
||||
<method href="#createImageMetadata"/>
|
||||
<method href="#updateImageMetadata"/>
|
||||
</resource_type>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Methods -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Images -->
|
||||
<method name="GET" id="listDetailImages">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="List images details">
|
||||
<para role="shortdesc">Lists all details for available images.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
&imageListQueryParameters;
|
||||
&limitMarkerReqParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/images/images-details-get-resp.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
&x-compute-request-idHeader;
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:images/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the next metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#DetailImageList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:images/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the previous metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#DetailImageList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common Faults --> &commonFaults;
|
||||
</method>
|
||||
<method name="GET" id="listImages">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List images">
|
||||
<para role="shortdesc">Lists IDs, names, and links for available images.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
&imageListQueryParameters;
|
||||
&limitMarkerReqParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/images/images-list-get-resp.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
&x-compute-request-idHeader;
|
||||
<param name="images" style="plain" required="true"
|
||||
type="csapi:ImagesWithOnlyIDsNamesLinks" path="/csapi:images">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Image information.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:images/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the next metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ImageList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:images/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the previous metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ImageList" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common Faults --> &commonFaults;
|
||||
</method>
|
||||
<method name="GET" id="getImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get image details">
|
||||
<para role="shortdesc">Gets details for a specified image.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/images/image-get-resp.json"/>
|
||||
</wadl:doc>
|
||||
&x-compute-request-idHeader;
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common and GET Faults--> &commonFaults; &getFaults;
|
||||
</method>
|
||||
<method name="DELETE" id="deleteImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete image">
|
||||
<para role="shortdesc">Deletes a specified image.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
<!-- Common and GET Faults --> &commonFaults; &getFaults;
|
||||
</method>
|
||||
<!-- Metadata -->
|
||||
<method name="GET" id="showImageMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Show image metadata">
|
||||
<para role="shortdesc">Shows metadata for a specified image.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/images/image-metadata-get-resp.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
&x-compute-request-idHeader;
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the next metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ServerMetadataDetails" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the previous metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ServerMetadataDetails" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
|
||||
</method>
|
||||
<method name="POST" id="updateImageMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update image metadata items">
|
||||
<para role="shortdesc">Updates metadata items by key for a specified image.</para>
|
||||
<para>Replaces items that match the specified keys and does not modify items not
|
||||
specified in the request.
|
||||
</para>
|
||||
<para>
|
||||
If this operation exceeds the metadata items quota, the API throws
|
||||
an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/images/image-metadata-post-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/images/image-metadata-post-resp.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the next metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ImageMetadataDetails" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the previous metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ImageMetadataDetails" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
||||
&inProgressFault;
|
||||
</method>
|
||||
<method name="PUT" id="createImageMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or replace image metadata">
|
||||
<para role="shortdesc">Creates or replaces metadata for a specified image.</para>
|
||||
<para>Replaces items that match the specified keys. If you omit a key that already
|
||||
exists, this key retains its value.
|
||||
</para>
|
||||
<para>
|
||||
If this operation exceeds the metadata items quota, the API throws
|
||||
an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/images/image-metadata-put-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/images/image-metadata-put-resp.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml" element="csapi:metadata">
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the next metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ImageMetadataDetails" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the previous metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ImageMetadataDetails" rel="previous"/>
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
||||
&inProgressFault;
|
||||
</method>
|
||||
<method name="GET" id="getImageMetadataItem">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show image metadata item details">
|
||||
<para role="shortdesc">Shows details for a metadata item by key for a specified
|
||||
image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/images/image-metadata-get-resp.json"/>
|
||||
</wadl:doc>
|
||||
&x-compute-request-idHeader;
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
|
||||
</method>
|
||||
<method name="PUT" id="setImageMetadataItem">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or update image metadata item">
|
||||
<para role="shortdesc">Creates or updates a metadata item by key for a specified
|
||||
image.
|
||||
</para>
|
||||
<para>
|
||||
If this operation exceeds the metadata items quota,
|
||||
the API throws an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="../api_samples/images/image-metadata-put-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/images/image-metadata-put-resp.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
||||
&inProgressFault;
|
||||
</method>
|
||||
<method name="DELETE" id="deleteServerMetadataItem">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete server metadata item">
|
||||
<para role="shortdesc">Deletes a metadata item by key for a specified server.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults; &inProgressFault;
|
||||
</method>
|
||||
<method name="DELETE" id="deleteImageMetadataItem">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete image metadata item">
|
||||
<para role="shortdesc">Deletes a metadata item by key for a specified image.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults; &inProgressFault;
|
||||
</method>
|
||||
</application>
|
||||
|
|
@ -69,9 +69,8 @@
|
|||
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 the API throws an <code>overLimit (413)</code>
|
||||
fault.
|
||||
If this operation exceeds the quota for metadata items, the
|
||||
API throws an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
|
|
@ -108,8 +107,7 @@
|
|||
the request.
|
||||
</para>
|
||||
<para>
|
||||
If this operation causes the quota for metadata items to be
|
||||
exceeded, the API throws the API throws an <code>overLimit (413)</code>
|
||||
If this operation exceeds the quota for metadata items, the API throws an <code>overLimit (413)</code>
|
||||
fault.
|
||||
</para>
|
||||
<para>
|
||||
|
|
@ -169,8 +167,7 @@
|
|||
the request.
|
||||
</para>
|
||||
<para>
|
||||
If this operation causes the quota for metadata items to be
|
||||
exceeded, the API throws the API throws an <code>overLimit (413)</code>
|
||||
If this operation exceeds the quota for metadata items, the API throws an <code>overLimit (413)</code>
|
||||
fault.
|
||||
</para>
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -161,7 +161,7 @@
|
|||
<resource_type id="ServerList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Server list">
|
||||
<para>
|
||||
A list of servers. In the list, each server element shows includes
|
||||
A list of servers. In the list, each server element includes
|
||||
its ID, name, and links attributes. Other attributes are omitted.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
|
|
@ -1626,8 +1626,8 @@
|
|||
specified in the request.
|
||||
</para>
|
||||
<para>
|
||||
If this operation causes the metadata items quota to be exceeded,
|
||||
an <code>overLimit (413)</code> fault is thrown.
|
||||
If this operation exceeds the metadata items quota,
|
||||
the API throws an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
|
@ -1681,8 +1681,8 @@
|
|||
specified in the request.
|
||||
</para>
|
||||
<para>
|
||||
If this operation causes the metadata items quota to be exceeded,
|
||||
an <code>overLimit (413)</code> fault is thrown.
|
||||
If this operation exceeds the metadata items quota,
|
||||
the API throws an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
|
@ -1736,8 +1736,8 @@
|
|||
items in the request.
|
||||
</para>
|
||||
<para>
|
||||
If this operation causes the metadata items quota to be exceeded,
|
||||
an <code>overLimit (413)</code> fault is thrown.
|
||||
If this operation exceeds the metadata items quota,
|
||||
the API throws an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
|
@ -1791,8 +1791,8 @@
|
|||
exists, this key retains its value.
|
||||
</para>
|
||||
<para>
|
||||
If this operation causes the metadata items quota to be exceeded,
|
||||
an <code>overLimit (413)</code> fault is thrown.
|
||||
If this operation exceeds the metadata items quota,
|
||||
the API throws an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
|
@ -1887,8 +1887,8 @@
|
|||
title="Create or update server metadata item">
|
||||
<para role="shortdesc">Sets a metadata item by key for a specified server.</para>
|
||||
<para>
|
||||
If this operation causes the metadata items quota to be exceeded,
|
||||
an <code>overLimit (413)</code> fault is thrown.
|
||||
If this operation exceeds the metadata items quota,
|
||||
the API throws an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
|
@ -1925,8 +1925,8 @@
|
|||
image.
|
||||
</para>
|
||||
<para>
|
||||
If this operation causes the metadata items quota to be exceeded,
|
||||
an <code>overLimit (413)</code> fault is thrown.
|
||||
If this operation exceeds the metadata items quota,
|
||||
the API throws an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
|
|
|||
Loading…
Reference in New Issue