openstack/api-site
Code Issues Proposed changes

Merge "Add note about member and member_id attributes"

Browse Source
This commit is contained in:
Jenkins 2016-01-26 01:09:12 +00:00 committed by Gerrit Code Review
commit e40e8ffe69
12 changed files with 2226 additions and 2144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

186
api-ref/src/docbkx/ch_images-v2.xml
View File

@ -10,11 +10,12 @@
<title>Image service API v2 (CURRENT)</title> <title>Image service API v2 (CURRENT)</title>
<para>Image service API v2.0, API v2.1, API v2.2, and API v2.3.</para> <para>Image service API v2.0, API v2.1, API v2.2, and API v2.3.</para>
<para> <para>
Cloud providers can configure property protections that prevent non-administrative users Cloud providers can configure property protections that prevent
from updating and deleting protected properties. For more information, see <link non-administrative users from updating and deleting protected
properties. For more information, see <link
xlink:href="http://docs.openstack.org/admin-guide-cloud/compute-images-instances.html#image-properties-and-property-protection">Image xlink:href="http://docs.openstack.org/admin-guide-cloud/compute-images-instances.html#image-properties-and-property-protection">Image
property protection</link> in the <citetitle>OpenStack Cloud Administrator property protection</link> in the <citetitle>OpenStack Cloud
Guide</citetitle>. Administrator Guide</citetitle>.
</para> </para>
<section xml:id="versions-images-v2"> <section xml:id="versions-images-v2">
<title>API versions</title> <title>API versions</title>
@ -25,7 +26,7 @@
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="images-images-v2"> <section xml:id="images-images-v2">
<title>Images</title> <title>Images (images)</title>
<para>Creates, lists, updates, and deletes images.</para> <para>Creates, lists, updates, and deletes images.</para>
<para> <para>
Image operations show all fields in the response body. Any field Image operations show all fields in the response body. Any field
@ -123,8 +124,10 @@
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="image-data-v2"> <section xml:id="image-data-v2">
<title>Image data</title> <title>Image data (images, file)</title>
<para>Uploads and downloads raw image data.</para> <para>
Uploads and downloads raw image data.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#file"> <wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#file">
<wadl:method href="#storeImageFile-v2"/> <wadl:method href="#storeImageFile-v2"/>
@ -133,8 +136,10 @@
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="image-tags-v2"> <section xml:id="image-tags-v2">
<title>Image tags</title> <title>Image tags (images, tags)</title>
<para>Adds and deletes image tags.</para> <para>
Adds and deletes image tags.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#tag"> <wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#tag">
<wadl:method href="#addImageTag-v2"/> <wadl:method href="#addImageTag-v2"/>
@ -143,7 +148,10 @@
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="members-v2"> <section xml:id="members-v2">
<title>Members</title> <title>Members (images, members)</title>
<para>
Creates, lists, updates, and deletes image members.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#Members"> <wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#Members">
<wadl:method href="#listImageMembers-v2"/> <wadl:method href="#listImageMembers-v2"/>
@ -151,172 +159,78 @@
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#member_id"> <wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#member_id">
<wadl:method href="#showImageMember-v2"/> <wadl:method href="#showImageMember-v2"/>
<wadl:method href="#deleteImageMember-v2"/>
<wadl:method href="#updateImageMember-v2"/> <wadl:method href="#updateImageMember-v2"/>
<wadl:method href="#deleteImageMember-v2"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="image-schemas-v2"> <section xml:id="image-schemas-v2">
<title>Image schemas</title> <title>Image schemas (schemas, image, images, member, members)</title>
<para>Gets a JSON-schema document that represents an images or <para>
image entity.</para> Gets a JSON-schema document that represents an images or image
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> entity.
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl#Image-schemas"> </para>
<wadl:method href="#showImagesSchema"/> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
</wadl:resource> href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl"/>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl#Image-schema">
<wadl:method href="#showImageSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl#Image-members-schema">
<wadl:method href="#showImageMembersSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl#Image-member-schema">
<wadl:method href="#showImageMemberSchema"/>
</wadl:resource>
</wadl:resources>
</section> </section>
<section xml:id="os-metadef-resourcetype-v2"> <section xml:id="os-metadef-resourcetype-v2">
<title>Metadata definition resource types (since API v2.0)</title> <title>Metadata definition resource types (since API v2.0) (metadefs, namespaces, resource_types)</title>
<para> <para>
Lists resource types. Also, creates, lists, and Lists resource types. Also, creates, lists, and removes resource
removes resource type associations in a namespace. type associations in a namespace.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl"/>
href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#resource_types">
<wadl:method href="#listResourceTypes-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#resource_types_assoc">
<wadl:method href="#createResourceTypeAssoc-v2"/>
<wadl:method href="#listResourceTypeAssocs-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#name">
<wadl:method href="#deleteResourceTypeAssoc-v2"/>
</wadl:resource>
</wadl:resources>
</section> </section>
<section xml:id="metadefs-namespaces-v2"> <section xml:id="metadefs-namespaces-v2">
<title>Metadata definition namespaces (since API v2.0)</title> <title>Metadata definition namespaces (since API v2.0) (metadefs, namespaces)</title>
<para> <para>
Creates, lists, shows details for, updates, and deletes metadata Creates, lists, shows details for, updates, and deletes metadata
definition namespaces. Defines namespaces that can contain definition namespaces. Defines namespaces that can contain
property definitions, object definitions, and resource type property definitions, object definitions, and resource type
associations. associations.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl"/>
href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl#namespaces">
<wadl:method href="#createNamespace-v2"/>
<wadl:method href="#listNamespaces-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl#namespace">
<wadl:method href="#showNamespace-v2"/>
<wadl:method href="#updateNamespace-v2"/>
<wadl:method href="#deleteNamespace-v2"/>
</wadl:resource>
</wadl:resources>
</section> </section>
<section xml:id="metadefs-namespaces-properties-v2"> <section xml:id="metadefs-namespaces-properties-v2">
<title>Metadata definition properties (since API v2.0)</title> <title>Metadata definition properties (since API v2.0) (metadefs, namespaces, properties)</title>
<para> <para>
Creates, lists, shows details for, updates, and deletes metadata Creates, lists, shows details for, updates, and deletes metadata
definition properties. definition properties.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl"/>
href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl#properties">
<wadl:method href="#createProperty-v2"/>
<wadl:method href="#listProperties-v2"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl#property_name">
<wadl:method href="#showProperty-v2"/>
<wadl:method href="#updateProperty-v2"/>
<wadl:method href="#deleteProperty-v2"/>
</wadl:resource>
</wadl:resources>
</section> </section>
<section xml:id="metadefs-namespaces-objects-v2"> <section xml:id="metadefs-namespaces-objects-v2">
<title>Metadata definition objects (since API v2.0)</title> <title>Metadata definition objects (since API v2.0) (metadefs, namespaces, objects)</title>
<para> <para>
Creates, lists, shows details for, updates, and deletes metadata Creates, lists, shows details for, updates, and deletes metadata
definition objects. definition objects.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl#objects"> href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl"/>
<wadl:method href="#createObject-v2"/>
<wadl:method href="#listObjects-v2"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl#object_name">
<wadl:method href="#showObject-v2"/>
<wadl:method href="#updateObject-v2"/>
<wadl:method href="#deleteObject-v2"/>
</wadl:resource>
</wadl:resources>
</section> </section>
<section xml:id="metadefs-namespaces-tags-v2"> <section xml:id="metadefs-namespaces-tags-v2">
<title>Metadata definition tags (since API v2.0)</title> <title>Metadata definition tags (since API v2.0) (metadefs, namespaces, tags)</title>
<para> <para>
Creates, lists, shows details for, updates, and deletes metadata Creates, lists, shows details for, updates, and deletes metadata
definition tags. definition tags.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl#tags"> href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl"/>
<wadl:method href="#createTags-v2"/>
<wadl:method href="#listTags-v2"/>
<wadl:method href="#deleteAllTags-v2"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl#tag_name">
<wadl:method href="#addTag-v2"/>
<wadl:method href="#showTag-v2"/>
<wadl:method href="#updateTag-v2"/>
<wadl:method href="#deleteTag-v2"/>
</wadl:resource>
</wadl:resources>
</section> </section>
<section xml:id="schemas-metadefs-v2"> <section xml:id="schemas-metadefs-v2">
<title>Metadata definition schemas</title> <title>Metadata definition schemas (schemas, metadefs, namespace, namespaces, object, objects, property, properties, tag, tags, resource_type, resource_types)</title>
<para> <para>
Gets a JSON-schema document that represents a metadata definition Gets a JSON-schema document that represents a metadata definition
entity. entity.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#namespace"> href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl"/>
<wadl:method href="#showMetadefNamespaceSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#namespaces">
<wadl:method href="#showMetadefNamespacesSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#object">
<wadl:method href="#showMetadefObjectSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#objects">
<wadl:method href="#showMetadefObjectsSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#property">
<wadl:method href="#showMetadefPropertySchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#properties">
<wadl:method href="#showMetadefPropertiesSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#tag">
<wadl:method href="#showMetadefTagSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#tags">
<wadl:method href="#showMetadefTagsSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#resource_type">
<wadl:method href="#showMetadefResTypeAssocSchema"/>
</wadl:resource>
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#resource_types">
<wadl:method href="#showMetadefResTypeAssocsSchema"/>
</wadl:resource>
</wadl:resources>
</section> </section>
<section xml:id="os-tasks-v2"> <section xml:id="os-tasks-v2">
<title>Tasks (since API v2.2)</title> <title>Tasks (since API v2.2) (tasks)</title>
<para> <para>
Creates, lists, and shows details for tasks. Creates, lists, and shows details for tasks.
</para> </para>

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

