Merge "Update Image service API v1 and v2 to spellcheck and make other changes"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
91700b92fb
@ -12,27 +12,26 @@
|
||||
assigns metadata to images.</para>
|
||||
<para>Some cloud implementations do not expose this API and offer
|
||||
pretested images only.</para>
|
||||
<para>Cloud providers can configure property protections that
|
||||
prevent 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 property protection</link> in the
|
||||
<citetitle>OpenStack Cloud Administrator
|
||||
Guide</citetitle>.</para>
|
||||
<para>
|
||||
Cloud providers can configure property protections that prevent 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 property protection</link> in the
|
||||
<citetitle>OpenStack Cloud Administrator Guide</citetitle>.
|
||||
</para>
|
||||
<section xml:id="versions-v1">
|
||||
<title>API versions</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#versions">
|
||||
href="../wadls/image-api/src/v1/wadl/images-v1.wadl#versions">
|
||||
<wadl:method href="#listVersions-image-null-v1"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#versionspath">
|
||||
href="../wadls/image-api/src/v1/wadl/images-v1.wadl#versionspath">
|
||||
<wadl:method href="#listVersions-image-v1"/>
|
||||
</wadl:resource>
|
||||
<!-- need to get a valid response for this one -->
|
||||
<!-- <wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#version">
|
||||
href="../wadls/image-api/src/v1/wadl/images-v1.wadl#version">
|
||||
<wadl:method href="#showVersionDetails-image-v1"/>
|
||||
</wadl:resource>-->
|
||||
</wadl:resources>
|
||||
@ -40,19 +39,14 @@
|
||||
<section xml:id="images-v1">
|
||||
<title>Images</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#Images">
|
||||
<wadl:method href="#listImage-v1"/>
|
||||
<wadl:resource href="../wadls/image-api/src/v1/wadl/images-v1.wadl#Images">
|
||||
<wadl:method href="#listImages-v1"/>
|
||||
<wadl:method href="#createImage-v1"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#detail">
|
||||
<wadl:method href="#listDetailImage-v1"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#image_id">
|
||||
<wadl:method href="#getImage-v1"/>
|
||||
<!-- <wadl:method href="#getImage-v1Headers"/>-->
|
||||
<wadl:resource href="../wadls/image-api/src/v1/wadl/images-v1.wadl#detail"/>
|
||||
<wadl:resource href="../wadls/image-api/src/v1/wadl/images-v1.wadl#image_id">
|
||||
<wadl:method href="#showImage-v1"/>
|
||||
<wadl:method href="#showImageHeaders-v1"/>
|
||||
<wadl:method href="#updateImage-v1"/>
|
||||
<wadl:method href="#deleteImage-v1"/>
|
||||
</wadl:resource>
|
||||
@ -61,12 +55,10 @@
|
||||
<section xml:id="members-v1">
|
||||
<title>Members</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#members">
|
||||
<wadl:resource href="../wadls/image-api/src/v1/wadl/images-v1.wadl#members">
|
||||
<wadl:method href="#replaceMember-v1"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#owner-id">
|
||||
<wadl:resource href="../wadls/image-api/src/v1/wadl/images-v1.wadl#owner-id">
|
||||
<wadl:method href="#addMember-v1"/>
|
||||
<wadl:method href="#removeMember-v1"/>
|
||||
</wadl:resource>
|
||||
@ -75,9 +67,8 @@
|
||||
<section xml:id="shared_images_v1">
|
||||
<title>Shared images</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v1/os-image-1.0.wadl#owner-2">
|
||||
<wadl:method href="#getSharedImages-v1"/>
|
||||
<wadl:resource href="../wadls/image-api/src/v1/wadl/images-v1.wadl#owner-2">
|
||||
<wadl:method href="#listSharedImages-v1"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
@ -10,22 +10,16 @@
|
||||
<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>
|
||||
Cloud providers can configure property protections that prevent
|
||||
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 property
|
||||
protection</link> in the <citetitle>OpenStack Cloud Administrator
|
||||
Cloud providers can configure property protections that prevent 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
|
||||
property protection</link> in the <citetitle>OpenStack Cloud Administrator
|
||||
Guide</citetitle>.
|
||||
</para>
|
||||
<section xml:id="versions-images-v2">
|
||||
<title>API versions</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#versions">
|
||||
<wadl:method href="#listVersions-image-null-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#versionspath">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#versions">
|
||||
<wadl:method href="#listVersions-image-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
@ -57,7 +51,7 @@
|
||||
<td>
|
||||
<para>
|
||||
The Image service reserved an image ID for the
|
||||
image in the registry but has not uploaded any
|
||||
image in the registry but did not yet upload any
|
||||
image data.
|
||||
</para>
|
||||
</td>
|
||||
@ -84,7 +78,7 @@
|
||||
<td><para>killed</para></td>
|
||||
<td>
|
||||
<para>
|
||||
An error occurred during the upload of image data.
|
||||
An image data upload error occurred.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
@ -111,23 +105,18 @@
|
||||
</table>
|
||||
<para></para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#Images">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#images">
|
||||
<wadl:method href="#createImage-v2"/>
|
||||
<wadl:method href="#listImages-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#image_id">
|
||||
<wadl:method href="#getImage-v2"/>
|
||||
<wadl:method href="#updateImage-v2"/>
|
||||
<wadl:method href="#deleteImage-v2"/>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#image_id">
|
||||
<wadl:method href="#showImage-v2"/>
|
||||
<wadl:method href="#updateImage-v2"/>
|
||||
<wadl:method href="#deleteImage-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#reactivate">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#reactivate">
|
||||
<wadl:method href="#reactivateImage-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#deactivate">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#deactivate">
|
||||
<wadl:method href="#deactivateImage-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
@ -136,10 +125,9 @@
|
||||
<title>Image data</title>
|
||||
<para>Uploads and downloads raw image data.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#file">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#file">
|
||||
<wadl:method href="#storeImageFile-v2"/>
|
||||
<wadl:method href="#getImageFile-v2"/>
|
||||
<wadl:method href="#showImageFile-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
@ -147,8 +135,7 @@
|
||||
<title>Image tags</title>
|
||||
<para>Adds and deletes image tags.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#tag">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#tag">
|
||||
<wadl:method href="#addImageTag-v2"/>
|
||||
<wadl:method href="#deleteImageTag-v2"/>
|
||||
</wadl:resource>
|
||||
@ -157,14 +144,11 @@
|
||||
<section xml:id="members-v2">
|
||||
<title>Members</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#Members">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#Members">
|
||||
<wadl:method href="#createImageMember-v2"/>
|
||||
<wadl:method href="#listImageMembers-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#member_id">
|
||||
<wadl:method href="#getImageMember-v2"/>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#member_id">
|
||||
<wadl:method href="#showImageMember-v2"/>
|
||||
<wadl:method href="#deleteImageMember-v2"/>
|
||||
<wadl:method href="#updateImageMember-v2"/>
|
||||
</wadl:resource>
|
||||
@ -175,25 +159,21 @@
|
||||
<para>Gets a JSON-schema document that represents an images or
|
||||
image entity.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-schemas">
|
||||
<wadl:method href="#getImagesSchema"/>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl#Image-schemas">
|
||||
<wadl:method href="#showImagesSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-schema">
|
||||
<wadl:method href="#getImageSchema"/>
|
||||
<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/os-image-schemas-v2.wadl#Image-members-schema">
|
||||
<wadl:method href="#getImageMembersSchema"/>
|
||||
<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/os-image-schemas-v2.wadl#Image-member-schema">
|
||||
<wadl:method href="#getImageMemberSchema"/>
|
||||
<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 xml:id="os-metadef-resourcetype-v2">
|
||||
<section xml:id="os-metadef-resourcetype-v2">
|
||||
<title>Metadata definition resource types (since API v2.0)</title>
|
||||
<para>
|
||||
Lists resource types. Also, creates, lists, and
|
||||
@ -201,161 +181,151 @@
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-metadef-resourcetype-v2.wadl#resource_types">
|
||||
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/os-metadef-resourcetype-v2.wadl#resource_types_assoc">
|
||||
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/os-metadef-resourcetype-v2.wadl#name">
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#name">
|
||||
<wadl:method href="#deleteResourceTypeAssoc-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-metadef-namespace-v2">
|
||||
<section xml:id="metadefs-namespaces-v2">
|
||||
<title>Metadata definition namespaces (since API v2.0)</title>
|
||||
<para>
|
||||
Creates, lists, gets details for, updates, and
|
||||
deletes metadata definition namespaces. Defines namespaces that can contain
|
||||
property definitions, object definitions, and resource type associations.
|
||||
Creates, lists, shows details for, updates, and deletes metadata
|
||||
definition namespaces. Defines namespaces that can contain
|
||||
property definitions, object definitions, and resource type
|
||||
associations.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-metadef-namespace-v2.wadl#namespaces">
|
||||
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/os-metadef-namespace-v2.wadl#namespace">
|
||||
<wadl:method href="#getNamespace-v2"/>
|
||||
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 xml:id="os-metadef-property-v2.wadl">
|
||||
<section xml:id="metadefs-namespaces-properties-v2">
|
||||
<title>Metadata definition properties (since API v2.0)</title>
|
||||
<para>
|
||||
Creates, lists, gets details for, updates, and
|
||||
deletes metadata definition properties.
|
||||
Creates, lists, shows details for, updates, and deletes metadata
|
||||
definition properties.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-metadef-property-v2.wadl#properties">
|
||||
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/os-metadef-property-v2.wadl#property_name">
|
||||
<wadl:method href="#getProperty-v2"/>
|
||||
<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 xml:id="os-metadef-object-v2">
|
||||
<section xml:id="metadefs-namespaces-objects-v2">
|
||||
<title>Metadata definition objects (since API v2.0)</title>
|
||||
<para>
|
||||
Creates, lists, gets details for, updates, and deletes metadata
|
||||
Creates, lists, shows details for, updates, and deletes metadata
|
||||
definition objects.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/os-metadef-object-v2.wadl#objects">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl#objects">
|
||||
<wadl:method href="#createObject-v2"/>
|
||||
<wadl:method href="#listObjects-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/os-metadef-object-v2.wadl#object_name">
|
||||
<wadl:method href="#getObject-v2"/>
|
||||
<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 xml:id="os-metadef-tag-v2">
|
||||
<section xml:id="metadefs-namespaces-tags-v2">
|
||||
<title>Metadata definition tags (since API v2.0)</title>
|
||||
<para>
|
||||
Creates, lists, gets details for, updates, and deletes metadata
|
||||
Creates, lists, shows details for, updates, and deletes metadata
|
||||
definition tags.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/os-metadef-tag-v2.wadl#tags">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl#tags">
|
||||
<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/os-metadef-tag-v2.wadl#tag_name">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl#tag_name">
|
||||
<wadl:method href="#addTag-v2"/>
|
||||
<wadl:method href="#getTag-v2"/>
|
||||
<wadl:method href="#showTag-v2"/>
|
||||
<wadl:method href="#updateTag-v2"/>
|
||||
<wadl:method href="#deleteTag-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-metadef-schemas-v2">
|
||||
<section xml:id="schemas-metadefs-v2">
|
||||
<title>Metadata definition schemas</title>
|
||||
<para>
|
||||
Gets a JSON-schema document that represents a metadata definition
|
||||
entity.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#namespace">
|
||||
<wadl:method href="#getMetadefNamespaceSchema"/>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#namespace">
|
||||
<wadl:method href="#showMetadefNamespaceSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-metadef-schemas-v2.wadl#namespaces">
|
||||
<wadl:method href="#getMetadefNamespacesSchema"/>
|
||||
<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/os-metadef-schemas-v2.wadl#object">
|
||||
<wadl:method href="#getMetadefObjectSchema"/>
|
||||
<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/os-metadef-schemas-v2.wadl#objects">
|
||||
<wadl:method href="#getMetadefObjectsSchema"/>
|
||||
<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/os-metadef-schemas-v2.wadl#property">
|
||||
<wadl:method href="#getMetadefPropertySchema"/>
|
||||
<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/os-metadef-schemas-v2.wadl#properties">
|
||||
<wadl:method href="#getMetadefPropertiesSchema"/>
|
||||
<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/os-metadef-schemas-v2.wadl#tag">
|
||||
<wadl:method href="#getMetadefTagSchema"/>
|
||||
<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/os-metadef-schemas-v2.wadl#tags">
|
||||
<wadl:method href="#getMetadefTagsSchema"/>
|
||||
<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/os-metadef-schemas-v2.wadl#resource_type">
|
||||
<wadl:method href="#getMetadefResTypeAssocSchema"/>
|
||||
<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/os-metadef-schemas-v2.wadl#resource_types">
|
||||
<wadl:method href="#getMetadefResTypeAssocsSchema"/>
|
||||
<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 xml:id="os-tasks-v2">
|
||||
<title>Tasks (since API v2.2)</title>
|
||||
<para>
|
||||
Creates, lists, and gets details for tasks.
|
||||
Creates, lists, and shows details for tasks.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#Tasks">
|
||||
<wadl:method href="#createTasks-v2"/>
|
||||
href="../wadls/image-api/src/v2/wadl/images-v2.wadl#Tasks">
|
||||
<wadl:method href="#createTask-v2"/>
|
||||
<wadl:method href="#listTasks-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#task_id">
|
||||
<wadl:method href="#showTasks-v2"/>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#task_id">
|
||||
<wadl:method href="#showTask-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
{
|
||||
"key": "value"
|
||||
}
|
||||
}
|
||||
@ -316,8 +316,8 @@
|
||||
<code>false</code>.
|
||||
</para>
|
||||
<para>
|
||||
The owner ID, which is the tenant ID, is
|
||||
specified in the request URI.
|
||||
Specify the owner ID, which is the tenant ID, is
|
||||
in the request URI.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
|
||||
@ -3,14 +3,14 @@
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-image-1.0.wadl -->
|
||||
<!-- xmllint -noent images-v1.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
@ -23,8 +23,8 @@
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v1.0">
|
||||
<grammars>
|
||||
<include href="../v2/xsd/api.xsd"/>
|
||||
<include href="../v2/xsd/api-common.xsd"/>
|
||||
<include href="../../v2/xsd/api.xsd"/>
|
||||
<include href="../../v2/xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
@ -44,8 +44,8 @@
|
||||
id="detail"/>
|
||||
<resource path="{image_id}" id="image_id">
|
||||
&image_idRequestParameter;
|
||||
<method href="#getImage-v1"/>
|
||||
<method href="#getImageHeaders-v1"/>
|
||||
<method href="#showImage-v1"/>
|
||||
<method href="#showImageHeaders-v1"/>
|
||||
<method href="#updateImage-v1"/>
|
||||
<method href="#deleteImage-v1"/>
|
||||
<resource id="members" path="members">
|
||||
@ -61,7 +61,7 @@
|
||||
<resource id="shared-images" path="shared-images">
|
||||
<resource path="{owner_id}" id="owner-2">
|
||||
&owner_idRequestParameter;
|
||||
<method href="#getSharedImages-v1"/>
|
||||
<method href="#listSharedImages-v1"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -70,16 +70,18 @@
|
||||
<!-- Resource Types -->
|
||||
<!--*******************************************************-->
|
||||
<resource_type id="ImageList">
|
||||
<method href="#listImage-v1"/>
|
||||
<method href="#listImages-v1"/>
|
||||
</resource_type>
|
||||
<resource_type id="DetailImageList">
|
||||
<method href="#listDetailImage-v1"/>
|
||||
<method href="#listImagesDetailed-v1"/>
|
||||
</resource_type>
|
||||
<resource_type id="VersionDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Version details">
|
||||
<para>Details for a version.</para>
|
||||
<para>
|
||||
Details for a version.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<method href="#showVersionDetails-image-v1"/>
|
||||
</resource_type>
|
||||
@ -89,9 +91,10 @@
|
||||
<method name="GET" id="listVersions-image-null-v1">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List API versions"><para
|
||||
role="shortdesc">Lists information about available Image
|
||||
service API versions.</para>
|
||||
xml:lang="EN" title="List API versions">
|
||||
<para role="shortdesc">
|
||||
Lists information about all Image service API versions.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="300">
|
||||
<representation mediaType="application/json">
|
||||
@ -99,7 +102,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="samples/image-versions-response.json"/>
|
||||
href="../samples/image-versions-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -107,9 +110,10 @@
|
||||
<method name="GET" id="listVersions-image-v1">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List API versions"><para
|
||||
role="shortdesc">Lists information about available Image
|
||||
service API versions.</para>
|
||||
xml:lang="EN" title="List API versions">
|
||||
<para role="shortdesc">
|
||||
Shows details for the Image service API v1.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -117,7 +121,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="samples/image-versions-response.json"/>
|
||||
href="../samples/image-versions-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -126,8 +130,9 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Create image">
|
||||
<para role="shortdesc">Registers a virtual machine (VM)
|
||||
image.</para>
|
||||
<para role="shortdesc">
|
||||
Registers a virtual machine (VM) image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json"
|
||||
@ -138,11 +143,12 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Images name">
|
||||
<para>Name for the image. Note that the name
|
||||
of an image is not unique to a Glance
|
||||
node. The API cannot expect users to know
|
||||
the names of images owned by
|
||||
others.</para>
|
||||
<para>
|
||||
Name for the image. Note that the name of an image
|
||||
is not unique to an Image service node. The API
|
||||
cannot expect users to know the names of images
|
||||
that other users own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&disk_formatRequestParameter;
|
||||
@ -162,8 +168,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Image Location">
|
||||
<para>A location for the image identified by a
|
||||
URI.</para>
|
||||
<para>A URI location for the image.</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#createImage" rel="self"/>
|
||||
</param>
|
||||
@ -191,7 +196,7 @@
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getImage-v1">
|
||||
<method name="GET" id="showImage-v1">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show image details and image binary">
|
||||
@ -206,7 +211,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code href="samples/imagedetails.json"/>
|
||||
<xsdxt:code href="../samples/images-list-details-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -220,13 +225,13 @@
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="GET" id="getSharedImages-v1">
|
||||
<method name="GET" id="listSharedImages-v1">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List shared images">
|
||||
<para role="shortdesc">
|
||||
Lists the VM images that are shared with an owner.
|
||||
The owner ID is the tenant ID.
|
||||
Lists the VM images that an owner shares. The owner ID is the
|
||||
tenant ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -240,16 +245,16 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code href="samples/shared-images.json"/>
|
||||
<xsdxt:code href="../samples/shared-images-list-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="listImage-v1">
|
||||
<method name="GET" id="listImages-v1">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List images">
|
||||
<para role="shortdesc">Lists public VM images.</para>
|
||||
<para role="shortdesc">Lists all public VM images.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
@ -263,17 +268,17 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code href="samples/imagelist.json"/>
|
||||
<xsdxt:code href="../samples/images-list-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="listDetailImage-v1">
|
||||
<method name="GET" id="listImagesDetailed-v1">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List image details">
|
||||
<para role="shortdesc">Lists details for available
|
||||
images.</para>
|
||||
xml:lang="EN" title="List images with details">
|
||||
<para role="shortdesc">Lists all available
|
||||
images with details.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
@ -311,7 +316,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code href="samples/imagedetails.json"/>
|
||||
<xsdxt:code href="../samples/images-list-details-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -319,8 +324,10 @@
|
||||
<method name="PUT" id="addMember-v1">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Add member">
|
||||
<para role="shortdesc">Adds a member to an image.</para>
|
||||
xml:lang="EN" title="Add members to image">
|
||||
<para role="shortdesc">
|
||||
Adds one or more members to an image.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the request body, this call adds the membership to
|
||||
the image, leaves the existing memberships unmodified, and
|
||||
@ -334,7 +341,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code href="samples/imagememberships.json"/>
|
||||
<xsdxt:code href="../samples/image-members-add-request.json"/>
|
||||
</wadl:doc>
|
||||
&can_shareRequestParameter;
|
||||
</representation>
|
||||
@ -345,8 +352,9 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Replace member">
|
||||
<para role="shortdesc">Replaces a membership list for an
|
||||
image.</para>
|
||||
<para role="shortdesc">
|
||||
Replaces a membership list for an image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json"
|
||||
@ -354,7 +362,7 @@
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="memberships" style="plain" required="true"/>
|
||||
&can_shareRequestParameter;
|
||||
<xsdxt:code href="samples/imagemembershiplist.json"/>
|
||||
<xsdxt:code href="../samples/image-members-add-request.json"/>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="204"/>
|
||||
@ -371,12 +379,14 @@
|
||||
element="image">
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="member_id" style="plain" required="true"
|
||||
type="csapi:uuid">
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>ID of member with which an image is
|
||||
shared.</para>
|
||||
<para>
|
||||
The UUID of the member with which an image is
|
||||
shared.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
</representation>
|
||||
@ -105,12 +105,10 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
Filter parameter.
|
||||
Filters the response by a tenant ID.
|
||||
</para>
|
||||
<para>
|
||||
Shows only images that are shared with this owner.
|
||||
</para>
|
||||
<para>A valid value is a tenant ID.
|
||||
Shows only images that are shared with this tenant owner.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -292,15 +290,15 @@
|
||||
</param>'>
|
||||
<!ENTITY idParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="id"
|
||||
style="plain" required="true" type="csapi:uuid">
|
||||
style="plain" required="true" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The unique ID for the image.</para>
|
||||
<para>The UUID of the image.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY min_ramParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="min_ram"
|
||||
style="plain" required="true" type="csapi:uuid">
|
||||
style="plain" required="true" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The minimum amount of RAM in MB that is required to boot the image.</para>
|
||||
@ -373,12 +371,12 @@
|
||||
</param>'>
|
||||
<!ENTITY image_idParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="image_id"
|
||||
style="template" type="csapi:uuid" required="true">
|
||||
style="template" type="csapi:UUID" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
||||
title="Image ID">
|
||||
title="Image UUID">
|
||||
<para>
|
||||
Image ID stored through the image API. Typically a UUID.
|
||||
The UUID of the image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -745,7 +743,7 @@
|
||||
</param>'>
|
||||
<!ENTITY metadefNamespace_idParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="namespace"
|
||||
style="template" type="csapi:uuid" required="true">
|
||||
style="template" type="csapi:UUID" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
||||
title="Namespace">
|
||||
@ -1257,10 +1255,10 @@
|
||||
</param>'>
|
||||
<!ENTITY tasksShowParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="task_id"
|
||||
style="plain" required="true" type="csapi:uuid" default="ALL">
|
||||
style="plain" required="true" type="csapi:UUID" default="ALL">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The task ID.
|
||||
<para>The UUID of the task.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
|
||||
@ -12,4 +12,4 @@
|
||||
"beefy"
|
||||
]
|
||||
}
|
||||
]
|
||||
]
|
||||
@ -1,17 +0,0 @@
|
||||
{
|
||||
"resource_type_associations": [
|
||||
{
|
||||
"created_at": "2014-09-19T16:13:33Z",
|
||||
"name": "OS::Glance::Image",
|
||||
"prefix": "hw_",
|
||||
"updated_at": "2014-09-19T16:13:33Z"
|
||||
},
|
||||
{
|
||||
"created_at": "2014-09-19T16:09:13Z",
|
||||
"name": "OS::Cinder::Volume",
|
||||
"prefix": "hw_",
|
||||
"properties_target": "image",
|
||||
"updated_at": "2014-09-19T16:09:13Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,67 +0,0 @@
|
||||
{
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"links": [
|
||||
{
|
||||
"href": "{self}",
|
||||
"rel": "self"
|
||||
},
|
||||
{
|
||||
"href": "{file}",
|
||||
"rel": "enclosure"
|
||||
},
|
||||
{
|
||||
"href": "{schema}",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"name": "image",
|
||||
"properties": {
|
||||
"checksum": {
|
||||
"type": "string"
|
||||
},
|
||||
"created_at": {
|
||||
"type": "string"
|
||||
},
|
||||
"file": {
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"protected": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"self": {
|
||||
"type": "string"
|
||||
},
|
||||
"size": {
|
||||
"type": "integer"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
},
|
||||
"tags": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"updated_at": {
|
||||
"type": "string"
|
||||
},
|
||||
"visibility": {
|
||||
"enum": [
|
||||
"public",
|
||||
"private"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -5,12 +5,12 @@
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-image-v2.wadl -->
|
||||
<!-- xmllint -noent images-v2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -24,25 +24,22 @@
|
||||
xmlns:imageapi="http://docs.openstack.org/image/api/v2"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v2">
|
||||
<grammars>
|
||||
<include href="xsd/api.xsd"/>
|
||||
<include href="xsd/api-common.xsd"/>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
<!--*******************************************************-->
|
||||
<resources base="https://glance.example.com/" xml:id="os-image-v2">
|
||||
<resource id="versions" path="/">
|
||||
<method href="#listVersions-image-null-v2"/>
|
||||
<resource id="versionspath" path="versions">
|
||||
<method href="#listVersions-image-v2"/>
|
||||
</resource>
|
||||
<resource id="versions" path="//">
|
||||
<method href="#listVersions-image-v2"/>
|
||||
</resource>
|
||||
<resource id="version" path="//v2">
|
||||
<resource id="Images" type="#ImageList" path="images">
|
||||
<resource id="images" type="#ImageList" path="images">
|
||||
<method href="#createImage-v2"/>
|
||||
<resource path="{image_id}" id="image_id">
|
||||
&image_idParameter;
|
||||
<method href="#getImage-v2"/>
|
||||
<method href="#showImage-v2"/>
|
||||
<method href="#updateImage-v2"/>
|
||||
<method href="#deleteImage-v2"/>
|
||||
<resource id="actions" path="actions">
|
||||
@ -55,7 +52,7 @@
|
||||
</resource>
|
||||
<resource id="file" path="file">
|
||||
<method href="#storeImageFile-v2"/>
|
||||
<method href="#getImageFile-v2"/>
|
||||
<method href="#showImageFile-v2"/>
|
||||
</resource>
|
||||
<resource id="Tags" path="tags">
|
||||
<resource path="{tag}" id="tag">
|
||||
@ -69,7 +66,7 @@
|
||||
<method href="#createImageMember-v2"/>
|
||||
<resource path="{member_id}" id="member_id">
|
||||
&member_idParameter;
|
||||
<method href="#getImageMember-v2"/>
|
||||
<method href="#showImageMember-v2"/>
|
||||
<method href="#deleteImageMember-v2"/>
|
||||
<method href="#updateImageMember-v2"/>
|
||||
</resource>
|
||||
@ -77,10 +74,10 @@
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="Tasks" path="tasks">
|
||||
<method href="#createTasks-v2"/>
|
||||
<method href="#createTask-v2"/>
|
||||
<method href="#listTasks-v2"/>
|
||||
<resource path="{task_id}" id="task_id">
|
||||
<method href="#showTasks-v2"/>
|
||||
<method href="#showTask-v2"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -97,36 +94,19 @@
|
||||
<!--*******************************************************-->
|
||||
<!-- All Methods -->
|
||||
<!--*******************************************************-->
|
||||
<method name="GET" id="listVersions-image-null-v2">
|
||||
<method name="GET" id="listVersions-image-v2">
|
||||
<wadl:doc xml:lang="EN" title="List API versions"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists information about available Image
|
||||
<para role="shortdesc">
|
||||
Lists information about available Image
|
||||
service API versions.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="300">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="samples/image-versions-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="listVersions-image-v2">
|
||||
<wadl:doc xml:lang="EN" title="List API versions"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists information about available Image
|
||||
service API versions.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="samples/image-versions-response.json"/>
|
||||
href="../samples/image-versions-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -151,27 +131,27 @@
|
||||
<code>marker</code> parameters.
|
||||
</para>
|
||||
<para>
|
||||
The list operation accepts several types of query parameters that
|
||||
let you filter the results of the returned collection.
|
||||
The list operation accepts several query parameters. Use these
|
||||
parameters to filter the response.
|
||||
</para>
|
||||
<para>
|
||||
A client can provide direct comparison filters using most image
|
||||
A client can provide direct comparison filters by using most image
|
||||
attributes, such as <code>name=Ubuntu</code>,
|
||||
<code>visibility=public</code>, and so on. A client cannot filter
|
||||
on tags or anything defined as a <code>link</code> in the json-
|
||||
schema, such as self, file, or schema.
|
||||
<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,
|
||||
or schema, to filter the response.
|
||||
</para>
|
||||
<para>
|
||||
You can use the <code>size_min</code> and <code>size_max</code>
|
||||
query parameters to perform greater-than and less-than filtering
|
||||
of images based on their <code>size</code> attribute. The size is
|
||||
measured in bytes and refers to the size of an image when it is
|
||||
stored on disk.
|
||||
query parameters to filter images that are greater than or less
|
||||
than the image size. The size, in bytes, is the size of an image
|
||||
on disk.
|
||||
</para>
|
||||
<para>
|
||||
For example, sending a <code>size_min</code> filter of 1048576 and
|
||||
<code>size_max</code> of 4194304 filters the container to include
|
||||
only images that are between 1 and 4 MB.
|
||||
For example, to filter the container to include only images that
|
||||
are from 1 to 4 MB, set the <code>size_min</code> query
|
||||
parameter to <code>1048576</code> and the <code>size_max</code>
|
||||
query parameter to <code>4194304</code>.
|
||||
</para>
|
||||
<para>
|
||||
You can list VM images that have a status of <code>active</code>,
|
||||
@ -183,9 +163,8 @@
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>sort_key</code>. Sorts by the requested image
|
||||
attribute. Sorts in the natural sorting direction of the image attribute that
|
||||
is provided as the <code>sort_key</code>.
|
||||
<code>sort_key</code>. Sorts by an image
|
||||
attribute. Sorts in the natural sorting direction of the image attribute.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -204,10 +183,10 @@
|
||||
<para>To specify the <code>sort_key</code> and
|
||||
<code>sort_dir</code> query parameters to sort the results:
|
||||
</para>
|
||||
<programlisting language="json">GET /v2/images?sort_key=name&sort_dir=asc&sort_key=status&sort_dir=desc</programlisting>
|
||||
<programlisting language="json">GET /v2/images?sort_key=name&sort_dir=asc&sort_key=status&sort_dir=desc</programlisting>
|
||||
<para>To specify the <code>sort</code> query parameter to sort the results:
|
||||
</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>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -220,7 +199,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-list-response.json"/>
|
||||
href="../samples/images-list-response.json"/>
|
||||
</wadl:doc>
|
||||
&imagesParameter; &statusParameter;
|
||||
&nameParameter; &tagsParameter; &container_formatParameter;
|
||||
@ -244,9 +223,10 @@
|
||||
<para role="shortdesc">(Since Image API v2.0) Creates a virtual machine (VM)
|
||||
image.
|
||||
</para>
|
||||
<para>Created with a <code>Location</code> header that
|
||||
contains the newly-created URI for the image. Response
|
||||
body represents the created image entity.
|
||||
<para>
|
||||
The response includes a <code>Location</code> response header that
|
||||
contains the URI for the image. The response body contains the new
|
||||
image entity.
|
||||
</para>
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
@ -257,10 +237,10 @@
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>With correct permissions, you can see
|
||||
the image status as <code>active</code> through API
|
||||
calls if you created the image with
|
||||
<code>Location</code> header.
|
||||
<para>
|
||||
If you create the image with the <code>Location</code>
|
||||
header and you have correct permissions, you can use API
|
||||
calls to see the image status as <code>active</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -270,7 +250,7 @@
|
||||
element="image">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/image-create-req.json"/>
|
||||
<xsdxt:code href="../samples/image-create-request.json"/>
|
||||
</wadl:doc>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" type="xsd:string"
|
||||
@ -279,14 +259,15 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Name for the image. The name of an image is not unique to an
|
||||
Image service node. The API cannot expect users to know the
|
||||
names of images owned by others.
|
||||
Name for the image. Note that the name of an image
|
||||
is not unique to an Image service node. The API
|
||||
cannot expect users to know the names of images
|
||||
that other users own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" type="csapi:uuid"
|
||||
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"
|
||||
@ -339,7 +320,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-create-response.json"/>
|
||||
href="../samples/image-create-response.json"/>
|
||||
</wadl:doc>
|
||||
&statusParameter; &container_formatParameter;
|
||||
&min_ramParameter; &updated_at-ResponseParameter;
|
||||
@ -384,7 +365,7 @@
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
A new value is inserted into the array at the index.
|
||||
The API inserts a new value into the array at the index.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
@ -396,7 +377,7 @@
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
A new member is added to the object.
|
||||
The API adds a member to the object.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
@ -438,19 +419,20 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
A member to add to an object. The value is added to that
|
||||
object at that location. If the member already exists, it is
|
||||
replaced by the value.
|
||||
A member value to add to an object. The API adds the value
|
||||
to the object at the location. If the member already exists,
|
||||
the API replaces it with the value.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
An element to add to the array. The value is added to the
|
||||
array at the location. Any element that is at or above the
|
||||
index is shifted one position to the right. The index must
|
||||
not be greater than the number of elements in the array. If
|
||||
you use the hyphen (-) character to index the end of the
|
||||
array, the value is appended to the array. See <link
|
||||
An element to add to the array. The API adds the element
|
||||
value to the array at the location. The API shifts any
|
||||
element that is at or above the index one position to the
|
||||
right. The index must not be greater than the number of
|
||||
elements in the array. If you use the hyphen (-) character
|
||||
to index the end of the array, the API appends the value to
|
||||
the array. See <link
|
||||
xlink:href="http://tools.ietf.org/html/rfc6901">JavaScript
|
||||
Object Notation (JSON) Pointer</link>.
|
||||
</para>
|
||||
@ -538,7 +520,7 @@
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/image-update-req.json"/>
|
||||
<xsdxt:code href="../samples/image-update-request.json"/>
|
||||
</wadl:doc>
|
||||
&pathParameter; &valueParameter; &opParameter;
|
||||
&urlParameter; &metadataParameter;
|
||||
@ -549,7 +531,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-update-response.json"/>
|
||||
href="../samples/image-update-response.json"/>
|
||||
</wadl:doc>
|
||||
&statusParameter;
|
||||
&nameParameter; &tagsParameter; &container_formatParameter;
|
||||
@ -564,7 +546,7 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getImage-v2">
|
||||
<method name="GET" id="showImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show image details">
|
||||
<para role="shortdesc">(Since Image API v2.0) Shows details for an image.
|
||||
@ -582,7 +564,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-details-response.json"/>
|
||||
href="../samples/image-show-response.json"/>
|
||||
</wadl:doc>
|
||||
&statusParameter;
|
||||
&nameParameter; &tagsParameter; &container_formatParameter;
|
||||
@ -619,7 +601,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-details-response.json"/>
|
||||
href="../samples/image-show-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -630,9 +612,10 @@
|
||||
<para role="shortdesc">(Since Image API v2.0) Deactivates an image.
|
||||
</para>
|
||||
<para>
|
||||
If you try to download a deactivated image, the 403 Forbidden
|
||||
error is returned. Also, image locations are not visible for
|
||||
deactivated images unless the user is an administrative user.
|
||||
If you try to download a deactivated image, the call returns the
|
||||
<code>Forbidden (403)</code> response code. Also, only
|
||||
administrative users can view image locations for deactivated
|
||||
images.
|
||||
</para>
|
||||
<para>
|
||||
The deactivate operation returns an error if the image status is
|
||||
@ -650,7 +633,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-details-deactivate-response.json"/>
|
||||
href="../samples/image-details-deactivate-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -686,13 +669,13 @@
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The image is deleted in images index.
|
||||
<para>The API deletes the image from the images index.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The binary image data managed by OpenStack
|
||||
Image service is deleted from the storage node if the
|
||||
deleted image stores image data in the node.
|
||||
<para>
|
||||
If the image stores binary image data in the storage node,
|
||||
the OpenStack Image service deletes the data from the node.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -775,10 +758,10 @@
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
If you cannot store the data, your request might lack
|
||||
information or you exceeded your allotted quota. Ensure that
|
||||
you meet the preconditions and run the request again. If the
|
||||
request fails again, review your API request.
|
||||
If you cannot store the data, either your request lacks
|
||||
required information or you exceeded your allotted quota.
|
||||
Ensure that you meet the preconditions and run the request
|
||||
again. If the request fails again, review your API request.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -791,7 +774,7 @@
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="GET" id="getImageFile-v2">
|
||||
<method name="GET" id="showImageFile-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Download binary image data">
|
||||
<para role="shortdesc">(Since
|
||||
@ -802,12 +785,10 @@
|
||||
$image_url/v2/images/{image_id}/file</code>
|
||||
</para>
|
||||
<para>
|
||||
The response body contains the raw binary data that represents the
|
||||
actual virtual disk. The <code>Content-Type</code> header contains
|
||||
the <code>application/octet-stream</code> value. The <code
|
||||
>Content-MD5</code> header contains an MD5 checksum of the image
|
||||
data. Clients are encouraged to use this checksum to verify the
|
||||
integrity of the image data that they receive.
|
||||
The response body contains the raw binary data that represents the actual virtual disk.
|
||||
The <code>Content-Type</code> header contains the <code>application/octet-stream</code>
|
||||
value. The <code>Content-MD5</code> header contains an MD5 checksum of the image data.
|
||||
Use this checksum to verify the integrity of the image data.
|
||||
</para>
|
||||
<para></para>
|
||||
<para>Preconditions</para>
|
||||
@ -865,7 +846,7 @@
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<!-- images/{image_id}/members methods -->
|
||||
<method name="GET" id="getImageMember-v2">
|
||||
<method name="GET" id="showImageMember-v2">
|
||||
<wadl:doc xml:lang="EN" title="Show image member details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">(Since Image API v2.2) Shows image member details.</para>
|
||||
@ -889,7 +870,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-member-details-response.json"
|
||||
href="../samples/image-member-details-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<!-- &memberListParameter; -->
|
||||
@ -899,16 +880,16 @@
|
||||
<method name="GET" id="listImageMembers-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List image members">
|
||||
<para role="shortdesc">(Since Image API v2.1) Lists the tenants with whom this
|
||||
image has been shared.
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.1) Lists the tenants that share this image.
|
||||
</para>
|
||||
<para>If a user with whom this image is shared makes this
|
||||
call, the member list contains only information for
|
||||
that user.
|
||||
<para>
|
||||
If a user who shares this image makes this call, the
|
||||
member list contains only information for that user.
|
||||
</para>
|
||||
<para>If a user with whom this image has not been shared
|
||||
makes this call, the call returns the HTTP 404 status
|
||||
code.
|
||||
<para>
|
||||
If a user who does not share this image makes this call, the call
|
||||
returns the HTTP 404 response code.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
@ -928,7 +909,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-members-list-response.json"
|
||||
href="../samples/image-members-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<!-- &memberListParameter; -->
|
||||
@ -999,7 +980,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-member-create-request.json"
|
||||
href="../samples/image-member-create-request.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
@ -1009,7 +990,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-member-create-response.json"
|
||||
href="../samples/image-member-create-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<!-- &memberListParameter; -->
|
||||
@ -1047,15 +1028,16 @@
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>If you update the member status to
|
||||
<code>accepted</code> and have the correct permissions,
|
||||
you see the image in list images responses.
|
||||
<para>
|
||||
If you update the member status to <code>accepted</code> and
|
||||
have the correct permissions, you see the image in list
|
||||
images responses.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>With correct permissions, you can see
|
||||
the updated member status of the image through API
|
||||
calls.
|
||||
<para>
|
||||
With correct permissions, you can make API calls to see the
|
||||
updated member status of the image.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -1065,7 +1047,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-member-update-request.json"
|
||||
href="../samples/image-member-update-request.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -1086,7 +1068,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-member-update-response.json"
|
||||
href="../samples/image-member-update-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<!-- &memberListParameter; -->
|
||||
@ -1115,7 +1097,7 @@
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The member is removed from
|
||||
<para>The API removes the member from
|
||||
the image members.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1155,14 +1137,14 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/tasks-list-response.json"/>
|
||||
href="../samples/tasks-list-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="createTasks-v2">
|
||||
<method name="POST" id="createTask-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create tasks">
|
||||
title="Create task">
|
||||
<para role="shortdesc">Creates a task.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1170,16 +1152,16 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/tasks-create-request.json"/>
|
||||
href="../samples/task-create-request.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="showTasks-v2">
|
||||
<method name="GET" id="showTask-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show tasks">
|
||||
title="Show task details">
|
||||
<para role="shortdesc">Shows details for a task.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1193,7 +1175,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/tasks-show-response.json"/>
|
||||
href="../samples/task-show-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -1,16 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-image-2.2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!--***********************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent metadefs-namespaces-objects-v2.wadl -->
|
||||
<!--***********************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -24,8 +24,8 @@
|
||||
xmlns:imageapi="http://docs.openstack.org/image/api/v2"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v2">
|
||||
<grammars>
|
||||
<include href="xsd/api.xsd"/>
|
||||
<include href="xsd/api-common.xsd"/>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
@ -48,7 +48,7 @@
|
||||
<para>The name of the object.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getObject-v2"/>
|
||||
<method href="#showObject-v2"/>
|
||||
<method href="#updateObject-v2"/>
|
||||
<method href="#deleteObject-v2"/>
|
||||
</resource>
|
||||
@ -74,7 +74,7 @@
|
||||
element="image">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/metadef-object-create-req.json"/>
|
||||
<xsdxt:code href="../samples/metadef-object-create-request.json"/>
|
||||
</wadl:doc>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="namespace" style="plain" type="xsd:string"
|
||||
@ -157,7 +157,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-object-create-response.json"/>
|
||||
href="../samples/metadef-object-create-response.json"/>
|
||||
</wadl:doc> &metadefNamespaceParameter; &metadefNSDisplayNameParameter;
|
||||
&metadefNSDescParameter; &metadefNSVisibilityParameter;
|
||||
&metadefNSProtectedParameter; &metadefPropertiesParameter;
|
||||
@ -167,9 +167,10 @@
|
||||
</method>
|
||||
<method name="GET" id="listObjects-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List objects">
|
||||
<para role="shortdesc">Lists object definitions within
|
||||
a namespace.</para>
|
||||
title="List object definitions">
|
||||
<para role="shortdesc">
|
||||
Lists object definitions in a namespace.
|
||||
</para>
|
||||
<para>
|
||||
Returns a subset of the larger collection of namespaces and a
|
||||
link that you can use to get the next set of namespaces. You
|
||||
@ -184,15 +185,15 @@
|
||||
parameters.
|
||||
</para>
|
||||
<para>
|
||||
The list operation accepts <code>resource_types</code> and
|
||||
<code>visibility</code> as query parameters that let you
|
||||
filter the results of the returned collection.
|
||||
Use the <code>resource_types</code> and
|
||||
<code>visibility</code> query parameters to filter the
|
||||
response.
|
||||
</para>
|
||||
<para>
|
||||
For example, sending a <code>resource_types</code> filter of
|
||||
<code>OS::Glance::Image,OS::Nova::Flavor</code> filters the
|
||||
namespaces to include only namespaces that are associated to
|
||||
the given resource types.
|
||||
For example, set the <code>resource_types</code> query
|
||||
parameter to <code>OS::Glance::Image,OS::Nova::Flavor</code>
|
||||
to filter the response to include only namespaces that are
|
||||
associated with the given resource types.
|
||||
</para>
|
||||
<para>
|
||||
You can sort the results of this operation by using the
|
||||
@ -210,26 +211,29 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-object-list-response.json"/>
|
||||
href="../samples/metadef-objects-list-response.json"/>
|
||||
</wadl:doc> &namespacesParameter; &metadefNamespaceParameter;
|
||||
&metadefNSDisplayNameParameter; &metadefNSDescParameter;
|
||||
&metadefNSVisibilityParameter; &metadefNSProtectedParameter;
|
||||
&metadefResTypeAssocsParameter; </representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getObject-v2">
|
||||
<method name="GET" id="showObject-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get object definition">
|
||||
<para role="shortdesc">Gets the definition for an object.
|
||||
</para>
|
||||
<para>Response body is a single object entity.</para>
|
||||
title="Show object definition">
|
||||
<para role="shortdesc">
|
||||
Shows the definition for an object.
|
||||
</para>
|
||||
<para>
|
||||
The response body shows a single object entity.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-object-details-response.json"/>
|
||||
href="../samples/metadef-object-details-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -238,8 +242,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update object definition">
|
||||
<para role="shortdesc">
|
||||
Updates an object definition in a
|
||||
namespace.
|
||||
Updates an object definition in a namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -247,7 +250,7 @@
|
||||
element="image">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/metadef-object-update-req.json"/>
|
||||
<xsdxt:code href="../samples/metadef-object-update-request.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
@ -256,7 +259,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-object-update-response.json"/>
|
||||
href="../samples/metadef-object-update-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -265,23 +268,21 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete property definition">
|
||||
<para role="shortdesc">
|
||||
Deletes an object definition within a namespace.
|
||||
Deletes an object definition from a namespace.
|
||||
</para>
|
||||
<para>
|
||||
You cannot delete objects in a namespace with the 'protected'
|
||||
attribute set to true (boolean); the response returns
|
||||
the HTTP 403 status code.
|
||||
To delete a protected object from a namespace, you must
|
||||
first set the <code>protected</code> attribute to false
|
||||
(boolean) on the namespace and then perform the delete. If you
|
||||
try to delete a protected object, the call returns the
|
||||
<code>403</code> response code.
|
||||
</para>
|
||||
<para>
|
||||
You must first set the <code>protected</code> attribute to
|
||||
false (boolean) on the namespace and then perform the delete.
|
||||
The response is empty and returns the HTTP 204 status code.
|
||||
When you successfully delete an object from a namespace, the
|
||||
response is empty and and the response code is
|
||||
<code>204</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
</representation>
|
||||
</request>
|
||||
<response status="204"/>
|
||||
<response status="403"/>
|
||||
</method>
|
||||
@ -1,16 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-image-2.2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!--**************************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent metadefs-namespaces-properties-v2.wadl -->
|
||||
<!--**************************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -24,8 +24,8 @@
|
||||
xmlns:imageapi="http://docs.openstack.org/image/api/v2"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v2">
|
||||
<grammars>
|
||||
<include href="xsd/api.xsd"/>
|
||||
<include href="xsd/api-common.xsd"/>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
@ -41,7 +41,7 @@
|
||||
<method href="#createProperty-v2"/>
|
||||
<method href="#listProperties-v2"/>
|
||||
<resource path="{property_name}" id="property_name">
|
||||
<method href="#getProperty-v2"/>
|
||||
<method href="#showProperty-v2"/>
|
||||
<method href="#updateProperty-v2"/>
|
||||
<method href="#deleteProperty-v2"/>
|
||||
</resource>
|
||||
@ -59,10 +59,10 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create property">
|
||||
<para role="shortdesc">
|
||||
Creates a property definition within a namespace.
|
||||
Creates a property definition in a namespace.
|
||||
</para>
|
||||
<para>
|
||||
The schema is a subset of JSON property definition schema.
|
||||
The schema is a subset of the JSON property definition schema.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -70,7 +70,7 @@
|
||||
element="image">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/metadef-property-create-req.json"/>
|
||||
<xsdxt:code href="../samples/metadef-property-create-request.json"/>
|
||||
</wadl:doc>
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
@ -90,7 +90,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-property-create-response.json"/>
|
||||
href="../samples/metadef-property-create-response.json"/>
|
||||
</wadl:doc> &metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
|
||||
@ -107,11 +107,10 @@
|
||||
</method>
|
||||
<method name="GET" id="listProperties-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List properties">
|
||||
<para role="shortdesc">Lists property definitions within
|
||||
a namespace.</para>
|
||||
<para>Returns a list of property definitions in a
|
||||
namespace.</para>
|
||||
title="List property definitions">
|
||||
<para role="shortdesc">
|
||||
Lists property definitions in a namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -122,7 +121,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-property-list-response.json"/>
|
||||
href="../samples/metadef-properties-list-response.json"/>
|
||||
</wadl:doc> &metadefPropertyListParameter;
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
@ -138,19 +137,22 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getProperty-v2">
|
||||
<method name="GET" id="showProperty-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get property definition">
|
||||
<para role="shortdesc">Gets the definition for a property.
|
||||
title="Show property definition">
|
||||
<para role="shortdesc">
|
||||
Shows the definition for a property.
|
||||
</para>
|
||||
<para>
|
||||
If you include the <code>resource_type</code> query
|
||||
parameter, the prefix of the included resource type is removed
|
||||
from the property name before the query is submitted. This
|
||||
enables you to look for a property name that starts with a
|
||||
prefix from an associated resource type.
|
||||
If you use the <code>resource_type</code> query parameter, the
|
||||
API removes the prefix of the resource type from the property
|
||||
name before it submits the query. This enables you to look for
|
||||
a property name that starts with a prefix from an associated
|
||||
resource type.
|
||||
</para>
|
||||
<para>
|
||||
The response body shows a single property entity.
|
||||
</para>
|
||||
<para>Response body shows a single property entity.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -168,7 +170,7 @@
|
||||
from an associated resource type.
|
||||
</para>
|
||||
<para>
|
||||
The prefix of the included resource type is removed
|
||||
The API removes the prefix of the resource type
|
||||
from the property name in the response.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -180,7 +182,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-property-details-response.json"/>
|
||||
href="../samples/metadef-property-details-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
@ -199,15 +201,16 @@
|
||||
<method name="PUT" id="updateProperty-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update property definition">
|
||||
<para role="shortdesc">Updates a property definition.
|
||||
</para>
|
||||
<para role="shortdesc">
|
||||
Updates a property definition.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json"
|
||||
element="image">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/metadef-property-create-req.json"/>
|
||||
<xsdxt:code href="../samples/metadef-property-create-request.json"/>
|
||||
</wadl:doc>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" type="xsd:string"
|
||||
@ -393,9 +396,9 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-property-update-response.json"/>
|
||||
href="../samples/metadef-property-update-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
|
||||
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
|
||||
@ -1,16 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!--********************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-image-2.2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent metadefs-namespaces-tags-v2.wadl -->
|
||||
<!--********************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -24,8 +24,8 @@
|
||||
xmlns:imageapi="http://docs.openstack.org/image/api/v2"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v2">
|
||||
<grammars>
|
||||
<include href="xsd/api.xsd"/>
|
||||
<include href="xsd/api-common.xsd"/>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
@ -42,7 +42,7 @@
|
||||
<method href="#deleteAllTags-v2"/>
|
||||
<resource path="{name}" id="tag_name">
|
||||
<method href="#addTag-v2"/>
|
||||
<method href="#getTag-v2"/>
|
||||
<method href="#showTag-v2"/>
|
||||
<method href="#updateTag-v2"/>
|
||||
<method href="#deleteTag-v2"/>
|
||||
</resource>
|
||||
@ -68,7 +68,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-tag-create-req.json"/>
|
||||
href="../samples/metadef-tag-create-request.json"/>
|
||||
</wadl:doc>
|
||||
&metadefNamespaceParameter;
|
||||
&metadefTagsParameter;
|
||||
@ -80,7 +80,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-tag-create-response.json"/>
|
||||
href="../samples/metadef-tag-create-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefTagsParameter;
|
||||
&metadefTagNameParameter;
|
||||
@ -111,7 +111,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-tag-list-response.json"/>
|
||||
href="../samples/metadef-tags-list-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefTagsParameter;
|
||||
&metadefTagNameParameter;
|
||||
@ -161,12 +161,12 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-tag-add-response.json"/>
|
||||
href="../samples/metadef-tag-add-response.json"/>
|
||||
</wadl:doc> &metadefTagNameParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getTag-v2">
|
||||
<method name="GET" id="showTag-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get tag definition">
|
||||
<para role="shortdesc">
|
||||
@ -185,7 +185,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-tag-details-response.json"/>
|
||||
href="../samples/metadef-tag-details-response.json"/>
|
||||
</wadl:doc> &metadefTagNameParameter;
|
||||
</representation>
|
||||
</response>
|
||||
@ -201,7 +201,7 @@
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/metadef-tag-update-req.json"/>
|
||||
<xsdxt:code href="../samples/metadef-tag-update-request.json"/>
|
||||
</wadl:doc>
|
||||
&metadefNamespaceParameter;
|
||||
&metadefTagNameParameter;
|
||||
@ -212,7 +212,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-tag-update-response.json"/>
|
||||
href="../samples/metadef-tag-update-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefTagNameParameter;
|
||||
</representation>
|
||||
@ -3,14 +3,14 @@
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-image-2.2.wadl -->
|
||||
<!-- xmllint -noent metadefs-namespaces-v2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -24,8 +24,8 @@
|
||||
xmlns:imageapi="http://docs.openstack.org/image/api/v2"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v2">
|
||||
<grammars>
|
||||
<include href="xsd/api.xsd"/>
|
||||
<include href="xsd/api-common.xsd"/>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
@ -48,7 +48,7 @@
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getNamespace-v2"/>
|
||||
<method href="#showNamespace-v2"/>
|
||||
<method href="#updateNamespace-v2"/>
|
||||
<method href="#deleteNamespace-v2"/>
|
||||
</resource>
|
||||
@ -67,8 +67,8 @@
|
||||
Creates a namespace.
|
||||
</para>
|
||||
<para>
|
||||
The namespace is created with a <code>Location</code> header
|
||||
that contains the newly-created URI for the namespace.
|
||||
The <code>Location</code> response header
|
||||
contains the newly-created URI for the namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -76,7 +76,7 @@
|
||||
element="image">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/metadef-namespace-create-req.json"/>
|
||||
<xsdxt:code href="../samples/metadef-namespace-create-request.json"/>
|
||||
</wadl:doc>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="namespace" style="plain" type="xsd:string"
|
||||
@ -96,7 +96,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
User-friendly name that can be used in UI to
|
||||
User-friendly name that you can use in the UI to
|
||||
display the namespace name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -177,7 +177,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-namespace-create-response.json"/>
|
||||
href="../samples/metadef-namespace-create-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefNamespaceParameter; &metadefNSDisplayNameParameter;
|
||||
&metadefNSDescParameter; &metadefNSVisibilityParameter;
|
||||
@ -205,8 +205,8 @@
|
||||
</para>
|
||||
<para>
|
||||
The list operation accepts the <code>resource_types</code> and
|
||||
<code>visibility</code> query parameters, which let you filter
|
||||
the results in the returned collection.
|
||||
<code>visibility</code> query parameters, which you can use to filter
|
||||
the response.
|
||||
</para>
|
||||
<para>
|
||||
To sort the results of this operation, use the
|
||||
@ -267,7 +267,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-namespace-list-response.json"/>
|
||||
href="../samples/metadef-namespaces-list-response.json"/>
|
||||
</wadl:doc>
|
||||
&namespacesParameter; &metadefNamespaceParameter;
|
||||
&metadefNSDisplayNameParameter; &metadefNSDescParameter;
|
||||
@ -276,7 +276,7 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getNamespace-v2">
|
||||
<method name="GET" id="showNamespace-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get namespaces details">
|
||||
<para role="shortdesc">
|
||||
@ -292,7 +292,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-namespace-details-response.json"/>
|
||||
href="../samples/metadef-namespace-details-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -306,7 +306,7 @@
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="samples/metadef-namespace-update-req.json"/>
|
||||
<xsdxt:code href="../samples/metadef-namespace-update-request.json"/>
|
||||
</wadl:doc>
|
||||
&metadefNamespace_idParameter;
|
||||
</representation>
|
||||
@ -316,7 +316,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-namespace-update-response.json"/>
|
||||
href="../samples/metadef-namespace-update-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -3,14 +3,14 @@
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-image-2.2.wadl -->
|
||||
<!-- xmllint -noent metadefs-resource_types-v2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -24,8 +24,8 @@
|
||||
xmlns:imageapi="http://docs.openstack.org/image/api/v2"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v2">
|
||||
<grammars>
|
||||
<include href="xsd/api.xsd"/>
|
||||
<include href="xsd/api-common.xsd"/>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
@ -86,7 +86,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-resource-type-assoc-create-req.json"/>
|
||||
href="../samples/metadef-resource-type-create-request.json"/>
|
||||
</wadl:doc>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" type="xsd:string"
|
||||
@ -104,12 +104,11 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Prefix for the resource type. If you specify a
|
||||
prefix, you must use this value followed by a
|
||||
prefix separator, such as the colon
|
||||
(<code>:</code>) character, to prefix any
|
||||
properties in the namespace that you want to apply
|
||||
to the resource type.
|
||||
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>
|
||||
@ -136,7 +135,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-resource-type-assoc-create-response.json"/>
|
||||
href="../samples/metadef-resource-type-assoc-create-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -156,7 +155,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-resource-type-list-response.json"/>
|
||||
href="../samples/metadef-resource-types-list-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -176,7 +175,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/metadef-resource-type-assoc-list-response.json"/>
|
||||
href="../samples/metadef-resource-types-list-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
@ -4,15 +4,15 @@
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entites with xmllint -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-metadef-schemas-2.2.wadl -->
|
||||
<!-- xmllint -noent schemas-metadefs-v2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -26,8 +26,8 @@
|
||||
xmlns:imageapi="http://docs.openstack.org/image/api/v2"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v2">
|
||||
<grammars>
|
||||
<include href="xsd/api.xsd"/>
|
||||
<include href="xsd/api-common.xsd"/>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
|
||||
<!--*******************************************************-->
|
||||
@ -41,43 +41,43 @@
|
||||
<resource id="metadefs" path="metadefs">
|
||||
<resource id="namespace" type="#SchemaList"
|
||||
path="namespace">
|
||||
<method href="#getMetadefNamespaceSchema"/>
|
||||
<method href="#showMetadefNamespaceSchema"/>
|
||||
</resource>
|
||||
<resource id="namespaces" type="#SchemaList"
|
||||
path="namespaces">
|
||||
<method href="#getMetadefNamespacesSchema"/>
|
||||
<method href="#showMetadefNamespacesSchema"/>
|
||||
</resource>
|
||||
<resource id="object" type="#SchemaList"
|
||||
path="object">
|
||||
<method href="#getMetadefObjectSchema"/>
|
||||
<method href="#showMetadefObjectSchema"/>
|
||||
</resource>
|
||||
<resource id="objects" type="#SchemaList"
|
||||
path="objects">
|
||||
<method href="#getMetadefObjectsSchema"/>
|
||||
<method href="#showMetadefObjectsSchema"/>
|
||||
</resource>
|
||||
<resource id="property" type="#SchemaList"
|
||||
path="property">
|
||||
<method href="#getMetadefPropertySchema"/>
|
||||
<method href="#showMetadefPropertySchema"/>
|
||||
</resource>
|
||||
<resource id="properties" type="#SchemaList"
|
||||
path="properties">
|
||||
<method href="#getMetadefPropertiesSchema"/>
|
||||
<method href="#showMetadefPropertiesSchema"/>
|
||||
</resource>
|
||||
<resource id="tag" type="#SchemaList"
|
||||
path="tag">
|
||||
<method href="#getMetadefTagSchema"/>
|
||||
<method href="#showMetadefTagSchema"/>
|
||||
</resource>
|
||||
<resource id="tags" type="#SchemaList"
|
||||
path="tags">
|
||||
<method href="#getMetadefTagsSchema"/>
|
||||
<method href="#showMetadefTagsSchema"/>
|
||||
</resource>
|
||||
<resource id="resource_type" type="#SchemaList"
|
||||
path="resource_type">
|
||||
<method href="#getMetadefResTypeAssocSchema"/>
|
||||
<method href="#showMetadefResTypeAssocSchema"/>
|
||||
</resource>
|
||||
<resource id="resource_types" type="#SchemaList"
|
||||
path="resource_types">
|
||||
<method href="#getMetadefResTypeAssocsSchema"/>
|
||||
<method href="#showMetadefResTypeAssocsSchema"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -88,11 +88,11 @@
|
||||
<!-- All Methods -->
|
||||
<!--*******************************************************-->
|
||||
|
||||
<method name="GET" id="getMetadefNamespaceSchema">
|
||||
<method name="GET" id="showMetadefNamespaceSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition namespace schema">
|
||||
title="Show metadata definition namespace schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition namespace entity. (Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
@ -105,17 +105,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-namespace-get-response.json"
|
||||
href="../samples/schema-metadef-namespace-show-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefNamespacesSchema">
|
||||
<method name="GET" id="showMetadefNamespacesSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition namespaces schema">
|
||||
title="Show metadata definition namespaces schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition namespaces entity. (Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
@ -131,17 +131,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-namespaces-get-response.json"
|
||||
href="../samples/schema-metadef-namespaces-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefObjectSchema">
|
||||
<method name="GET" id="showMetadefObjectSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition object schema">
|
||||
title="Show metadata definition object schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition object entity. (Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
@ -154,17 +154,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-object-get-response.json"
|
||||
href="../samples/schema-metadef-object-show-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefObjectsSchema">
|
||||
<method name="GET" id="showMetadefObjectsSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition objects schema">
|
||||
title="Show metadata definition objects schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition objects entity. (Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
@ -180,17 +180,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-objects-get-response.json"
|
||||
href="../samples/schema-metadef-objects-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefPropertySchema">
|
||||
<method name="GET" id="showMetadefPropertySchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition property schema">
|
||||
title="Show metadata definition property schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition property entity. (Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
@ -203,17 +203,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-property-get-response.json"
|
||||
href="../samples/schema-metadef-property-show-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefPropertiesSchema">
|
||||
<method name="GET" id="showMetadefPropertiesSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition properties schema">
|
||||
title="Show metadata definition properties schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition properties entity. (Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
@ -229,17 +229,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-properties-get-response.json"
|
||||
href="../samples/schema-metadef-properties-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefTagSchema">
|
||||
<method name="GET" id="showMetadefTagSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition tag schema">
|
||||
title="Show metadata definition tag schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition tag entity. (Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
@ -252,17 +252,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-tag-get-response.json"
|
||||
href="../samples/schema-metadef-tag-show-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefTagsSchema">
|
||||
<method name="GET" id="showMetadefTagsSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition tags schema">
|
||||
title="Show metadata definition tags schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition tags entity. (Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
@ -278,17 +278,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-tags-get-response.json"
|
||||
href="../samples/schema-metadef-tags-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefResTypeAssocSchema">
|
||||
<method name="GET" id="showMetadefResTypeAssocSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition namespace resource type association schema">
|
||||
title="Show metadata definition namespace resource type association schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition namespace resource type association entity.
|
||||
(Since API v2.1.)
|
||||
</para>
|
||||
@ -302,17 +302,17 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-resource-type-association-get-response.json"
|
||||
href="../samples/schema-metadef-resource-type-association-show-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMetadefResTypeAssocsSchema">
|
||||
<method name="GET" id="showMetadefResTypeAssocsSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get metadata definition namespace resource type associations schema">
|
||||
title="Show metadata definition namespace resource type associations schema">
|
||||
<para role="shortdesc">
|
||||
Gets a JSON schema document that represents a metadata
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition namespace resource type associations entity.
|
||||
(Since API v2.1.)
|
||||
</para>
|
||||
@ -330,7 +330,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schema-metadef-resource-type-associations-get-response.json"
|
||||
href="../samples/schema-metadef-resource-type-associations-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
@ -1,18 +1,18 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
|
||||
<!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved -->
|
||||
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-image-schemas-2.2.wadl -->
|
||||
<!-- xmllint -noent schemas-v2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
@ -24,8 +24,8 @@
|
||||
xmlns:imageapi="http://docs.openstack.org/image/api/v2.2"
|
||||
xmlns:csapi="http://docs.openstack.org/image/api/v2.0">
|
||||
<grammars>
|
||||
<include href="xsd/api.xsd"/>
|
||||
<include href="xsd/api-common.xsd"/>
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
|
||||
<!--*******************************************************-->
|
||||
@ -38,19 +38,19 @@
|
||||
<resource id="schemas" path="schemas">
|
||||
<resource id="Image-schemas" type="#SchemasList"
|
||||
path="images">
|
||||
<method href="#getImagesSchema"/>
|
||||
<method href="#showImagesSchema"/>
|
||||
</resource>
|
||||
<resource id="Image-schema" type="#SchemaList"
|
||||
path="image">
|
||||
<method href="#getImageSchema"/>
|
||||
<method href="#showImageSchema"/>
|
||||
</resource>
|
||||
<resource id="Image-members-schema"
|
||||
type="#SchemasList" path="members">
|
||||
<method href="#getImageMembersSchema"/>
|
||||
<method href="#showImageMembersSchema"/>
|
||||
</resource>
|
||||
<resource id="Image-member-schema" type="#SchemaList"
|
||||
path="member">
|
||||
<method href="#getImageMemberSchema"/>
|
||||
<method href="#showImageMemberSchema"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -60,10 +60,10 @@
|
||||
<!-- All Methods -->
|
||||
<!--*******************************************************-->
|
||||
|
||||
<method name="GET" id="getImagesSchema">
|
||||
<method name="GET" id="showImagesSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get images schema">
|
||||
<para role="shortdesc">Gets a json-schema document that
|
||||
title="Show images schema">
|
||||
<para role="shortdesc">Shows a JSON schema document that
|
||||
represents an images entity. (Since Images
|
||||
v2.0.)</para>
|
||||
<para>An images entity is a container of image
|
||||
@ -77,16 +77,16 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schemas-images-get-response.json"
|
||||
href="../samples/schemas-images-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getImageSchema">
|
||||
<method name="GET" id="showImageSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get image schema">
|
||||
<para role="shortdesc">Gets a json-schema document that
|
||||
title="Show image schema">
|
||||
<para role="shortdesc">Shows a JSON schema document that
|
||||
represents an image entity. (Since Images
|
||||
v2.0.)</para>
|
||||
<para>The following schema is solely an example. Consider
|
||||
@ -98,16 +98,16 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schemas-image-get-response.json"
|
||||
href="../samples/schema-image-show-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getImageMembersSchema">
|
||||
<method name="GET" id="showImageMembersSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get image members schema">
|
||||
<para role="shortdesc">Gets a json-schema document that
|
||||
title="Show image members schema">
|
||||
<para role="shortdesc">Shows a JSON schema document that
|
||||
represents an image members entity. (Since Images
|
||||
v2.1.)</para>
|
||||
<para>An image members entity is a container of image
|
||||
@ -121,16 +121,16 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schemas-image-members-get-response.json"
|
||||
href="../samples/schemas-image-members-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getImageMemberSchema">
|
||||
<method name="GET" id="showImageMemberSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get image member schema">
|
||||
<para role="shortdesc">Gets a json-schema document that
|
||||
title="Show image member schema">
|
||||
<para role="shortdesc">Shows a JSON schema document that
|
||||
represents an image member entity. (Since Images
|
||||
v2.1.)</para>
|
||||
<para>The following schema is solely an example. Consider
|
||||
@ -142,7 +142,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/schemas-image-member-get-response.json"
|
||||
href="../samples/schema-image-member-show-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
Loading…
x
Reference in New Issue
Block a user