@ -56,7 +56,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
The date and time before which to list usage audits. Filters the response by the date and time before which to list usage audits.
</para> </para>
<para> <para>
The date and time stamp format is <link The date and time stamp format is <link
@ -82,7 +82,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
The date and time when the image or server last changed status. Filters the response by the date and time when the image or server last changed status.
</para> </para>
<para> <para>
Use this query parameter to check for changes since a previous Use this query parameter to check for changes since a previous
@ -129,7 +129,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
The date and time when the image or server was created. Filters the response by the date and time when the resource was created.
</para> </para>
<para> <para>
The date and time stamp format is <link The date and time stamp format is <link
@ -246,6 +246,36 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY updated_at-QueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated_at" 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>
Filters the response by the date and time when the resource was updated.
</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, is 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>
<para>
If you omit the <code>updated_at</code> date and time stamp, its value
is <code>null</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY updated_at-RequestParameter ' <!ENTITY updated_at-RequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated_at" style="plain" <param xmlns="http://wadl.dev.java.net/2009/02" name="updated_at" style="plain"
required="false" type="xsd:string"> required="false" type="xsd:string">
@ -618,7 +648,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para> <para>
The expiration date and time in <link Filters the response by the expiration date and time in <link
xlink:href="https://en.wikipedia.org/wiki/Unix_time">UNIX Epoch time xlink:href="https://en.wikipedia.org/wiki/Unix_time">UNIX Epoch time
stamp format</link>. stamp format</link>.
</para> </para>

2730
api-ref/src/wadls/image-api/src/v2/common.ent
View File

File diff suppressed because it is too large Load Diff

401
api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl
View File

@ -38,7 +38,7 @@
<resource id="images" type="#ImageList" path="images"> <resource id="images" type="#ImageList" path="images">
<method href="#createImage-v2"/> <method href="#createImage-v2"/>
<resource path="{image_id}" id="image_id"> <resource path="{image_id}" id="image_id">
&image_idParameter; &image_idTemplateParameter;
<method href="#showImage-v2"/> <method href="#showImage-v2"/>
<method href="#updateImage-v2"/> <method href="#updateImage-v2"/>
<method href="#deleteImage-v2"/> <method href="#deleteImage-v2"/>
@ -56,7 +56,7 @@
</resource> </resource>
<resource id="Tags" path="tags"> <resource id="Tags" path="tags">
<resource path="{tag}" id="tag"> <resource path="{tag}" id="tag">
&tagParameter; &tagTemplateParameter;
<method href="#addImageTag-v2"/> <method href="#addImageTag-v2"/>
<method href="#deleteImageTag-v2"/> <method href="#deleteImageTag-v2"/>
</resource> </resource>
@ -64,7 +64,7 @@
<resource id="Members" type="#MemberList" path="members"> <resource id="Members" type="#MemberList" path="members">
<method href="#createImageMember-v2"/> <method href="#createImageMember-v2"/>
<resource path="{member_id}" id="member_id"> <resource path="{member_id}" id="member_id">
&member_idParameter; &member_idTemplateParameter;
<method href="#showImageMember-v2"/> <method href="#showImageMember-v2"/>
<method href="#deleteImageMember-v2"/> <method href="#deleteImageMember-v2"/>
<method href="#updateImageMember-v2"/> <method href="#updateImageMember-v2"/>
@ -76,6 +76,7 @@
<method href="#createTask-v2"/> <method href="#createTask-v2"/>
<method href="#listTasks-v2"/> <method href="#listTasks-v2"/>
<resource path="{task_id}" id="task_id"> <resource path="{task_id}" id="task_id">
&task_idTemplateParameter;
<method href="#showTask-v2"/> <method href="#showTask-v2"/>
</resource> </resource>
</resource> </resource>
@ -97,8 +98,7 @@
<wadl:doc xml:lang="EN" title="List API versions" <wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc"> <para role="shortdesc">
Lists information about available Image Lists version information for all Image service API versions.
service API versions.
</para> </para>
</wadl:doc> </wadl:doc>
<response status="300"> <response status="300">
@ -114,7 +114,8 @@
<method name="GET" id="listImages-v2"> <method name="GET" id="listImages-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List images"> title="List images">
<para role="shortdesc">(Since Image API v2.0) Lists public virtual machine (VM) <para role="shortdesc">
(Since Image API v2.0) Lists public virtual machine (VM)
images. images.
</para> </para>
<para> <para>
@ -130,15 +131,14 @@
<code>marker</code> parameters. <code>marker</code> parameters.
</para> </para>
<para> <para>
The list operation accepts several query parameters. Use these The list operation accepts query parameters to filter the response.
parameters to filter the response.
</para> </para>
<para> <para>
A client can provide direct comparison filters by using most image A client can provide direct comparison filters by using most image
attributes, such as <code>name=Ubuntu</code>, attributes, such as <code>name=Ubuntu</code>,
<code>visibility=public</code>, and so on. A client cannot use <code>visibility=public</code>, and so on. A client cannot use
tags or any <code>link</code> in the json-schema, such as self, file, tags or any <code>link</code> in the json-schema, such as self,
or schema, to filter the response. file, or schema, to filter the response.
</para> </para>
<para> <para>
You can use the <code>size_min</code> and <code>size_max</code> You can use the <code>size_min</code> and <code>size_max</code>
@ -162,8 +162,8 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<code>sort_key</code>. Sorts by an image <code>sort_key</code>. Sorts by an image attribute. Sorts in
attribute. Sorts in the natural sorting direction of the image attribute. the natural sorting direction of the image attribute.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -179,18 +179,20 @@
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>To specify the <code>sort_key</code> and <para>
<code>sort_dir</code> query parameters to sort the results: To sort the response, use the <code>sort_key</code> and
<code>sort_dir</code> query parameters:
</para> </para>
<programlisting language="json">GET /v2/images?sort_key=name&amp;sort_dir=asc&amp;sort_key=status&amp;sort_dir=desc</programlisting> <programlisting language="json">GET /v2/images?sort_key=name&amp;sort_dir=asc&amp;sort_key=status&amp;sort_dir=desc</programlisting>
<para>To specify the <code>sort</code> query parameter to sort the results: <para>
Alternatively, specify the <code>sort</code> query parameter:
</para> </para>
<programlisting language="json">GET /v2/images?sort=name:asc,status:desc</programlisting> <programlisting language="json">GET /v2/images?sort=name:asc,status:desc</programlisting>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&limitMarkerReqParameter; &limitMarkerReqParameter;
&imageListReqParameters; &imageListQueryParameters;
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -200,39 +202,51 @@
<xsdxt:code <xsdxt:code
href="../samples/images-list-response.json"/> href="../samples/images-list-response.json"/>
</wadl:doc> </wadl:doc>
&imagesParameter; &statusParameter; &imagesObjectParameter;
&nameParameter; &tagsParameter; &container_formatParameter; &statusResponseParameter;
&created_at-ResponseParameter; &disk_formatParameter; &image-nameResponseParameter;
&updated_at-ResponseParameter; &min_diskParameter; &tagsObjectParameter;
&protectedParameter; &idParameter; &min_ramParameter; &container_formatResponseParameter;
&checksumParameter; &ownerParameter; &created_at-ResponseParameter;
&visibilityParameter; &virtual_sizeParameter; &disk_formatResponseParameter;
&sizeParameter; &propertiesParameter; &updated_at-ResponseParameter;
&location_urlParameter; &metadataParameter; &min_diskResponseParameter;
&direct_urlParameter; &selfParameter; &image-protectedResponseParameter;
&fileParameter; &image_schemaParameter; &idResponseParameter;
&images_schemaParameter; &min_ramResponseParameter;
&firstParameter; &checksumResponseParameter;
&owner_idResponseParameter;
&image-visibilityResponseParameter;
&virtual_sizeResponseParameter;
&sizeResponseParameter;
&image-propertiesResponseParameter;
&locationsResponseParameter;
&metadataResponseParameter;
&direct_urlResponseParameter;
&selfResponseParameter;
&fileResponseParameter;
&image-schemaResponseParameter;
&images-schemaResponseParameter;
&firstResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
<method name="POST" id="createImage-v2"> <method name="POST" id="createImage-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create image"> title="Create image">
<para role="shortdesc">(Since Image API v2.0) Creates a virtual machine (VM) <para role="shortdesc">
image. (Since Image API v2.0) Creates a virtual machine (VM) image.
</para> </para>
<para> <para>
The response includes a <code>Location</code> response header that The <code>Location</code> response header contains the URI for
contains the URI for the image. The response body contains the new the image. The response body contains the new image entity.
image entity.
</para> </para>
<para>Synchronous Postconditions</para> <para>Synchronous Postconditions</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>With correct permissions, you can see <para>
the image status as <code>queued</code> through API With correct permissions, you can see the image status as
calls. <code>queued</code> through API calls.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -244,70 +258,16 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../samples/image-create-request.json"/> <xsdxt:code href="../samples/image-create-request.json"/>
</wadl:doc> </wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" &image-nameRequestParameter;
name="name" style="plain" type="xsd:string" &idRequestParameter;
required="false"> &image-visibilityRequestParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook" &tagsRequestParameter;
xmlns:wadl="http://wadl.dev.java.net/2009/02" &container_formatRequestParameter;
xml:lang="EN"> &disk_formatRequestParameter;
<para> &min_diskRequestParameter;
Name for the image. Note that the name of an image &min_ramRequestParameter;
is not unique to an Image service node. The API &image-protectedRequestParameter;
cannot expect users to know the names of images &image-propertiesRequestParameter;
that other users own.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" type="csapi:UUID"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A unique, user-defined image UUID, in the format:
</para>
<programlisting>nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn</programlisting>
<para>
Where <emphasis>n</emphasis> is a hexadecimal digit from 0
to f, or F.
</para>
<para>
For example:
</para>
<programlisting>b2173dd3-7ad6-4362-baa6-a68bce3565cb</programlisting>
<para>
If you omit this value, the API generates a UUID for the
image.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="visibility" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Image visibility. Public or private.
Default is public.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="tags" style="plain" type="xsd:list"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Image tags.
</para>
</wadl:doc>
</param>
&container_formatRequestParameter; &disk_formatRequestParameter;
&min_diskRequestParameter; &min_ramRequestParameter;
&protectedRequestParameter; &propertiesRequestParameter;
</representation> </representation>
</request> </request>
<response status="201"> <response status="201">
@ -317,16 +277,27 @@
<xsdxt:code <xsdxt:code
href="../samples/image-create-response.json"/> href="../samples/image-create-response.json"/>
</wadl:doc> </wadl:doc>
&statusParameter; &container_formatParameter; &statusResponseParameter;
&min_ramParameter; &updated_at-ResponseParameter; &container_formatResponseParameter;
&ownerParameter; &min_diskParameter; &min_ramResponseParameter;
&tagsParameter; &visibilityParameter; &updated_at-ResponseParameter;
&idParameter; &sizeParameter; &virtual_sizeParameter; &owner_idResponseParameter;
&nameParameter; &checksumParameter; &min_diskResponseParameter;
&created_at-ResponseParameter; &disk_formatParameter; &tagsObjectParameter;
&propertiesParameter; &protectedParameter; &image-visibilityResponseParameter;
&locationParameter; &selfParameter; &idResponseParameter;
&fileParameter; &image_schemaParameter; &sizeResponseParameter;
&virtual_sizeResponseParameter;
&image-nameResponseParameter;
&checksumResponseParameter;
&created_at-ResponseParameter;
&disk_formatResponseParameter;
&image-propertiesResponseParameter;
&image-protectedResponseParameter;
&locationRequestHeader;
&selfResponseParameter;
&fileResponseParameter;
&image-schemaResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -408,8 +379,8 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The root of the target document. The value is the The root of the target document. The value is the entire
entire content of the target document. content of the target document.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -519,8 +490,11 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../samples/image-update-request.json"/> <xsdxt:code href="../samples/image-update-request.json"/>
</wadl:doc> </wadl:doc>
&pathParameter; &valueParameter; &opParameter; &pathRequestParameter;
&urlParameter; &metadataParameter; &valueRequestParameter;
&opRequestParameter;
&urlRequestParameter;
&metadataRequestParameter;
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -530,29 +504,46 @@
<xsdxt:code <xsdxt:code
href="../samples/image-update-response.json"/> href="../samples/image-update-response.json"/>
</wadl:doc> </wadl:doc>
&statusParameter; &statusResponseParameter;
&nameParameter; &tagsParameter; &container_formatParameter; &image-nameResponseParameter;
&created_at-ResponseParameter; &disk_formatParameter; &tagsObjectParameter;
&updated_at-ResponseParameter; &min_diskParameter; &container_formatResponseParameter;
&protectedParameter; &idParameter; &min_ramParameter; &created_at-ResponseParameter;
&checksumParameter; &ownerParameter; &disk_formatResponseParameter;
&visibilityParameter; &sizeParameter; &updated_at-ResponseParameter;
&location_urlParameter; &metadataParameter; &min_diskResponseParameter;
&propertiesParameter; &direct_urlParameter; &selfParameter; &image-protectedResponseParameter;
&fileParameter; &image_schemaParameter; &idResponseParameter;
&min_ramResponseParameter;
&checksumResponseParameter;
&owner_idResponseParameter;
&image-visibilityResponseParameter;
&sizeResponseParameter;
&locationsResponseParameter;
&metadataResponseParameter;
&image-propertiesResponseParameter;
&direct_urlResponseParameter;
&selfResponseParameter;
&fileResponseParameter;
&image-schemaResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
<method name="GET" id="showImage-v2"> <method name="GET" id="showImage-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show image details"> title="Show image details">
<para role="shortdesc">(Since Image API v2.0) Shows details for an image. <para role="shortdesc">
(Since Image API v2.0) Shows details for an image.
</para>
<para>
The response body contains a single image entity.
</para> </para>
<para>The response body contains a single image entity.</para>
<para>Preconditions</para> <para>Preconditions</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>The image must exist.</para> <para>
The image must exist.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</wadl:doc> </wadl:doc>
@ -563,16 +554,28 @@
<xsdxt:code <xsdxt:code
href="../samples/image-show-response.json"/> href="../samples/image-show-response.json"/>
</wadl:doc> </wadl:doc>
&statusParameter; &statusResponseParameter;
&nameParameter; &tagsParameter; &container_formatParameter; &image-nameResponseParameter;
&created_at-ResponseParameter; &disk_formatParameter; &tagsObjectParameter;
&updated_at-ResponseParameter; &min_diskParameter; &container_formatResponseParameter;
&protectedParameter; &idParameter; &min_ramParameter; &created_at-ResponseParameter;
&checksumParameter; &ownerParameter; &disk_formatResponseParameter;
&visibilityParameter; &sizeParameter; &updated_at-ResponseParameter;
&location_urlParameter; &metadataParameter; &min_diskResponseParameter;
&propertiesParameter; &direct_urlParameter; &selfParameter; &image-protectedResponseParameter;
&fileParameter; &image_schemaParameter; &idResponseParameter;
&min_ramResponseParameter;
&checksumResponseParameter;
&owner_idResponseParameter;
&image-visibilityResponseParameter;
&sizeResponseParameter;
&locationsResponseParameter;
&metadataResponseParameter;
&image-propertiesResponseParameter;
&direct_urlResponseParameter;
&selfResponseParameter;
&fileResponseParameter;
&image-schemaResponseParameter;
</representation> </representation>
</response> </response>
&fault404; &fault404;
@ -580,7 +583,8 @@
<method name="POST" id="reactivateImage-v2"> <method name="POST" id="reactivateImage-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Reactivate image"> title="Reactivate image">
<para role="shortdesc">(Since Image API v2.0) Reactivates an image. <para role="shortdesc">
(Since Image API v2.0) Reactivates an image.
</para> </para>
<para> <para>
The reactivate operation returns an error if the image status is The reactivate operation returns an error if the image status is
@ -606,7 +610,8 @@
<method name="POST" id="deactivateImage-v2"> <method name="POST" id="deactivateImage-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Deactivate image"> title="Deactivate image">
<para role="shortdesc">(Since Image API v2.0) Deactivates an image. <para role="shortdesc">
(Since Image API v2.0) Deactivates an image.
</para> </para>
<para> <para>
If you try to download a deactivated image, the call returns the If you try to download a deactivated image, the call returns the
@ -703,14 +708,15 @@
<method name="PUT" id="storeImageFile-v2"> <method name="PUT" id="storeImageFile-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Upload binary image data"> title="Upload binary image data">
<para role="shortdesc">(Since <para role="shortdesc">
Image API v2.0) Uploads binary image data. (Since Image API v2.0) Uploads binary image data.
</para> </para>
<para> <para>
Set the <code>Content-Type</code> request header to Set the <code>Content-Type</code> request header to
<code>application/octet-stream</code>. <code>application/octet-stream</code>.
</para> </para>
<para>Example call: <para>
Example call:
</para> </para>
<programlisting>curl -i -X PUT -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" \ <programlisting>curl -i -X PUT -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" \
-d @/home/glance/ubuntu-12.10.qcow2 $image_url/v2/images/{image_id}/file</programlisting> -d @/home/glance/ubuntu-12.10.qcow2 $image_url/v2/images/{image_id}/file</programlisting>
@ -731,11 +737,13 @@
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>The image status must be <code>queued</code>. <para>
The image status must be <code>queued</code>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Your image storage quota must be sufficient. <para>
Your image storage quota must be sufficient.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -748,7 +756,8 @@
<para>Synchronous Postconditions</para> <para>Synchronous Postconditions</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>With correct permissions, you can see the <para>
With correct permissions, you can see the
image status as <code>active</code> through API calls. image status as <code>active</code> through API calls.
</para> </para>
</listitem> </listitem>
@ -800,22 +809,23 @@
<para>Preconditions</para> <para>Preconditions</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>The images must exist.</para> <para>
The images must exist.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>Synchronous Postconditions</para> <para>Synchronous Postconditions</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
You can download the binary image data You can download the binary image data in your machine if
in your machine if the image has image the image has image data.
data.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If image data exists, the call returns the If image data exists, the call returns the HTTP
HTTP <code>200</code> response code. <code>200</code> response code.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -828,7 +838,7 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&Content-RangeParameter; &Content-RangeRequestHeader;
</representation> </representation>
</request> </request>
<response status="200 204"/> <response status="200 204"/>
@ -857,8 +867,11 @@
<method name="GET" id="showImageMember-v2"> <method name="GET" id="showImageMember-v2">
<wadl:doc xml:lang="EN" title="Show image member details" <wadl:doc xml:lang="EN" title="Show image member details"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">(Since Image API v2.2) Shows image member details.</para> <para role="shortdesc">
<para>Response body is a single image member entity. (Since Image API v2.2) Shows image member details.
</para>
<para>
Response body is a single image member entity.
</para> </para>
<para>Preconditions</para> <para>Preconditions</para>
<itemizedlist> <itemizedlist>
@ -881,7 +894,12 @@
href="../samples/image-member-details-response.json" href="../samples/image-member-details-response.json"
/> />
</wadl:doc> </wadl:doc>
<!-- &memberListParameter; --> &statusResponseParameter;
&created_at-ResponseParameter;
&updated_at-ResponseParameter;
&image_idResponseParameter;
&member_idResponseParameter;
&member-schemaResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -908,8 +926,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
You must be the owner or a member of You must be the owner or a member of the image.
the image.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -922,11 +939,12 @@
href="../samples/image-members-list-response.json" href="../samples/image-members-list-response.json"
/> />
</wadl:doc> </wadl:doc>
<!-- &memberListParameter; --> &membersObjectParameter;
&membersParameter; &statusParameter; &statusResponseParameter;
&created_at-ResponseParameter; &updated_at-ResponseParameter; &created_at-ResponseParameter;
&image_idParameter; &member_idParameter; &updated_at-ResponseParameter;
&member_schemaParameter; &members_schemaParameter; &member-schemaResponseParameter;
&members-schemaResponseParameter;
</representation> </representation>
</response> </response>
<response status="404"/> <response status="404"/>
@ -937,6 +955,14 @@
<para role="shortdesc"> <para role="shortdesc">
(Since Image API v2.1) Adds a tenant ID as an image member. (Since Image API v2.1) Adds a tenant ID as an image member.
</para> </para>
<para>
This call accepts either the <code>member_id</code> or
<code>member</code> attribute in the request body. If you specify
both attributes, the API uses the <code>member_id</code> value and
ignores the <code>member</code> value. Use of the
<code>member</code> attribute is supported but deprecated. Use of
the <code>member_id</code> attribute is preferred.
</para>
<para>Preconditions</para> <para>Preconditions</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -945,23 +971,21 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
You can only add a member to an image that has a You can add a member to a private image.
<code>visibility</code> attribute set to
<code>private</code>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>You must be the owner of the <para>
image. You must be the owner of the image.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>Synchronous Postconditions</para> <para>Synchronous Postconditions</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>With correct permissions, you can see <para>
the member status of the image as <code>pending</code> With correct permissions, you can see the member status of
through API calls. the image as <code>pending</code> through API calls.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -995,6 +1019,8 @@
href="../samples/image-member-create-request.json" href="../samples/image-member-create-request.json"
/> />
</wadl:doc> </wadl:doc>
&member_idRequestParameter;
&memberRequestParameter;
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -1005,7 +1031,12 @@
href="../samples/image-member-create-response.json" href="../samples/image-member-create-response.json"
/> />
</wadl:doc> </wadl:doc>
<!-- &memberListParameter; --> &created_at-ResponseParameter;
&image_idTemplateParameter;
&member_idResponseParameter;
&member-schemaResponseParameter;
&statusResponseParameter;
&updated_at-ResponseParameter;
</representation> </representation>
</response> </response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02"> <response status="403" xmlns="http://wadl.dev.java.net/2009/02">
@ -1063,17 +1094,7 @@
href="../samples/image-member-update-request.json" href="../samples/image-member-update-request.json"
/> />
</wadl:doc> </wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" &member-statusRequestParameter;
required="true" name="status" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The status of this image member.
</para>
</wadl:doc>
</param>
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -1084,7 +1105,12 @@
href="../samples/image-member-update-response.json" href="../samples/image-member-update-response.json"
/> />
</wadl:doc> </wadl:doc>
<!-- &memberListParameter; --> &created_at-ResponseParameter;
&image_idTemplateParameter;
&member_idResponseParameter;
&member-schemaResponseParameter;
&statusResponseParameter;
&updated_at-ResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -1131,7 +1157,8 @@
</itemizedlist> </itemizedlist>
</wadl:doc> </wadl:doc>
<response status="204"/> <response status="204"/>
&fault403; &fault404; &fault403;
&fault404;
</method> </method>
<method name="GET" id="listTasks-v2"> <method name="GET" id="listTasks-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
@ -1183,7 +1210,7 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&tasksShowParameters; &task_idRequestParameter;
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -1195,5 +1222,5 @@
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
</application> </application>

123
api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl
View File

@ -35,19 +35,13 @@
<resource id="v2" path="//v2"> <resource id="v2" path="//v2">
<resource id="metadefs" path="metadefs"> <resource id="metadefs" path="metadefs">
<resource id="namespaces" path="namespaces"> <resource id="namespaces" path="namespaces">
<resource path="{namespace}" id="namespace"> <resource path="{namespace_id}" id="namespace_id">
&namespace_idTemplateParameter;
<resource id="objects" type="#ObjectList" path="objects"> <resource id="objects" type="#ObjectList" path="objects">
<method href="#createObject-v2"/> <method href="#createObject-v2"/>
<method href="#listObjects-v2"/> <method href="#listObjects-v2"/>
<resource path="{object_name}" id="object_name"> <resource path="{object_name}" id="object_name">
&metadefNamespace_idParameter; &object_nameTemplateParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="object_name"
style="template" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the object.</para>
</wadl:doc>
</param>
<method href="#showObject-v2"/> <method href="#showObject-v2"/>
<method href="#updateObject-v2"/> <method href="#updateObject-v2"/>
<method href="#deleteObject-v2"/> <method href="#deleteObject-v2"/>
@ -76,80 +70,14 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../samples/metadef-object-create-request.json"/> <xsdxt:code href="../samples/metadef-object-create-request.json"/>
</wadl:doc> </wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" &namespaceRequestParameter;
name="namespace" style="plain" type="xsd:string" &display_nameRequestParameter;
required="true"> &namespace-descriptionRequestParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook" &namespace-visibilityRequestParameter;
xmlns:wadl="http://wadl.dev.java.net/2009/02" &namespace-protectedRequestParameter;
xml:lang="EN"> &namespace-propertiesRequestParameter;
<para> &objectRequestParameter;
The namespace is unique across all users. &resource_type_associationsRequestParameter;
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="display_name" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>User-friendly name to use in a UI to display the namespace name.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Detailed description for the namespace.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="visibility" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Namespace visibility. Public or private.
Default is private.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="protected" style="plain" type="xsd:boolean"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Namespace protection for deletion. Valid value is true or false.
Default is false.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="properties" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Property definitions, if any, for the namespace.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="objects" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Object definitions, if any, for the namespace.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="resource_type_associations" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Resource types, if any, that are associated with this namespace</para>
</wadl:doc>
</param>
</representation> </representation>
</request> </request>
<response status="201"> <response status="201">
@ -158,10 +86,15 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../samples/metadef-object-create-response.json"/> href="../samples/metadef-object-create-response.json"/>
</wadl:doc> &metadefNamespaceParameter; &metadefNSDisplayNameParameter; </wadl:doc>
&metadefNSDescParameter; &metadefNSVisibilityParameter; &namespaceResponseParameter;
&metadefNSProtectedParameter; &metadefPropertiesParameter; &display_nameResponseParameter;
&metadefObjectsParameter; &metadefResTypeAssocsParameter; &namespace-descriptionResponseParameter;
&namespace-visibilityResponseParameter;
&namespace-protectedResponseParameter;
&namespace-propertiesResponseParameter;
&objectsResponseParameter;
&resource_type_associationsResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -204,7 +137,8 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&metadefNamespaceListReqParameters; </representation> &metadefNamespaceListQueryParameters;
</representation>
</request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -212,10 +146,15 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../samples/metadef-objects-list-response.json"/> href="../samples/metadef-objects-list-response.json"/>
</wadl:doc> &namespacesParameter; &metadefNamespaceParameter; </wadl:doc>
&metadefNSDisplayNameParameter; &metadefNSDescParameter; &namespacesObjectParameter;
&metadefNSVisibilityParameter; &metadefNSProtectedParameter; &namespaceResponseParameter;
&metadefResTypeAssocsParameter; </representation> &display_nameResponseParameter;
&namespace-descriptionResponseParameter;
&namespace-visibilityResponseParameter;
&namespace-protectedResponseParameter;
&resource_type_associationsResponseParameter;
</representation>
</response> </response>
</method> </method>
<method name="GET" id="showObject-v2"> <method name="GET" id="showObject-v2">

382
api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl
View File

@ -35,12 +35,14 @@
<resource id="v2" path="//v2"> <resource id="v2" path="//v2">
<resource id="metadefs" path="metadefs"> <resource id="metadefs" path="metadefs">
<resource id="namespaces" path="namespaces"> <resource id="namespaces" path="namespaces">
<resource path="{namespace}" id="namespace"> <resource path="{namespace_id}" id="namespace">
&namespace_idTemplateParameter;
<resource id="properties" type="#PropertyList" <resource id="properties" type="#PropertyList"
path="properties"> path="properties">
<method href="#createProperty-v2"/> <method href="#createProperty-v2"/>
<method href="#listProperties-v2"/> <method href="#listProperties-v2"/>
<resource path="{property_name}" id="property_name"> <resource path="{property_name}" id="property_name">
&property_nameTemplateParameter;
<method href="#showProperty-v2"/> <method href="#showProperty-v2"/>
<method href="#updateProperty-v2"/> <method href="#updateProperty-v2"/>
<method href="#deleteProperty-v2"/> <method href="#deleteProperty-v2"/>
@ -72,17 +74,24 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../samples/metadef-property-create-request.json"/> <xsdxt:code href="../samples/metadef-property-create-request.json"/>
</wadl:doc> </wadl:doc>
&metadefPropertyNameParameter; &property-nameResponseParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter; &titleResponseParameter;
&metadefPropertyEnumOptionalParameter; &metadefPropertyItemsOptionalParameter; &typeResponseParameter;
&metadefPropertyDescOptionalParameter; &metadefPropertyOperOptionalParameter; &enumRequestParameter;
&metadefPropertyDfltOptionalParameter; &metadefPropertyReadOptionalParameter; &itemsRequestParameter;
&metadefPropertyMinOptionalParameter; &property-descriptionRequestParameter;
&metadefPropertyMaxOptionalParameter; &metadefPropertyMinLengthOptionalParameter; &operatorsRequestParameter;
&metadefPropertyMaxLengthOptionalParameter; &metadefPropertyPatternOptionalParameter; &defaultRequestParameter;
&metadefPropertyMinItemsOptionalParameter; &metadefPropertyMaxItemsOptionalParameter; &readonlyRequestParameter;
&metadefPropertyUniqueItemsOptionalParameter; &minimumRequestParameter;
&metadefPropertyAdditionalItemsOptionalParameter; &maximumRequestParameter;
&minLengthRequestParameter;
&maxLengthRequestParameter;
&patternRequestParameter;
&minItemsRequestParameter;
&maxItemsRequestParameter;
&uniqueItemsRequestParameter;
&additionalItemsRequestParameter;
</representation> </representation>
</request> </request>
<response status="201"> <response status="201">
@ -91,17 +100,25 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../samples/metadef-property-create-response.json"/> href="../samples/metadef-property-create-response.json"/>
</wadl:doc> &metadefPropertyNameParameter; </wadl:doc>
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter; &property-nameResponseParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter; &titleResponseParameter;
&metadefPropertyDescParameter; &metadefPropertyOperParameter; &typeResponseParameter;
&metadefPropertyDfltParameter; &metadefPropertyReadParameter; &enumResponseParameter;
&metadefPropertyMinParameter; &itemsResponseParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; &property-descriptionResponseParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; &operatorsResponseParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; &defaultResponseParameter;
&metadefPropertyUniqueItemsParameter; &readonlyResponseParameter;
&metadefPropertyAdditionalItemsParameter; &minimumResponseParameter;
&maximumResponseParameter;
&minLengthResponseParameter;
&maxLengthResponseParameter;
&patternResponseParameter;
&minItemsResponseParameter;
&maxItemsResponseParameter;
&uniqueItemsResponseParameter;
&additionalItemsResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -112,28 +129,32 @@
Lists property definitions in a namespace. Lists property definitions in a namespace.
</para> </para>
</wadl:doc> </wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespace_idParameter;</representation>
</request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../samples/metadef-properties-list-response.json"/> href="../samples/metadef-properties-list-response.json"/>
</wadl:doc> &metadefPropertyListParameter; </wadl:doc>
&metadefPropertyNameParameter; &propertiesObjectParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter; &property-nameResponseParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter; &titleResponseParameter;
&metadefPropertyDescParameter; &metadefPropertyOperParameter; &typeResponseParameter;
&metadefPropertyDfltParameter; &metadefPropertyReadParameter; &enumResponseParameter;
&metadefPropertyMinParameter; &itemsResponseParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; &property-descriptionResponseParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; &operatorsResponseParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; &defaultResponseParameter;
&metadefPropertyUniqueItemsParameter; &readonlyResponseParameter;
&metadefPropertyAdditionalItemsParameter; &minimumResponseParameter;
&maximumResponseParameter;
&minLengthResponseParameter;
&maxLengthResponseParameter;
&patternResponseParameter;
&minItemsResponseParameter;
&maxItemsResponseParameter;
&uniqueItemsResponseParameter;
&additionalItemsResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -156,26 +177,9 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&metadefNamespace_idParameter; &property_nameRequestParameter;
&metadefPropertyNameIdParameter; &resource_typeQueryParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="resource_type" </representation>
style="query" required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Filter parameter.
</para>
<para>
Shows only property names that start with a prefix
from an associated resource type.
</para>
<para>
The API removes the prefix of the resource type
from the property name in the response.
</para>
</wadl:doc>
</param>
</representation>
</request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -184,17 +188,24 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-property-details-response.json"/> href="../samples/metadef-property-details-response.json"/>
</wadl:doc> </wadl:doc>
&metadefPropertyNameParameter; &property-nameResponseParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter; &titleResponseParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter; &typeResponseParameter;
&metadefPropertyDescParameter; &metadefPropertyOperParameter; &enumResponseParameter;
&metadefPropertyDfltParameter; &metadefPropertyReadParameter; &itemsResponseParameter;
&metadefPropertyMinParameter; &property-descriptionResponseParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; &operatorsResponseParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; &defaultResponseParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; &readonlyResponseParameter;
&metadefPropertyUniqueItemsParameter; &minimumResponseParameter;
&metadefPropertyAdditionalItemsParameter; &maximumResponseParameter;
&minLengthResponseParameter;
&maxLengthResponseParameter;
&patternResponseParameter;
&minItemsResponseParameter;
&maxItemsResponseParameter;
&uniqueItemsResponseParameter;
&additionalItemsResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -212,183 +223,24 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../samples/metadef-property-create-request.json"/> <xsdxt:code href="../samples/metadef-property-create-request.json"/>
</wadl:doc> </wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" &property_nameRequestParameter;
name="name" style="plain" type="xsd:string" &titleRequestParameter;
required="true"> &typeRequestParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook" &enumRequestParameter;
xmlns:wadl="http://wadl.dev.java.net/2009/02" &itemsRequestParameter;
xml:lang="EN"><para>Name of the property. &property-descriptionRequestParameter;
</para></wadl:doc> &operatorsRequestParameter;
</param> &defaultRequestParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" &readonlyRequestParameter;
name="title" style="plain" type="xsd:string" &minimumRequestParameter;
required="true"> &maximumRequestParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook" &minLengthRequestParameter;
xmlns:wadl="http://wadl.dev.java.net/2009/02" &maxLengthRequestParameter;
xml:lang="EN"><para>Property title. &patternRequestParameter;
</para></wadl:doc> &minItemsRequestParameter;
</param> &maxItemsRequestParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" &uniqueItemsRequestParameter;
name="type" style="plain" type="xsd:string" &additionalItemsRequestParameter;
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Property type
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="enum" style="plain" type="xsd:list"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Enumeration of property values.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="items" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>specifies schema for the items in an
array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="operators" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Operators property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="default" style="plain" type="xsd:base64Binary"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Default property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="readonly" style="plain" type="xsd:boolean"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Indicates whether this is a read-only property.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minimum" style="plain" type="xsd:int"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum allowed numerical value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maximum" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum allowed numerical value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minLength" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum allowed string length.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxLength" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum allowed string length.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="pattern" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A regular expression (ECMA 262) that
a string value must match.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum length of an array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum length of an array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uniqueItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>whether all the values in the array
must be distinct.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="additionalItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
If you use <i>tuple-typing</i>, describes extra
items. If the value of <code>items</code> is an
array and the instance is longer than the list of
schema in <code>items</code>, the schema in this
property describes the additional items.
</para>
<para>
If this value is false, the instance cannot be
longer than the number of schemas that are listed in
<code>items</code>.
</para>
<para>
A value of true indicates an empty schema, or
anything goes.
</para>
</wadl:doc>
</param>
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -398,17 +250,24 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-property-update-response.json"/> href="../samples/metadef-property-update-response.json"/>
</wadl:doc> </wadl:doc>
&metadefPropertyNameParameter; &property-nameResponseParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter; &titleResponseParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter; &typeResponseParameter;
&metadefPropertyDescParameter; &metadefPropertyOperParameter; &enumResponseParameter;
&metadefPropertyDfltParameter; &metadefPropertyReadParameter; &itemsResponseParameter;
&metadefPropertyMinParameter; &property-descriptionResponseParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter; &operatorsResponseParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter; &defaultResponseParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter; &readonlyResponseParameter;
&metadefPropertyUniqueItemsParameter; &minimumResponseParameter;
&metadefPropertyAdditionalItemsParameter; &maximumResponseParameter;
&minLengthResponseParameter;
&maxLengthResponseParameter;
&patternResponseParameter;
&minItemsResponseParameter;
&maxItemsResponseParameter;
&uniqueItemsResponseParameter;
&additionalItemsResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -416,8 +275,7 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Remove property definition"> title="Remove property definition">
<para role="shortdesc"> <para role="shortdesc">
Removes a property definition in a Removes a property definition in a namespace.
namespace.
</para> </para>
<para> <para>
To remove a property, first make an update namespace request To remove a property, first make an update namespace request
@ -434,8 +292,8 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&metadefNamespace_idParameter; &property_nameRequestParameter;
&metadefPropertyNameIdParameter; </representation> </representation>
</request> </request>
<response status="204"/> <response status="204"/>
<response status="403"/> <response status="403"/>

57
api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl
View File

@ -35,12 +35,14 @@
<resource id="v2" path="//v2"> <resource id="v2" path="//v2">
<resource id="metadefs" path="metadefs"> <resource id="metadefs" path="metadefs">
<resource id="namespaces" path="namespaces"> <resource id="namespaces" path="namespaces">
<resource path="{namespace}" id="namespace"> <resource id="tags" type="#TagList" path="tags">
<resource id="tags" type="#TagList" path="tags"> <resource path="{namespace_id}" id="namespace_id">
&namespace_idTemplateParameter;
<method href="#createTags-v2"/> <method href="#createTags-v2"/>
<method href="#listTags-v2"/> <method href="#listTags-v2"/>
<method href="#deleteAllTags-v2"/> <method href="#deleteAllTags-v2"/>
<resource path="{name}" id="tag_name"> <resource path="{tag_name}" id="tag_name">
&tag_nameTemplateParameter;
<method href="#addTag-v2"/> <method href="#addTag-v2"/>
<method href="#showTag-v2"/> <method href="#showTag-v2"/>
<method href="#updateTag-v2"/> <method href="#updateTag-v2"/>
@ -70,9 +72,9 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-tag-create-request.json"/> href="../samples/metadef-tag-create-request.json"/>
</wadl:doc> </wadl:doc>
&metadefNamespaceParameter; &namespaceResponseParameter;
&metadefTagsParameter; &tagsObjectParameter;
&metadefTagNameParameter; &tag-nameResponseParameter;
</representation> </representation>
</request> </request>
<response status="201"> <response status="201">
@ -82,8 +84,8 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-tag-create-response.json"/> href="../samples/metadef-tag-create-response.json"/>
</wadl:doc> </wadl:doc>
&metadefTagsParameter; &tagsObjectParameter;
&metadefTagNameParameter; &tag-nameResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -102,9 +104,10 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&metadefNamespaceParameter; &namespaceResponseParameter;
&limitMarkerReqParameter; &limitMarkerReqParameter;
&metadefTagListSortParameters; </representation> &metadefTagListQueryParameters;
</representation>
</request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -113,8 +116,8 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-tags-list-response.json"/> href="../samples/metadef-tags-list-response.json"/>
</wadl:doc> </wadl:doc>
&metadefTagsParameter; &tagsObjectParameter;
&metadefTagNameParameter; &tag-nameResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -137,7 +140,7 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&metadefNamespaceParameter; &namespaceResponseParameter;
</representation> </representation>
</request> </request>
<response status="204"/> <response status="204"/>
@ -150,19 +153,14 @@
Adds a tag to the list of namespace tag definitions. Adds a tag to the list of namespace tag definitions.
</para> </para>
</wadl:doc> </wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespaceParameter;
&metadefTagNameParameter;
</representation>
</request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../samples/metadef-tag-add-response.json"/> href="../samples/metadef-tag-add-response.json"/>
</wadl:doc> &metadefTagNameParameter; </wadl:doc>
&tag-nameResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -174,19 +172,14 @@
</para> </para>
<para>The response body shows a single tag entity.</para> <para>The response body shows a single tag entity.</para>
</wadl:doc> </wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespaceParameter;
&metadefTagNameParameter;
</representation>
</request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../samples/metadef-tag-details-response.json"/> href="../samples/metadef-tag-details-response.json"/>
</wadl:doc> &metadefTagNameParameter; </wadl:doc>
&tag-nameResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -203,8 +196,6 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../samples/metadef-tag-update-request.json"/> <xsdxt:code href="../samples/metadef-tag-update-request.json"/>
</wadl:doc> </wadl:doc>
&metadefNamespaceParameter;
&metadefTagNameParameter;
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -214,7 +205,7 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-tag-update-response.json"/> href="../samples/metadef-tag-update-response.json"/>
</wadl:doc> </wadl:doc>
&metadefTagNameParameter; &tag-nameResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -235,12 +226,6 @@
The response is empty and returns the HTTP 204 status code. The response is empty and returns the HTTP 204 status code.
</para> </para>
</wadl:doc> </wadl:doc>
<request>
<representation mediaType="application/json">
&metadefNamespaceParameter;
&metadefTagNameParameter;
</representation>
</request>
<response status="204"/> <response status="204"/>
<response status="403"/> <response status="403"/>
</method> </method>

202
api-ref/src/wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl
View File

@ -37,17 +37,8 @@
<resource id="namespaces" type="#NamespaceList" path="namespaces"> <resource id="namespaces" type="#NamespaceList" path="namespaces">
<method href="#createNamespace-v2"/> <method href="#createNamespace-v2"/>
<method href="#listNamespaces-v2"/> <method href="#listNamespaces-v2"/>
<resource path="{namespace}" id="namespace"> <resource path="{namespace_id}" id="namespace_id">
<param xmlns="http://wadl.dev.java.net/2009/02" &namespace_idTemplateParameter;
name="namespace" style="template" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Unique namespace.
</para>
</wadl:doc>
</param>
<method href="#showNamespace-v2"/> <method href="#showNamespace-v2"/>
<method href="#updateNamespace-v2"/> <method href="#updateNamespace-v2"/>
<method href="#deleteNamespace-v2"/> <method href="#deleteNamespace-v2"/>
@ -78,98 +69,14 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../samples/metadef-namespace-create-request.json"/> <xsdxt:code href="../samples/metadef-namespace-create-request.json"/>
</wadl:doc> </wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" <!-- &namespaceRequestParameter;
name="namespace" style="plain" type="xsd:string" &display_nameRequestParameter;
required="true"> &namespace-descriptionRequestParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook" &namespace-visibilityRequestParameter;
xmlns:wadl="http://wadl.dev.java.net/2009/02" &namespace-protectedRequestParameter;
xml:lang="EN"> &propertiesRequestParameter;
<para> &objectsRequestParameter;
A namespace name that is unique across all users. &resource_type_associationsRequestParameter; -->
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="display_name" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
User-friendly name that you can use in the UI to
display the namespace name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Detailed description for the namespace.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="visibility" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Namespace visibility. Valid value is public or
private. Default is private.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="protected" style="plain" type="xsd:boolean"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Namespace protection for deletion. Valid value is
true or false. Default is false.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="properties" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more property definitions in the namespace.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="objects" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more object definitions in the namespace.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="resource_type_associations" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more resource types that are associated
with this namespace.
</para>
</wadl:doc>
</param>
</representation> </representation>
</request> </request>
<response status="201"> <response status="201">
@ -179,10 +86,14 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-namespace-create-response.json"/> href="../samples/metadef-namespace-create-response.json"/>
</wadl:doc> </wadl:doc>
&metadefNamespaceParameter; &metadefNSDisplayNameParameter; &namespaceResponseParameter;
&metadefNSDescParameter; &metadefNSVisibilityParameter; &display_nameResponseParameter;
&metadefNSProtectedParameter; &metadefPropertiesParameter; &namespace-descriptionResponseParameter;
&metadefObjectsParameter; &metadefResTypeAssocsParameter; &namespace-visibilityResponseParameter;
&namespace-protectedResponseParameter;
&namespace-propertiesResponseParameter;
&objectsResponseParameter;
&resource_type_associationsResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -219,47 +130,10 @@
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
&limitMarkerReqParameter; &limitMarkerReqParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="visibility" &visibilityQueryParameter;
style="query" required="false" type="imageapi:string"> &resource_typesQueryParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook" &sort_keyQueryParameter;
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> &sort_dirQueryParameter;
<para>Filter parameter. Namespace visibility. Valid values are
<code>public</code> and <code>private</code>.
Default is <code>public</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="resource_types"
style="query" required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Filter parameter. Specify this value as comma-separated list. For
example, send the <code>resource_types</code> filter of
<code>OS::Glance::Image,OS::Nova::Flavor</code> to filter the namespaces
by those resource types.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_key"
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>Sort key. Use attributes like <code>namespace</code>
for sorting. Default is <code>created_at</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_dir"
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>Sort direction. Valid values are <code>asc</code>
(ascending) and <code>desc</code> (descending). Default is
<code>desc</code>.
</para>
</wadl:doc>
</param>
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -269,10 +143,13 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-namespaces-list-response.json"/> href="../samples/metadef-namespaces-list-response.json"/>
</wadl:doc> </wadl:doc>
&namespacesParameter; &metadefNamespaceParameter; &namespacesObjectParameter;
&metadefNSDisplayNameParameter; &metadefNSDescParameter; &namespaceResponseParameter;
&metadefNSVisibilityParameter; &metadefNSProtectedParameter; &display_nameResponseParameter;
&metadefResTypeAssocsParameter; &namespace-descriptionResponseParameter;
&namespace-visibilityResponseParameter;
&namespace-protectedResponseParameter;
&resource_type_associationsResponseParameter;
</representation> </representation>
</response> </response>
</method> </method>
@ -300,7 +177,9 @@
<method name="PUT" id="updateNamespace-v2"> <method name="PUT" id="updateNamespace-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update namespace"> title="Update namespace">
<para role="shortdesc">Updates a namespace.</para> <para role="shortdesc">
Updates a namespace.
</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -308,7 +187,6 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../samples/metadef-namespace-update-request.json"/> <xsdxt:code href="../samples/metadef-namespace-update-request.json"/>
</wadl:doc> </wadl:doc>
&metadefNamespace_idParameter;
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
@ -325,13 +203,13 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete namespace"> title="Delete namespace">
<para role="shortdesc"> <para role="shortdesc">
Deletes a namespace and its properties, Deletes a namespace and its properties, objects, and any
objects, and any resource type associations. resource type associations.
</para> </para>
<para> <para>
You cannot delete namespaces with the <code>protected</code> You cannot delete namespaces with the <code>protected</code>
attribute set to true (boolean); the response returns the HTTP attribute set to <code>true</code> (boolean); the response returns the HTTP
403 status code. <code>403</code> response code.
</para> </para>
<para> <para>
To delete a namespace, you must first make an update namespace To delete a namespace, you must first make an update namespace
@ -339,14 +217,14 @@
(boolean) on the namespace. Then, delete the namespace. (boolean) on the namespace. Then, delete the namespace.
</para> </para>
<para> <para>
If the operation succeeds, the response returns the HTTP 204 A successful operation returns the HTTP <code>204</code>
status code. response code.
</para> </para>
<para> <para>
If you try to remove a namespace with the If you try to remove a namespace with the
<code>protected</code> attribute set to true (boolean), the <code>protected</code> attribute set to true (boolean), the
operation fails and the response returns the HTTP 403 error operation fails and the response returns the HTTP
code. <code>403</code> response code.
</para> </para>
</wadl:doc> </wadl:doc>
<response status="204"/> <response status="204"/>

85
api-ref/src/wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl
View File

@ -34,34 +34,17 @@
xml:id="os-metadef-resourcetype-v2"> xml:id="os-metadef-resourcetype-v2">
<resource id="v2" path="//v2"> <resource id="v2" path="//v2">
<resource id="metadefs" path="metadefs"> <resource id="metadefs" path="metadefs">
<resource id="resource_types" type="#ResourceTypeList" <resource id="resource_types" type="#ResourceTypeList" path="resource_types">
path="resource_types">
<method href="#listResourceTypes-v2"/> <method href="#listResourceTypes-v2"/>
</resource> </resource>
<resource id="namespaces" path="namespaces"> <resource id="namespaces" path="namespaces">
<resource path="{namespace}" id="namespace"> <resource path="{namespace_id}" id="namespace_id">
<resource id="resource_types_assoc" type="#ResourceTypeAssocList" &namespace_idTemplateParameter;
path="resource_types"> <resource id="resource_types_assoc" type="#ResourceTypeAssocList" path="resource_types">
<param xmlns="http://wadl.dev.java.net/2009/02"
name="namespace" style="template" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Unique namespace.
</para>
</wadl:doc>
</param>
<method href="#createResourceTypeAssoc-v2"/> <method href="#createResourceTypeAssoc-v2"/>
<method href="#listResourceTypeAssocs-v2"/> <method href="#listResourceTypeAssocs-v2"/>
<resource path="{name}" id="name"> <resource path="{name}" id="name">
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" &resource-type-nameTemplateParameter;
style="template" required="true" 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 resource type.</para>
</wadl:doc>
</param>
<method href="#deleteResourceTypeAssoc-v2"/> <method href="#deleteResourceTypeAssoc-v2"/>
</resource> </resource>
</resource> </resource>
@ -77,8 +60,9 @@
<method name="POST" id="createResourceTypeAssoc-v2"> <method name="POST" id="createResourceTypeAssoc-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create resource type association"> title="Create resource type association">
<para role="shortdesc">Creates a resource type association <para role="shortdesc">
in a namespace.</para> Creates a resource type association in a namespace.
</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json" <representation mediaType="application/json"
@ -88,46 +72,9 @@
<xsdxt:code <xsdxt:code
href="../samples/metadef-resource-type-create-request.json"/> href="../samples/metadef-resource-type-create-request.json"/>
</wadl:doc> </wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" &resource-type-nameRequestParameter;
name="name" style="plain" type="xsd:string" &prefixRequestParameter;
required="true"> &properties_targetRequestParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Name of the resource type.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="prefix" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Prefix for any properties in the namespace that
you want to apply to the resource type. If you
specify a prefix, you must append a prefix
separator, such as the colon (<code>:</code>)
character.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="properties_target" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Some resource types allow more than one key and
value pair for each instance. For example, the
Image service allows both user and image metadata
on volumes. The <code>properties_target</code>
parameter enables a namespace target to remove the
ambiguity.
</para>
</wadl:doc>
</param>
</representation> </representation>
</request> </request>
<response status="201"> <response status="201">
@ -143,11 +90,13 @@
<method name="GET" id="listResourceTypes-v2"> <method name="GET" id="listResourceTypes-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List resource types"> title="List resource types">
<para role="shortdesc">Lists resource types.</para> <para role="shortdesc">
Lists all resource types.
</para>
<para> <para>
Lists all possible resource types. You can assign metadata You can assign metadata definition namespaces to these
definition namespaces to these resource types. See the resource types. See the metadata definition resource types
metadata definition resource types section. section.
</para> </para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">

70
api-ref/src/wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl
View File

@ -39,61 +39,49 @@
<resource id="v2" path="//v2"> <resource id="v2" path="//v2">
<resource id="schemas" path="schemas"> <resource id="schemas" path="schemas">
<resource id="metadefs" path="metadefs"> <resource id="metadefs" path="metadefs">
<resource id="namespace" type="#SchemaList" <resource id="namespace" type="#SchemaList" path="namespace">
path="namespace">
<method href="#showMetadefNamespaceSchema"/> <method href="#showMetadefNamespaceSchema"/>
</resource> </resource>
<resource id="namespaces" type="#SchemaList" <resource id="namespaces" type="#SchemaList" path="namespaces">
path="namespaces">
<method href="#showMetadefNamespacesSchema"/> <method href="#showMetadefNamespacesSchema"/>
</resource> </resource>
<resource id="object" type="#SchemaList" <resource id="object" type="#SchemaList" path="object">
path="object">
<method href="#showMetadefObjectSchema"/> <method href="#showMetadefObjectSchema"/>
</resource> </resource>
<resource id="objects" type="#SchemaList" <resource id="objects" type="#SchemaList" path="objects">
path="objects">
<method href="#showMetadefObjectsSchema"/> <method href="#showMetadefObjectsSchema"/>
</resource> </resource>
<resource id="property" type="#SchemaList" <resource id="property" type="#SchemaList" path="property">
path="property">
<method href="#showMetadefPropertySchema"/> <method href="#showMetadefPropertySchema"/>
</resource> </resource>
<resource id="properties" type="#SchemaList" <resource id="properties" type="#SchemaList" path="properties">
path="properties">
<method href="#showMetadefPropertiesSchema"/> <method href="#showMetadefPropertiesSchema"/>
</resource> </resource>
<resource id="tag" type="#SchemaList" <resource id="tag" type="#SchemaList" path="tag">
path="tag">
<method href="#showMetadefTagSchema"/> <method href="#showMetadefTagSchema"/>
</resource> </resource>
<resource id="tags" type="#SchemaList" <resource id="tags" type="#SchemaList" path="tags">
path="tags">
<method href="#showMetadefTagsSchema"/> <method href="#showMetadefTagsSchema"/>
</resource> </resource>
<resource id="resource_type" type="#SchemaList" <resource id="resource_type" type="#SchemaList" path="resource_type">
path="resource_type">
<method href="#showMetadefResTypeAssocSchema"/> <method href="#showMetadefResTypeAssocSchema"/>
</resource> </resource>
<resource id="resource_types" type="#SchemaList" <resource id="resource_types" type="#SchemaList" path="resource_types">
path="resource_types">
<method href="#showMetadefResTypeAssocsSchema"/> <method href="#showMetadefResTypeAssocsSchema"/>
</resource> </resource>
</resource> </resource>
</resource> </resource>
</resource> </resource>
</resources> </resources>
<!--*******************************************************--> <!--*******************************************************-->
<!-- All Methods --> <!-- All Methods -->
<!--*******************************************************--> <!--*******************************************************-->
<method name="GET" id="showMetadefNamespaceSchema"> <method name="GET" id="showMetadefNamespaceSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition namespace schema"> title="Show metadata definition namespace schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents
definition namespace entity. (Since API v2.1.) a metadata definition namespace entity.
</para> </para>
<para> <para>
The following schema document is an example. The authoritative The following schema document is an example. The authoritative
@ -115,8 +103,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition namespaces schema"> title="Show metadata definition namespaces schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition namespaces entity. (Since API v2.1.) definition namespaces entity.
</para> </para>
<para> <para>
A namespaces entity is a container for namespace entities. A namespaces entity is a container for namespace entities.
@ -141,8 +129,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition object schema"> title="Show metadata definition object schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition object entity. (Since API v2.1.) definition object entity.
</para> </para>
<para> <para>
The following schema document is an example. The authoritative The following schema document is an example. The authoritative
@ -164,8 +152,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition objects schema"> title="Show metadata definition objects schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition objects entity. (Since API v2.1.) definition objects entity.
</para> </para>
<para> <para>
An objects entity is a container for object entities. An objects entity is a container for object entities.
@ -190,8 +178,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition property schema"> title="Show metadata definition property schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition property entity. (Since API v2.1.) definition property entity.
</para> </para>
<para> <para>
The following schema document is an example. The authoritative The following schema document is an example. The authoritative
@ -213,8 +201,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition properties schema"> title="Show metadata definition properties schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition properties entity. (Since API v2.1.) definition properties entity.
</para> </para>
<para> <para>
A properties entity is a container for property entities. A properties entity is a container for property entities.
@ -239,8 +227,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition tag schema"> title="Show metadata definition tag schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition tag entity. (Since API v2.1.) definition tag entity.
</para> </para>
<para> <para>
The following schema document is an example. The authoritative The following schema document is an example. The authoritative
@ -262,8 +250,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition tags schema"> title="Show metadata definition tags schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition tags entity. (Since API v2.1.) definition tags entity.
</para> </para>
<para> <para>
A tags entity is a container for tag entities. A tags entity is a container for tag entities.
@ -288,9 +276,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition namespace resource type association schema"> title="Show metadata definition namespace resource type association schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition namespace resource type association entity. definition namespace resource type association entity.
(Since API v2.1.)
</para> </para>
<para> <para>
The following schema document is an example. The authoritative The following schema document is an example. The authoritative
@ -312,9 +299,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show metadata definition namespace resource type associations schema"> title="Show metadata definition namespace resource type associations schema">
<para role="shortdesc"> <para role="shortdesc">
Shows a JSON schema document that represents a metadata (Since API v2.1) Shows a JSON schema document that represents a metadata
definition namespace resource type associations entity. definition namespace resource type associations entity.
(Since API v2.1.)
</para> </para>
<para> <para>
A resource type associations entity is a container for A resource type associations entity is a container for

83
api-ref/src/wadls/image-api/src/v2/wadl/schemas-v2.wadl
View File

@ -27,50 +27,45 @@
<include href="../xsd/api.xsd"/> <include href="../xsd/api.xsd"/>
<include href="../xsd/api-common.xsd"/> <include href="../xsd/api-common.xsd"/>
</grammars> </grammars>
<!--*******************************************************--> <!--*******************************************************-->
<!-- All Resources --> <!-- All Resources -->
<!--*******************************************************--> <!--*******************************************************-->
<resources base="https://glance.example.com/" <resources base="https://glance.example.com/"
xml:id="os-image-schemas-v2"> xml:id="os-image-schemas-v2">
<resource id="info" path="//v2"> <resource id="info" path="//v2">
<resource id="schemas" path="schemas"> <resource id="schemas" path="schemas">
<resource id="Image-schemas" type="#SchemasList" <resource id="Image-schemas" type="#SchemasList" path="images">
path="images">
<method href="#showImagesSchema"/> <method href="#showImagesSchema"/>
</resource> </resource>
<resource id="Image-schema" type="#SchemaList" <resource id="Image-schema" type="#SchemaList" path="image">
path="image">
<method href="#showImageSchema"/> <method href="#showImageSchema"/>
</resource> </resource>
<resource id="Image-members-schema" <resource id="Image-members-schema" type="#SchemasList" path="members">
type="#SchemasList" path="members">
<method href="#showImageMembersSchema"/> <method href="#showImageMembersSchema"/>
</resource> </resource>
<resource id="Image-member-schema" type="#SchemaList" <resource id="Image-member-schema" type="#SchemaList" path="member">
path="member">
<method href="#showImageMemberSchema"/> <method href="#showImageMemberSchema"/>
</resource> </resource>
</resource> </resource>
</resource> </resource>
</resources> </resources>
<!--*******************************************************--> <!--*******************************************************-->
<!-- All Methods --> <!-- All Methods -->
<!--*******************************************************--> <!--*******************************************************-->
<method name="GET" id="showImagesSchema"> <method name="GET" id="showImagesSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show images schema"> title="Show images schema">
<para role="shortdesc">Shows a JSON schema document that <para role="shortdesc">
represents an images entity. (Since Images (Since Images v2.0) Shows a JSON schema document that
v2.0.)</para> represents an images entity.
<para>An images entity is a container of image </para>
entities.</para> <para>
<para>The following schema is solely an example. Consider An images entity is a container of image entities.
only the response to the API call as </para>
authoritative.</para> <para>
The following schema is solely an example. Consider only the
response to the API call as authoritative.
</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -86,12 +81,14 @@
<method name="GET" id="showImageSchema"> <method name="GET" id="showImageSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show image schema"> title="Show image schema">
<para role="shortdesc">Shows a JSON schema document that <para role="shortdesc">
represents an image entity. (Since Images (Since Images v2.0) Shows a JSON schema document that
v2.0.)</para> represents an image entity.
<para>The following schema is solely an example. Consider </para>
only the response to the API call as <para>
authoritative.</para> The following schema is solely an example. Consider only the
response to the API call as authoritative.
</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -107,14 +104,18 @@
<method name="GET" id="showImageMembersSchema"> <method name="GET" id="showImageMembersSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show image members schema"> title="Show image members schema">
<para role="shortdesc">Shows a JSON schema document that <para role="shortdesc">
represents an image members entity. (Since Images (Since Images v2.1) Shows a JSON schema document that
v2.1.)</para> represents an image members entity.
<para>An image members entity is a container of image </para>
member entities.</para> <para>
<para>The following schema is solely an example. Consider An image members entity is a container of image member
only the response to the API call as entities.
authoritative.</para> </para>
<para>
The following schema is solely an example. Consider only the
response to the API call as authoritative.
</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -130,12 +131,14 @@
<method name="GET" id="showImageMemberSchema"> <method name="GET" id="showImageMemberSchema">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show image member schema"> title="Show image member schema">
<para role="shortdesc">Shows a JSON schema document that <para role="shortdesc">
represents an image member entity. (Since Images (Since Images v2.1) Shows a JSON schema document that
v2.1.)</para> represents an image member entity.
<para>The following schema is solely an example. Consider </para>
only the response to the API call as <para>
authoritative.</para> The following schema is solely an example. Consider only the
response to the API call as authoritative.
</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">

13
api-ref/src/wadls/volume-api/src/common.ent
View File

@ -2174,6 +2174,8 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
&availability_zoneResponseParameter;
&created_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true" name="name" style="plain" required="true"
type="xsd:string"> type="xsd:string">
@ -2411,6 +2413,7 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
&created_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="multiattach" style="plain" name="multiattach" style="plain"
type="xsd:boolean" required="true"> type="xsd:boolean" required="true">
@ -2535,10 +2538,12 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" &created_at-ResponseParameter;
name="links" style="plain" type="xsd:dict" required="true"> <param xmlns="http://wadl.dev.java.net/2009/02" name="metadata" style="plain" type="dict"
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" required="true">
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para> <para>
The volume links. The volume links.
</para> </para>