Merge "Add note about member and member_id attributes"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
e40e8ffe69
@ -10,11 +10,12 @@
|
||||
<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
|
||||
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>.
|
||||
property protection</link> in the <citetitle>OpenStack Cloud
|
||||
Administrator Guide</citetitle>.
|
||||
</para>
|
||||
<section xml:id="versions-images-v2">
|
||||
<title>API versions</title>
|
||||
@ -25,7 +26,7 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="images-images-v2">
|
||||
<title>Images</title>
|
||||
<title>Images (images)</title>
|
||||
<para>Creates, lists, updates, and deletes images.</para>
|
||||
<para>
|
||||
Image operations show all fields in the response body. Any field
|
||||
@ -123,8 +124,10 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="image-data-v2">
|
||||
<title>Image data</title>
|
||||
<para>Uploads and downloads raw image data.</para>
|
||||
<title>Image data (images, file)</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/wadl/images-v2.wadl#file">
|
||||
<wadl:method href="#storeImageFile-v2"/>
|
||||
@ -133,8 +136,10 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="image-tags-v2">
|
||||
<title>Image tags</title>
|
||||
<para>Adds and deletes image tags.</para>
|
||||
<title>Image tags (images, 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/wadl/images-v2.wadl#tag">
|
||||
<wadl:method href="#addImageTag-v2"/>
|
||||
@ -143,7 +148,10 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="members-v2">
|
||||
<title>Members</title>
|
||||
<title>Members (images, members)</title>
|
||||
<para>
|
||||
Creates, lists, updates, and deletes image members.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/images-v2.wadl#Members">
|
||||
<wadl:method href="#listImageMembers-v2"/>
|
||||
@ -151,172 +159,78 @@
|
||||
</wadl:resource>
|
||||
<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:method href="#deleteImageMember-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="image-schemas-v2">
|
||||
<title>Image schemas</title>
|
||||
<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/wadl/schemas-v2.wadl#Image-schemas">
|
||||
<wadl:method href="#showImagesSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl#Image-schema">
|
||||
<wadl:method href="#showImageSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl#Image-members-schema">
|
||||
<wadl:method href="#showImageMembersSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl#Image-member-schema">
|
||||
<wadl:method href="#showImageMemberSchema"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
<title>Image schemas (schemas, image, images, member, members)</title>
|
||||
<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"
|
||||
href="../wadls/image-api/src/v2/wadl/schemas-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="os-metadef-resourcetype-v2">
|
||||
<title>Metadata definition resource types (since API v2.0)</title>
|
||||
<title>Metadata definition resource types (since API v2.0) (metadefs, namespaces, resource_types)</title>
|
||||
<para>
|
||||
Lists resource types. Also, creates, lists, and
|
||||
removes resource type associations in a namespace.
|
||||
Lists resource types. Also, creates, lists, and removes resource
|
||||
type associations in a namespace.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#resource_types">
|
||||
<wadl:method href="#listResourceTypes-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#resource_types_assoc">
|
||||
<wadl:method href="#createResourceTypeAssoc-v2"/>
|
||||
<wadl:method href="#listResourceTypeAssocs-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl#name">
|
||||
<wadl:method href="#deleteResourceTypeAssoc-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-resource_types-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="metadefs-namespaces-v2">
|
||||
<title>Metadata definition namespaces (since API v2.0)</title>
|
||||
<section xml:id="metadefs-namespaces-v2">
|
||||
<title>Metadata definition namespaces (since API v2.0) (metadefs, namespaces)</title>
|
||||
<para>
|
||||
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/wadl/metadefs-namespaces-v2.wadl#namespaces">
|
||||
<wadl:method href="#createNamespace-v2"/>
|
||||
<wadl:method href="#listNamespaces-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl#namespace">
|
||||
<wadl:method href="#showNamespace-v2"/>
|
||||
<wadl:method href="#updateNamespace-v2"/>
|
||||
<wadl:method href="#deleteNamespace-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="metadefs-namespaces-properties-v2">
|
||||
<title>Metadata definition properties (since API v2.0)</title>
|
||||
<section xml:id="metadefs-namespaces-properties-v2">
|
||||
<title>Metadata definition properties (since API v2.0) (metadefs, namespaces, properties)</title>
|
||||
<para>
|
||||
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/wadl/metadefs-namespaces-properties-v2.wadl#properties">
|
||||
<wadl:method href="#createProperty-v2"/>
|
||||
<wadl:method href="#listProperties-v2"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl#property_name">
|
||||
<wadl:method href="#showProperty-v2"/>
|
||||
<wadl:method href="#updateProperty-v2"/>
|
||||
<wadl:method href="#deleteProperty-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-properties-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="metadefs-namespaces-objects-v2">
|
||||
<title>Metadata definition objects (since API v2.0)</title>
|
||||
<section xml:id="metadefs-namespaces-objects-v2">
|
||||
<title>Metadata definition objects (since API v2.0) (metadefs, namespaces, objects)</title>
|
||||
<para>
|
||||
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/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/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>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-objects-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="metadefs-namespaces-tags-v2">
|
||||
<title>Metadata definition tags (since API v2.0)</title>
|
||||
<title>Metadata definition tags (since API v2.0) (metadefs, namespaces, tags)</title>
|
||||
<para>
|
||||
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/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/wadl/metadefs-namespaces-tags-v2.wadl#tag_name">
|
||||
<wadl:method href="#addTag-v2"/>
|
||||
<wadl:method href="#showTag-v2"/>
|
||||
<wadl:method href="#updateTag-v2"/>
|
||||
<wadl:method href="#deleteTag-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/image-api/src/v2/wadl/metadefs-namespaces-tags-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="schemas-metadefs-v2">
|
||||
<title>Metadata definition schemas</title>
|
||||
<title>Metadata definition schemas (schemas, metadefs, namespace, namespaces, object, objects, property, properties, tag, tags, resource_type, resource_types)</title>
|
||||
<para>
|
||||
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/wadl/schemas-metadefs-v2.wadl#namespace">
|
||||
<wadl:method href="#showMetadefNamespaceSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#namespaces">
|
||||
<wadl:method href="#showMetadefNamespacesSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#object">
|
||||
<wadl:method href="#showMetadefObjectSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#objects">
|
||||
<wadl:method href="#showMetadefObjectsSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#property">
|
||||
<wadl:method href="#showMetadefPropertySchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#properties">
|
||||
<wadl:method href="#showMetadefPropertiesSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#tag">
|
||||
<wadl:method href="#showMetadefTagSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#tags">
|
||||
<wadl:method href="#showMetadefTagsSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#resource_type">
|
||||
<wadl:method href="#showMetadefResTypeAssocSchema"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl#resource_types">
|
||||
<wadl:method href="#showMetadefResTypeAssocsSchema"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
href="../wadls/image-api/src/v2/wadl/schemas-metadefs-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="os-tasks-v2">
|
||||
<title>Tasks (since API v2.2)</title>
|
||||
<title>Tasks (since API v2.2) (tasks)</title>
|
||||
<para>
|
||||
Creates, lists, and shows details for tasks.
|
||||
</para>
|
||||
|
||||
@ -56,7 +56,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time before which to list usage audits.
|
||||
Filters the response by the date and time before which to list usage audits.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
@ -82,7 +82,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the image or server last changed status.
|
||||
Filters the response by the date and time when the image or server last changed status.
|
||||
</para>
|
||||
<para>
|
||||
Use this query parameter to check for changes since a previous
|
||||
@ -129,7 +129,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the image or server was created.
|
||||
Filters the response by the date and time when the resource was created.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
@ -246,6 +246,36 @@
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY updated_at-QueryParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated_at" style="query"
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the response by the date and time when the resource was updated.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the time zone, the UTC time zone is assumed.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the <code>updated_at</code> date and time stamp, its value
|
||||
is <code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY updated_at-RequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated_at" style="plain"
|
||||
required="false" type="xsd:string">
|
||||
@ -618,7 +648,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
The expiration date and time in <link
|
||||
Filters the response by the expiration date and time in <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/Unix_time">UNIX Epoch time
|
||||
stamp format</link>.
|
||||
</para>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -38,7 +38,7 @@
|
||||
<resource id="images" type="#ImageList" path="images">
|
||||
<method href="#createImage-v2"/>
|
||||
<resource path="{image_id}" id="image_id">
|
||||
&image_idParameter;
|
||||
&image_idTemplateParameter;
|
||||
<method href="#showImage-v2"/>
|
||||
<method href="#updateImage-v2"/>
|
||||
<method href="#deleteImage-v2"/>
|
||||
@ -56,7 +56,7 @@
|
||||
</resource>
|
||||
<resource id="Tags" path="tags">
|
||||
<resource path="{tag}" id="tag">
|
||||
&tagParameter;
|
||||
&tagTemplateParameter;
|
||||
<method href="#addImageTag-v2"/>
|
||||
<method href="#deleteImageTag-v2"/>
|
||||
</resource>
|
||||
@ -64,7 +64,7 @@
|
||||
<resource id="Members" type="#MemberList" path="members">
|
||||
<method href="#createImageMember-v2"/>
|
||||
<resource path="{member_id}" id="member_id">
|
||||
&member_idParameter;
|
||||
&member_idTemplateParameter;
|
||||
<method href="#showImageMember-v2"/>
|
||||
<method href="#deleteImageMember-v2"/>
|
||||
<method href="#updateImageMember-v2"/>
|
||||
@ -76,6 +76,7 @@
|
||||
<method href="#createTask-v2"/>
|
||||
<method href="#listTasks-v2"/>
|
||||
<resource path="{task_id}" id="task_id">
|
||||
&task_idTemplateParameter;
|
||||
<method href="#showTask-v2"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -97,8 +98,7 @@
|
||||
<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.
|
||||
Lists version information for all Image service API versions.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="300">
|
||||
@ -114,7 +114,8 @@
|
||||
<method name="GET" id="listImages-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List images">
|
||||
<para role="shortdesc">(Since Image API v2.0) Lists public virtual machine (VM)
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.0) Lists public virtual machine (VM)
|
||||
images.
|
||||
</para>
|
||||
<para>
|
||||
@ -130,15 +131,14 @@
|
||||
<code>marker</code> parameters.
|
||||
</para>
|
||||
<para>
|
||||
The list operation accepts several query parameters. Use these
|
||||
parameters to filter the response.
|
||||
The list operation accepts query parameters to filter the response.
|
||||
</para>
|
||||
<para>
|
||||
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 use
|
||||
tags or any <code>link</code> in the json-schema, such as self, file,
|
||||
or schema, to filter the response.
|
||||
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>
|
||||
@ -162,8 +162,8 @@
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>sort_key</code>. Sorts by an image
|
||||
attribute. Sorts in the natural sorting direction of the image attribute.
|
||||
<code>sort_key</code>. Sorts by an image attribute. Sorts in
|
||||
the natural sorting direction of the image attribute.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -179,18 +179,20 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>To specify the <code>sort_key</code> and
|
||||
<code>sort_dir</code> query parameters to sort the results:
|
||||
<para>
|
||||
To sort the response, use the <code>sort_key</code> and
|
||||
<code>sort_dir</code> query parameters:
|
||||
</para>
|
||||
<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>
|
||||
Alternatively, specify the <code>sort</code> query parameter:
|
||||
</para>
|
||||
<programlisting language="json">GET /v2/images?sort=name:asc,status:desc</programlisting>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&limitMarkerReqParameter;
|
||||
&imageListReqParameters;
|
||||
&imageListQueryParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -200,39 +202,51 @@
|
||||
<xsdxt:code
|
||||
href="../samples/images-list-response.json"/>
|
||||
</wadl:doc>
|
||||
&imagesParameter; &statusParameter;
|
||||
&nameParameter; &tagsParameter; &container_formatParameter;
|
||||
&created_at-ResponseParameter; &disk_formatParameter;
|
||||
&updated_at-ResponseParameter; &min_diskParameter;
|
||||
&protectedParameter; &idParameter; &min_ramParameter;
|
||||
&checksumParameter; &ownerParameter;
|
||||
&visibilityParameter; &virtual_sizeParameter;
|
||||
&sizeParameter; &propertiesParameter;
|
||||
&location_urlParameter; &metadataParameter;
|
||||
&direct_urlParameter; &selfParameter;
|
||||
&fileParameter; &image_schemaParameter;
|
||||
&images_schemaParameter;
|
||||
&firstParameter;
|
||||
&imagesObjectParameter;
|
||||
&statusResponseParameter;
|
||||
&image-nameResponseParameter;
|
||||
&tagsObjectParameter;
|
||||
&container_formatResponseParameter;
|
||||
&created_at-ResponseParameter;
|
||||
&disk_formatResponseParameter;
|
||||
&updated_at-ResponseParameter;
|
||||
&min_diskResponseParameter;
|
||||
&image-protectedResponseParameter;
|
||||
&idResponseParameter;
|
||||
&min_ramResponseParameter;
|
||||
&checksumResponseParameter;
|
||||
&owner_idResponseParameter;
|
||||
&image-visibilityResponseParameter;
|
||||
&virtual_sizeResponseParameter;
|
||||
&sizeResponseParameter;
|
||||
&image-propertiesResponseParameter;
|
||||
&locationsResponseParameter;
|
||||
&metadataResponseParameter;
|
||||
&direct_urlResponseParameter;
|
||||
&selfResponseParameter;
|
||||
&fileResponseParameter;
|
||||
&image-schemaResponseParameter;
|
||||
&images-schemaResponseParameter;
|
||||
&firstResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="createImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create image">
|
||||
<para role="shortdesc">(Since Image API v2.0) Creates a virtual machine (VM)
|
||||
image.
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.0) Creates a virtual machine (VM) image.
|
||||
</para>
|
||||
<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.
|
||||
The <code>Location</code> response header contains the URI for
|
||||
the image. The response body contains the new image entity.
|
||||
</para>
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>With correct permissions, you can see
|
||||
the image status as <code>queued</code> through API
|
||||
calls.
|
||||
<para>
|
||||
With correct permissions, you can see the image status as
|
||||
<code>queued</code> through API calls.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -244,70 +258,16 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<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"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<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>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" type="csapi:UUID"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A unique, user-defined image UUID, in the format:
|
||||
</para>
|
||||
<programlisting>nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn</programlisting>
|
||||
<para>
|
||||
Where <emphasis>n</emphasis> is a hexadecimal digit from 0
|
||||
to f, or F.
|
||||
</para>
|
||||
<para>
|
||||
For example:
|
||||
</para>
|
||||
<programlisting>b2173dd3-7ad6-4362-baa6-a68bce3565cb</programlisting>
|
||||
<para>
|
||||
If you omit this value, the API generates a UUID for the
|
||||
image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="visibility" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Image visibility. Public or private.
|
||||
Default is public.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="tags" style="plain" type="xsd:list"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Image tags.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&container_formatRequestParameter; &disk_formatRequestParameter;
|
||||
&min_diskRequestParameter; &min_ramRequestParameter;
|
||||
&protectedRequestParameter; &propertiesRequestParameter;
|
||||
&image-nameRequestParameter;
|
||||
&idRequestParameter;
|
||||
&image-visibilityRequestParameter;
|
||||
&tagsRequestParameter;
|
||||
&container_formatRequestParameter;
|
||||
&disk_formatRequestParameter;
|
||||
&min_diskRequestParameter;
|
||||
&min_ramRequestParameter;
|
||||
&image-protectedRequestParameter;
|
||||
&image-propertiesRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
@ -317,16 +277,27 @@
|
||||
<xsdxt:code
|
||||
href="../samples/image-create-response.json"/>
|
||||
</wadl:doc>
|
||||
&statusParameter; &container_formatParameter;
|
||||
&min_ramParameter; &updated_at-ResponseParameter;
|
||||
&ownerParameter; &min_diskParameter;
|
||||
&tagsParameter; &visibilityParameter;
|
||||
&idParameter; &sizeParameter; &virtual_sizeParameter;
|
||||
&nameParameter; &checksumParameter;
|
||||
&created_at-ResponseParameter; &disk_formatParameter;
|
||||
&propertiesParameter; &protectedParameter;
|
||||
&locationParameter; &selfParameter;
|
||||
&fileParameter; &image_schemaParameter;
|
||||
&statusResponseParameter;
|
||||
&container_formatResponseParameter;
|
||||
&min_ramResponseParameter;
|
||||
&updated_at-ResponseParameter;
|
||||
&owner_idResponseParameter;
|
||||
&min_diskResponseParameter;
|
||||
&tagsObjectParameter;
|
||||
&image-visibilityResponseParameter;
|
||||
&idResponseParameter;
|
||||
&sizeResponseParameter;
|
||||
&virtual_sizeResponseParameter;
|
||||
&image-nameResponseParameter;
|
||||
&checksumResponseParameter;
|
||||
&created_at-ResponseParameter;
|
||||
&disk_formatResponseParameter;
|
||||
&image-propertiesResponseParameter;
|
||||
&image-protectedResponseParameter;
|
||||
&locationRequestHeader;
|
||||
&selfResponseParameter;
|
||||
&fileResponseParameter;
|
||||
&image-schemaResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -408,8 +379,8 @@
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The root of the target document. The value is the
|
||||
entire content of the target document.
|
||||
The root of the target document. The value is the entire
|
||||
content of the target document.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -519,8 +490,11 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="../samples/image-update-request.json"/>
|
||||
</wadl:doc>
|
||||
&pathParameter; &valueParameter; &opParameter;
|
||||
&urlParameter; &metadataParameter;
|
||||
&pathRequestParameter;
|
||||
&valueRequestParameter;
|
||||
&opRequestParameter;
|
||||
&urlRequestParameter;
|
||||
&metadataRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -530,29 +504,46 @@
|
||||
<xsdxt:code
|
||||
href="../samples/image-update-response.json"/>
|
||||
</wadl:doc>
|
||||
&statusParameter;
|
||||
&nameParameter; &tagsParameter; &container_formatParameter;
|
||||
&created_at-ResponseParameter; &disk_formatParameter;
|
||||
&updated_at-ResponseParameter; &min_diskParameter;
|
||||
&protectedParameter; &idParameter; &min_ramParameter;
|
||||
&checksumParameter; &ownerParameter;
|
||||
&visibilityParameter; &sizeParameter;
|
||||
&location_urlParameter; &metadataParameter;
|
||||
&propertiesParameter; &direct_urlParameter; &selfParameter;
|
||||
&fileParameter; &image_schemaParameter;
|
||||
&statusResponseParameter;
|
||||
&image-nameResponseParameter;
|
||||
&tagsObjectParameter;
|
||||
&container_formatResponseParameter;
|
||||
&created_at-ResponseParameter;
|
||||
&disk_formatResponseParameter;
|
||||
&updated_at-ResponseParameter;
|
||||
&min_diskResponseParameter;
|
||||
&image-protectedResponseParameter;
|
||||
&idResponseParameter;
|
||||
&min_ramResponseParameter;
|
||||
&checksumResponseParameter;
|
||||
&owner_idResponseParameter;
|
||||
&image-visibilityResponseParameter;
|
||||
&sizeResponseParameter;
|
||||
&locationsResponseParameter;
|
||||
&metadataResponseParameter;
|
||||
&image-propertiesResponseParameter;
|
||||
&direct_urlResponseParameter;
|
||||
&selfResponseParameter;
|
||||
&fileResponseParameter;
|
||||
&image-schemaResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<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.
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.0) Shows details for an image.
|
||||
</para>
|
||||
<para>
|
||||
The response body contains a single image entity.
|
||||
</para>
|
||||
<para>The response body contains a single image entity.</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The image must exist.</para>
|
||||
<para>
|
||||
The image must exist.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
@ -563,16 +554,28 @@
|
||||
<xsdxt:code
|
||||
href="../samples/image-show-response.json"/>
|
||||
</wadl:doc>
|
||||
&statusParameter;
|
||||
&nameParameter; &tagsParameter; &container_formatParameter;
|
||||
&created_at-ResponseParameter; &disk_formatParameter;
|
||||
&updated_at-ResponseParameter; &min_diskParameter;
|
||||
&protectedParameter; &idParameter; &min_ramParameter;
|
||||
&checksumParameter; &ownerParameter;
|
||||
&visibilityParameter; &sizeParameter;
|
||||
&location_urlParameter; &metadataParameter;
|
||||
&propertiesParameter; &direct_urlParameter; &selfParameter;
|
||||
&fileParameter; &image_schemaParameter;
|
||||
&statusResponseParameter;
|
||||
&image-nameResponseParameter;
|
||||
&tagsObjectParameter;
|
||||
&container_formatResponseParameter;
|
||||
&created_at-ResponseParameter;
|
||||
&disk_formatResponseParameter;
|
||||
&updated_at-ResponseParameter;
|
||||
&min_diskResponseParameter;
|
||||
&image-protectedResponseParameter;
|
||||
&idResponseParameter;
|
||||
&min_ramResponseParameter;
|
||||
&checksumResponseParameter;
|
||||
&owner_idResponseParameter;
|
||||
&image-visibilityResponseParameter;
|
||||
&sizeResponseParameter;
|
||||
&locationsResponseParameter;
|
||||
&metadataResponseParameter;
|
||||
&image-propertiesResponseParameter;
|
||||
&direct_urlResponseParameter;
|
||||
&selfResponseParameter;
|
||||
&fileResponseParameter;
|
||||
&image-schemaResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
&fault404;
|
||||
@ -580,7 +583,8 @@
|
||||
<method name="POST" id="reactivateImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Reactivate image">
|
||||
<para role="shortdesc">(Since Image API v2.0) Reactivates an image.
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.0) Reactivates an image.
|
||||
</para>
|
||||
<para>
|
||||
The reactivate operation returns an error if the image status is
|
||||
@ -606,7 +610,8 @@
|
||||
<method name="POST" id="deactivateImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Deactivate image">
|
||||
<para role="shortdesc">(Since Image API v2.0) Deactivates an image.
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.0) Deactivates an image.
|
||||
</para>
|
||||
<para>
|
||||
If you try to download a deactivated image, the call returns the
|
||||
@ -703,14 +708,15 @@
|
||||
<method name="PUT" id="storeImageFile-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Upload binary image data">
|
||||
<para role="shortdesc">(Since
|
||||
Image API v2.0) Uploads binary image data.
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.0) Uploads binary image data.
|
||||
</para>
|
||||
<para>
|
||||
Set the <code>Content-Type</code> request header to
|
||||
<code>application/octet-stream</code>.
|
||||
</para>
|
||||
<para>Example call:
|
||||
<para>
|
||||
Example call:
|
||||
</para>
|
||||
<programlisting>curl -i -X PUT -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" \
|
||||
-d @/home/glance/ubuntu-12.10.qcow2 $image_url/v2/images/{image_id}/file</programlisting>
|
||||
@ -731,11 +737,13 @@
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The image status must be <code>queued</code>.
|
||||
<para>
|
||||
The image status must be <code>queued</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Your image storage quota must be sufficient.
|
||||
<para>
|
||||
Your image storage quota must be sufficient.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -748,7 +756,8 @@
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>With correct permissions, you can see the
|
||||
<para>
|
||||
With correct permissions, you can see the
|
||||
image status as <code>active</code> through API calls.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -800,22 +809,23 @@
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The images must exist.</para>
|
||||
<para>
|
||||
The images must exist.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
You can download the binary image data
|
||||
in your machine if the image has image
|
||||
data.
|
||||
You can download the binary image data in your machine if
|
||||
the image has image data.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If image data exists, the call returns the
|
||||
HTTP <code>200</code> response code.
|
||||
If image data exists, the call returns the HTTP
|
||||
<code>200</code> response code.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -828,7 +838,7 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&Content-RangeParameter;
|
||||
&Content-RangeRequestHeader;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200 204"/>
|
||||
@ -857,8 +867,11 @@
|
||||
<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>
|
||||
<para>Response body is a single image member entity.
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.2) Shows image member details.
|
||||
</para>
|
||||
<para>
|
||||
Response body is a single image member entity.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
@ -881,7 +894,12 @@
|
||||
href="../samples/image-member-details-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<!-- &memberListParameter; -->
|
||||
&statusResponseParameter;
|
||||
&created_at-ResponseParameter;
|
||||
&updated_at-ResponseParameter;
|
||||
&image_idResponseParameter;
|
||||
&member_idResponseParameter;
|
||||
&member-schemaResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -908,8 +926,7 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You must be the owner or a member of
|
||||
the image.
|
||||
You must be the owner or a member of the image.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -922,11 +939,12 @@
|
||||
href="../samples/image-members-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<!-- &memberListParameter; -->
|
||||
&membersParameter; &statusParameter;
|
||||
&created_at-ResponseParameter; &updated_at-ResponseParameter;
|
||||
&image_idParameter; &member_idParameter;
|
||||
&member_schemaParameter; &members_schemaParameter;
|
||||
&membersObjectParameter;
|
||||
&statusResponseParameter;
|
||||
&created_at-ResponseParameter;
|
||||
&updated_at-ResponseParameter;
|
||||
&member-schemaResponseParameter;
|
||||
&members-schemaResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
<response status="404"/>
|
||||
@ -937,6 +955,14 @@
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.1) Adds a tenant ID as an image member.
|
||||
</para>
|
||||
<para>
|
||||
This call accepts either the <code>member_id</code> or
|
||||
<code>member</code> attribute in the request body. If you specify
|
||||
both attributes, the API uses the <code>member_id</code> value and
|
||||
ignores the <code>member</code> value. Use of the
|
||||
<code>member</code> attribute is supported but deprecated. Use of
|
||||
the <code>member_id</code> attribute is preferred.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
@ -945,23 +971,21 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
You can only add a member to an image that has a
|
||||
<code>visibility</code> attribute set to
|
||||
<code>private</code>.
|
||||
You can add a member to a private image.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>You must be the owner of the
|
||||
image.
|
||||
<para>
|
||||
You must be the owner of the image.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>With correct permissions, you can see
|
||||
the member status of the image as <code>pending</code>
|
||||
through API calls.
|
||||
<para>
|
||||
With correct permissions, you can see the member status of
|
||||
the image as <code>pending</code> through API calls.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -995,6 +1019,8 @@
|
||||
href="../samples/image-member-create-request.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
&member_idRequestParameter;
|
||||
&memberRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -1005,7 +1031,12 @@
|
||||
href="../samples/image-member-create-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<!-- &memberListParameter; -->
|
||||
&created_at-ResponseParameter;
|
||||
&image_idTemplateParameter;
|
||||
&member_idResponseParameter;
|
||||
&member-schemaResponseParameter;
|
||||
&statusResponseParameter;
|
||||
&updated_at-ResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
|
||||
@ -1063,17 +1094,7 @@
|
||||
href="../samples/image-member-update-request.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
required="true" name="status" style="plain"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The status of this image member.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&member-statusRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -1084,7 +1105,12 @@
|
||||
href="../samples/image-member-update-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<!-- &memberListParameter; -->
|
||||
&created_at-ResponseParameter;
|
||||
&image_idTemplateParameter;
|
||||
&member_idResponseParameter;
|
||||
&member-schemaResponseParameter;
|
||||
&statusResponseParameter;
|
||||
&updated_at-ResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -1131,7 +1157,8 @@
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
&fault403; &fault404;
|
||||
&fault403;
|
||||
&fault404;
|
||||
</method>
|
||||
<method name="GET" id="listTasks-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
@ -1183,7 +1210,7 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&tasksShowParameters;
|
||||
&task_idRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -1195,5 +1222,5 @@
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
</method>
|
||||
</application>
|
||||
|
||||
@ -35,19 +35,13 @@
|
||||
<resource id="v2" path="//v2">
|
||||
<resource id="metadefs" path="metadefs">
|
||||
<resource id="namespaces" path="namespaces">
|
||||
<resource path="{namespace}" id="namespace">
|
||||
<resource path="{namespace_id}" id="namespace_id">
|
||||
&namespace_idTemplateParameter;
|
||||
<resource id="objects" type="#ObjectList" path="objects">
|
||||
<method href="#createObject-v2"/>
|
||||
<method href="#listObjects-v2"/>
|
||||
<resource path="{object_name}" id="object_name">
|
||||
&metadefNamespace_idParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="object_name"
|
||||
style="template" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The name of the object.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&object_nameTemplateParameter;
|
||||
<method href="#showObject-v2"/>
|
||||
<method href="#updateObject-v2"/>
|
||||
<method href="#deleteObject-v2"/>
|
||||
@ -76,80 +70,14 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<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"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The namespace is unique across all users.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="display_name" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN"><para>User-friendly name to use in a UI to display the namespace name.
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN"><para>Detailed description for the namespace.
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="visibility" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Namespace visibility. Public or private.
|
||||
Default is private.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="protected" style="plain" type="xsd:boolean"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Namespace protection for deletion. Valid value is true or false.
|
||||
Default is false.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="properties" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Property definitions, if any, for the namespace.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="objects" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Object definitions, if any, for the namespace.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="resource_type_associations" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Resource types, if any, that are associated with this namespace</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&namespaceRequestParameter;
|
||||
&display_nameRequestParameter;
|
||||
&namespace-descriptionRequestParameter;
|
||||
&namespace-visibilityRequestParameter;
|
||||
&namespace-protectedRequestParameter;
|
||||
&namespace-propertiesRequestParameter;
|
||||
&objectRequestParameter;
|
||||
&resource_type_associationsRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
@ -158,10 +86,15 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-object-create-response.json"/>
|
||||
</wadl:doc> &metadefNamespaceParameter; &metadefNSDisplayNameParameter;
|
||||
&metadefNSDescParameter; &metadefNSVisibilityParameter;
|
||||
&metadefNSProtectedParameter; &metadefPropertiesParameter;
|
||||
&metadefObjectsParameter; &metadefResTypeAssocsParameter;
|
||||
</wadl:doc>
|
||||
&namespaceResponseParameter;
|
||||
&display_nameResponseParameter;
|
||||
&namespace-descriptionResponseParameter;
|
||||
&namespace-visibilityResponseParameter;
|
||||
&namespace-protectedResponseParameter;
|
||||
&namespace-propertiesResponseParameter;
|
||||
&objectsResponseParameter;
|
||||
&resource_type_associationsResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -204,7 +137,8 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespaceListReqParameters; </representation>
|
||||
&metadefNamespaceListQueryParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -212,10 +146,15 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-objects-list-response.json"/>
|
||||
</wadl:doc> &namespacesParameter; &metadefNamespaceParameter;
|
||||
&metadefNSDisplayNameParameter; &metadefNSDescParameter;
|
||||
&metadefNSVisibilityParameter; &metadefNSProtectedParameter;
|
||||
&metadefResTypeAssocsParameter; </representation>
|
||||
</wadl:doc>
|
||||
&namespacesObjectParameter;
|
||||
&namespaceResponseParameter;
|
||||
&display_nameResponseParameter;
|
||||
&namespace-descriptionResponseParameter;
|
||||
&namespace-visibilityResponseParameter;
|
||||
&namespace-protectedResponseParameter;
|
||||
&resource_type_associationsResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="showObject-v2">
|
||||
|
||||
@ -35,12 +35,14 @@
|
||||
<resource id="v2" path="//v2">
|
||||
<resource id="metadefs" path="metadefs">
|
||||
<resource id="namespaces" path="namespaces">
|
||||
<resource path="{namespace}" id="namespace">
|
||||
<resource path="{namespace_id}" id="namespace">
|
||||
&namespace_idTemplateParameter;
|
||||
<resource id="properties" type="#PropertyList"
|
||||
path="properties">
|
||||
<method href="#createProperty-v2"/>
|
||||
<method href="#listProperties-v2"/>
|
||||
<resource path="{property_name}" id="property_name">
|
||||
&property_nameTemplateParameter;
|
||||
<method href="#showProperty-v2"/>
|
||||
<method href="#updateProperty-v2"/>
|
||||
<method href="#deleteProperty-v2"/>
|
||||
@ -72,17 +74,24 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="../samples/metadef-property-create-request.json"/>
|
||||
</wadl:doc>
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
&metadefPropertyEnumOptionalParameter; &metadefPropertyItemsOptionalParameter;
|
||||
&metadefPropertyDescOptionalParameter; &metadefPropertyOperOptionalParameter;
|
||||
&metadefPropertyDfltOptionalParameter; &metadefPropertyReadOptionalParameter;
|
||||
&metadefPropertyMinOptionalParameter;
|
||||
&metadefPropertyMaxOptionalParameter; &metadefPropertyMinLengthOptionalParameter;
|
||||
&metadefPropertyMaxLengthOptionalParameter; &metadefPropertyPatternOptionalParameter;
|
||||
&metadefPropertyMinItemsOptionalParameter; &metadefPropertyMaxItemsOptionalParameter;
|
||||
&metadefPropertyUniqueItemsOptionalParameter;
|
||||
&metadefPropertyAdditionalItemsOptionalParameter;
|
||||
&property-nameResponseParameter;
|
||||
&titleResponseParameter;
|
||||
&typeResponseParameter;
|
||||
&enumRequestParameter;
|
||||
&itemsRequestParameter;
|
||||
&property-descriptionRequestParameter;
|
||||
&operatorsRequestParameter;
|
||||
&defaultRequestParameter;
|
||||
&readonlyRequestParameter;
|
||||
&minimumRequestParameter;
|
||||
&maximumRequestParameter;
|
||||
&minLengthRequestParameter;
|
||||
&maxLengthRequestParameter;
|
||||
&patternRequestParameter;
|
||||
&minItemsRequestParameter;
|
||||
&maxItemsRequestParameter;
|
||||
&uniqueItemsRequestParameter;
|
||||
&additionalItemsRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
@ -91,17 +100,25 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-property-create-response.json"/>
|
||||
</wadl:doc> &metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
|
||||
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
|
||||
&metadefPropertyDfltParameter; &metadefPropertyReadParameter;
|
||||
&metadefPropertyMinParameter;
|
||||
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
|
||||
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
|
||||
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
|
||||
&metadefPropertyUniqueItemsParameter;
|
||||
&metadefPropertyAdditionalItemsParameter;
|
||||
</wadl:doc>
|
||||
&property-nameResponseParameter;
|
||||
&titleResponseParameter;
|
||||
&typeResponseParameter;
|
||||
&enumResponseParameter;
|
||||
&itemsResponseParameter;
|
||||
&property-descriptionResponseParameter;
|
||||
&operatorsResponseParameter;
|
||||
&defaultResponseParameter;
|
||||
&readonlyResponseParameter;
|
||||
&minimumResponseParameter;
|
||||
&maximumResponseParameter;
|
||||
&minLengthResponseParameter;
|
||||
&maxLengthResponseParameter;
|
||||
&patternResponseParameter;
|
||||
&minItemsResponseParameter;
|
||||
&maxItemsResponseParameter;
|
||||
&uniqueItemsResponseParameter;
|
||||
&additionalItemsResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -112,28 +129,32 @@
|
||||
Lists property definitions in a namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespace_idParameter;</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-properties-list-response.json"/>
|
||||
</wadl:doc> &metadefPropertyListParameter;
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
|
||||
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
|
||||
&metadefPropertyDfltParameter; &metadefPropertyReadParameter;
|
||||
&metadefPropertyMinParameter;
|
||||
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
|
||||
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
|
||||
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
|
||||
&metadefPropertyUniqueItemsParameter;
|
||||
&metadefPropertyAdditionalItemsParameter;
|
||||
</wadl:doc>
|
||||
&propertiesObjectParameter;
|
||||
&property-nameResponseParameter;
|
||||
&titleResponseParameter;
|
||||
&typeResponseParameter;
|
||||
&enumResponseParameter;
|
||||
&itemsResponseParameter;
|
||||
&property-descriptionResponseParameter;
|
||||
&operatorsResponseParameter;
|
||||
&defaultResponseParameter;
|
||||
&readonlyResponseParameter;
|
||||
&minimumResponseParameter;
|
||||
&maximumResponseParameter;
|
||||
&minLengthResponseParameter;
|
||||
&maxLengthResponseParameter;
|
||||
&patternResponseParameter;
|
||||
&minItemsResponseParameter;
|
||||
&maxItemsResponseParameter;
|
||||
&uniqueItemsResponseParameter;
|
||||
&additionalItemsResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -156,26 +177,9 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespace_idParameter;
|
||||
&metadefPropertyNameIdParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="resource_type"
|
||||
style="query" required="false" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only property names that start with a prefix
|
||||
from an associated resource type.
|
||||
</para>
|
||||
<para>
|
||||
The API removes the prefix of the resource type
|
||||
from the property name in the response.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
</representation>
|
||||
&property_nameRequestParameter;
|
||||
&resource_typeQueryParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -184,17 +188,24 @@
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-property-details-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
|
||||
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
|
||||
&metadefPropertyDfltParameter; &metadefPropertyReadParameter;
|
||||
&metadefPropertyMinParameter;
|
||||
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
|
||||
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
|
||||
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
|
||||
&metadefPropertyUniqueItemsParameter;
|
||||
&metadefPropertyAdditionalItemsParameter;
|
||||
&property-nameResponseParameter;
|
||||
&titleResponseParameter;
|
||||
&typeResponseParameter;
|
||||
&enumResponseParameter;
|
||||
&itemsResponseParameter;
|
||||
&property-descriptionResponseParameter;
|
||||
&operatorsResponseParameter;
|
||||
&defaultResponseParameter;
|
||||
&readonlyResponseParameter;
|
||||
&minimumResponseParameter;
|
||||
&maximumResponseParameter;
|
||||
&minLengthResponseParameter;
|
||||
&maxLengthResponseParameter;
|
||||
&patternResponseParameter;
|
||||
&minItemsResponseParameter;
|
||||
&maxItemsResponseParameter;
|
||||
&uniqueItemsResponseParameter;
|
||||
&additionalItemsResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -212,183 +223,24 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<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"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN"><para>Name of the property.
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="title" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN"><para>Property title.
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="type" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN"><para>Property type
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="enum" style="plain" type="xsd:list"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Enumeration of property values.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="items" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>specifies schema for the items in an
|
||||
array.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Property description.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="operators" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Operators property description.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="default" style="plain" type="xsd:base64Binary"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Default property description.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="readonly" style="plain" type="xsd:boolean"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Indicates whether this is a read-only property.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="minimum" style="plain" type="xsd:int"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Minimum allowed numerical value.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="maximum" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Maximum allowed numerical value.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="minLength" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Minimum allowed string length.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="maxLength" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Maximum allowed string length.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="pattern" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>A regular expression (ECMA 262) that
|
||||
a string value must match.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="minItems" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Minimum length of an array.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="maxItems" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Maximum length of an array.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="uniqueItems" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>whether all the values in the array
|
||||
must be distinct.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="additionalItems" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
If you use <i>tuple-typing</i>, describes extra
|
||||
items. If the value of <code>items</code> is an
|
||||
array and the instance is longer than the list of
|
||||
schema in <code>items</code>, the schema in this
|
||||
property describes the additional items.
|
||||
</para>
|
||||
<para>
|
||||
If this value is false, the instance cannot be
|
||||
longer than the number of schemas that are listed in
|
||||
<code>items</code>.
|
||||
</para>
|
||||
<para>
|
||||
A value of true indicates an empty schema, or
|
||||
anything goes.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&property_nameRequestParameter;
|
||||
&titleRequestParameter;
|
||||
&typeRequestParameter;
|
||||
&enumRequestParameter;
|
||||
&itemsRequestParameter;
|
||||
&property-descriptionRequestParameter;
|
||||
&operatorsRequestParameter;
|
||||
&defaultRequestParameter;
|
||||
&readonlyRequestParameter;
|
||||
&minimumRequestParameter;
|
||||
&maximumRequestParameter;
|
||||
&minLengthRequestParameter;
|
||||
&maxLengthRequestParameter;
|
||||
&patternRequestParameter;
|
||||
&minItemsRequestParameter;
|
||||
&maxItemsRequestParameter;
|
||||
&uniqueItemsRequestParameter;
|
||||
&additionalItemsRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -398,17 +250,24 @@
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-property-update-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefPropertyNameParameter;
|
||||
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
|
||||
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
|
||||
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
|
||||
&metadefPropertyDfltParameter; &metadefPropertyReadParameter;
|
||||
&metadefPropertyMinParameter;
|
||||
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
|
||||
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
|
||||
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
|
||||
&metadefPropertyUniqueItemsParameter;
|
||||
&metadefPropertyAdditionalItemsParameter;
|
||||
&property-nameResponseParameter;
|
||||
&titleResponseParameter;
|
||||
&typeResponseParameter;
|
||||
&enumResponseParameter;
|
||||
&itemsResponseParameter;
|
||||
&property-descriptionResponseParameter;
|
||||
&operatorsResponseParameter;
|
||||
&defaultResponseParameter;
|
||||
&readonlyResponseParameter;
|
||||
&minimumResponseParameter;
|
||||
&maximumResponseParameter;
|
||||
&minLengthResponseParameter;
|
||||
&maxLengthResponseParameter;
|
||||
&patternResponseParameter;
|
||||
&minItemsResponseParameter;
|
||||
&maxItemsResponseParameter;
|
||||
&uniqueItemsResponseParameter;
|
||||
&additionalItemsResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -416,8 +275,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Remove property definition">
|
||||
<para role="shortdesc">
|
||||
Removes a property definition in a
|
||||
namespace.
|
||||
Removes a property definition in a namespace.
|
||||
</para>
|
||||
<para>
|
||||
To remove a property, first make an update namespace request
|
||||
@ -434,8 +292,8 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespace_idParameter;
|
||||
&metadefPropertyNameIdParameter; </representation>
|
||||
&property_nameRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="204"/>
|
||||
<response status="403"/>
|
||||
|
||||
@ -35,12 +35,14 @@
|
||||
<resource id="v2" path="//v2">
|
||||
<resource id="metadefs" path="metadefs">
|
||||
<resource id="namespaces" path="namespaces">
|
||||
<resource path="{namespace}" id="namespace">
|
||||
<resource id="tags" type="#TagList" path="tags">
|
||||
<resource id="tags" type="#TagList" path="tags">
|
||||
<resource path="{namespace_id}" id="namespace_id">
|
||||
&namespace_idTemplateParameter;
|
||||
<method href="#createTags-v2"/>
|
||||
<method href="#listTags-v2"/>
|
||||
<method href="#deleteAllTags-v2"/>
|
||||
<resource path="{name}" id="tag_name">
|
||||
<resource path="{tag_name}" id="tag_name">
|
||||
&tag_nameTemplateParameter;
|
||||
<method href="#addTag-v2"/>
|
||||
<method href="#showTag-v2"/>
|
||||
<method href="#updateTag-v2"/>
|
||||
@ -70,9 +72,9 @@
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-tag-create-request.json"/>
|
||||
</wadl:doc>
|
||||
&metadefNamespaceParameter;
|
||||
&metadefTagsParameter;
|
||||
&metadefTagNameParameter;
|
||||
&namespaceResponseParameter;
|
||||
&tagsObjectParameter;
|
||||
&tag-nameResponseParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
@ -82,8 +84,8 @@
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-tag-create-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefTagsParameter;
|
||||
&metadefTagNameParameter;
|
||||
&tagsObjectParameter;
|
||||
&tag-nameResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -102,9 +104,10 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespaceParameter;
|
||||
&namespaceResponseParameter;
|
||||
&limitMarkerReqParameter;
|
||||
&metadefTagListSortParameters; </representation>
|
||||
&metadefTagListQueryParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -113,8 +116,8 @@
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-tags-list-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefTagsParameter;
|
||||
&metadefTagNameParameter;
|
||||
&tagsObjectParameter;
|
||||
&tag-nameResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -137,7 +140,7 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespaceParameter;
|
||||
&namespaceResponseParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="204"/>
|
||||
@ -150,19 +153,14 @@
|
||||
Adds a tag to the list of namespace tag definitions.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespaceParameter;
|
||||
&metadefTagNameParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-tag-add-response.json"/>
|
||||
</wadl:doc> &metadefTagNameParameter;
|
||||
</wadl:doc>
|
||||
&tag-nameResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -174,19 +172,14 @@
|
||||
</para>
|
||||
<para>The response body shows a single tag entity.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespaceParameter;
|
||||
&metadefTagNameParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-tag-details-response.json"/>
|
||||
</wadl:doc> &metadefTagNameParameter;
|
||||
</wadl:doc>
|
||||
&tag-nameResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -203,8 +196,6 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="../samples/metadef-tag-update-request.json"/>
|
||||
</wadl:doc>
|
||||
&metadefNamespaceParameter;
|
||||
&metadefTagNameParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -214,7 +205,7 @@
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-tag-update-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefTagNameParameter;
|
||||
&tag-nameResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -235,12 +226,6 @@
|
||||
The response is empty and returns the HTTP 204 status code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&metadefNamespaceParameter;
|
||||
&metadefTagNameParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="204"/>
|
||||
<response status="403"/>
|
||||
</method>
|
||||
|
||||
@ -37,17 +37,8 @@
|
||||
<resource id="namespaces" type="#NamespaceList" path="namespaces">
|
||||
<method href="#createNamespace-v2"/>
|
||||
<method href="#listNamespaces-v2"/>
|
||||
<resource path="{namespace}" id="namespace">
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="namespace" style="template" type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Unique namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="{namespace_id}" id="namespace_id">
|
||||
&namespace_idTemplateParameter;
|
||||
<method href="#showNamespace-v2"/>
|
||||
<method href="#updateNamespace-v2"/>
|
||||
<method href="#deleteNamespace-v2"/>
|
||||
@ -78,98 +69,14 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<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"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A namespace name that is unique across all users.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="display_name" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
User-friendly name that you can use in the UI to
|
||||
display the namespace name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Detailed description for the namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="visibility" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Namespace visibility. Valid value is public or
|
||||
private. Default is private.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="protected" style="plain" type="xsd:boolean"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Namespace protection for deletion. Valid value is
|
||||
true or false. Default is false.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="properties" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
One or more property definitions in the namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="objects" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
One or more object definitions in the namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="resource_type_associations" style="plain" type="xsd:dict"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
One or more resource types that are associated
|
||||
with this namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<!-- &namespaceRequestParameter;
|
||||
&display_nameRequestParameter;
|
||||
&namespace-descriptionRequestParameter;
|
||||
&namespace-visibilityRequestParameter;
|
||||
&namespace-protectedRequestParameter;
|
||||
&propertiesRequestParameter;
|
||||
&objectsRequestParameter;
|
||||
&resource_type_associationsRequestParameter; -->
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
@ -179,10 +86,14 @@
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-namespace-create-response.json"/>
|
||||
</wadl:doc>
|
||||
&metadefNamespaceParameter; &metadefNSDisplayNameParameter;
|
||||
&metadefNSDescParameter; &metadefNSVisibilityParameter;
|
||||
&metadefNSProtectedParameter; &metadefPropertiesParameter;
|
||||
&metadefObjectsParameter; &metadefResTypeAssocsParameter;
|
||||
&namespaceResponseParameter;
|
||||
&display_nameResponseParameter;
|
||||
&namespace-descriptionResponseParameter;
|
||||
&namespace-visibilityResponseParameter;
|
||||
&namespace-protectedResponseParameter;
|
||||
&namespace-propertiesResponseParameter;
|
||||
&objectsResponseParameter;
|
||||
&resource_type_associationsResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -219,47 +130,10 @@
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
&limitMarkerReqParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="visibility"
|
||||
style="query" required="false" type="imageapi:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Filter parameter. Namespace visibility. Valid values are
|
||||
<code>public</code> and <code>private</code>.
|
||||
Default is <code>public</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="resource_types"
|
||||
style="query" required="false" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
Filter parameter. Specify this value as comma-separated list. For
|
||||
example, send the <code>resource_types</code> filter of
|
||||
<code>OS::Glance::Image,OS::Nova::Flavor</code> to filter the namespaces
|
||||
by those resource types.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_key"
|
||||
style="query" required="false" type="xsd:string" default="ALL">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Sort key. Use attributes like <code>namespace</code>
|
||||
for sorting. Default is <code>created_at</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_dir"
|
||||
style="query" required="false" type="xsd:string" default="ALL">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Sort direction. Valid values are <code>asc</code>
|
||||
(ascending) and <code>desc</code> (descending). Default is
|
||||
<code>desc</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&visibilityQueryParameter;
|
||||
&resource_typesQueryParameter;
|
||||
&sort_keyQueryParameter;
|
||||
&sort_dirQueryParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -269,10 +143,13 @@
|
||||
<xsdxt:code
|
||||
href="../samples/metadef-namespaces-list-response.json"/>
|
||||
</wadl:doc>
|
||||
&namespacesParameter; &metadefNamespaceParameter;
|
||||
&metadefNSDisplayNameParameter; &metadefNSDescParameter;
|
||||
&metadefNSVisibilityParameter; &metadefNSProtectedParameter;
|
||||
&metadefResTypeAssocsParameter;
|
||||
&namespacesObjectParameter;
|
||||
&namespaceResponseParameter;
|
||||
&display_nameResponseParameter;
|
||||
&namespace-descriptionResponseParameter;
|
||||
&namespace-visibilityResponseParameter;
|
||||
&namespace-protectedResponseParameter;
|
||||
&resource_type_associationsResponseParameter;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -300,7 +177,9 @@
|
||||
<method name="PUT" id="updateNamespace-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update namespace">
|
||||
<para role="shortdesc">Updates a namespace.</para>
|
||||
<para role="shortdesc">
|
||||
Updates a namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -308,7 +187,6 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="../samples/metadef-namespace-update-request.json"/>
|
||||
</wadl:doc>
|
||||
&metadefNamespace_idParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
@ -325,13 +203,13 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete namespace">
|
||||
<para role="shortdesc">
|
||||
Deletes a namespace and its properties,
|
||||
objects, and any resource type associations.
|
||||
Deletes a namespace and its properties, objects, and any
|
||||
resource type associations.
|
||||
</para>
|
||||
<para>
|
||||
You cannot delete namespaces with the <code>protected</code>
|
||||
attribute set to true (boolean); the response returns the HTTP
|
||||
403 status code.
|
||||
attribute set to <code>true</code> (boolean); the response returns the HTTP
|
||||
<code>403</code> response code.
|
||||
</para>
|
||||
<para>
|
||||
To delete a namespace, you must first make an update namespace
|
||||
@ -339,14 +217,14 @@
|
||||
(boolean) on the namespace. Then, delete the namespace.
|
||||
</para>
|
||||
<para>
|
||||
If the operation succeeds, the response returns the HTTP 204
|
||||
status code.
|
||||
A successful operation returns the HTTP <code>204</code>
|
||||
response code.
|
||||
</para>
|
||||
<para>
|
||||
If you try to remove a namespace with the
|
||||
<code>protected</code> attribute set to true (boolean), the
|
||||
operation fails and the response returns the HTTP 403 error
|
||||
code.
|
||||
operation fails and the response returns the HTTP
|
||||
<code>403</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
|
||||
@ -34,34 +34,17 @@
|
||||
xml:id="os-metadef-resourcetype-v2">
|
||||
<resource id="v2" path="//v2">
|
||||
<resource id="metadefs" path="metadefs">
|
||||
<resource id="resource_types" type="#ResourceTypeList"
|
||||
path="resource_types">
|
||||
<resource id="resource_types" type="#ResourceTypeList" path="resource_types">
|
||||
<method href="#listResourceTypes-v2"/>
|
||||
</resource>
|
||||
<resource id="namespaces" path="namespaces">
|
||||
<resource path="{namespace}" id="namespace">
|
||||
<resource id="resource_types_assoc" type="#ResourceTypeAssocList"
|
||||
path="resource_types">
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="namespace" style="template" type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Unique namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="{namespace_id}" id="namespace_id">
|
||||
&namespace_idTemplateParameter;
|
||||
<resource id="resource_types_assoc" type="#ResourceTypeAssocList" path="resource_types">
|
||||
<method href="#createResourceTypeAssoc-v2"/>
|
||||
<method href="#listResourceTypeAssocs-v2"/>
|
||||
<resource path="{name}" id="name">
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name"
|
||||
style="template" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Name of the resource type.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&resource-type-nameTemplateParameter;
|
||||
<method href="#deleteResourceTypeAssoc-v2"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -77,8 +60,9 @@
|
||||
<method name="POST" id="createResourceTypeAssoc-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create resource type association">
|
||||
<para role="shortdesc">Creates a resource type association
|
||||
in a namespace.</para>
|
||||
<para role="shortdesc">
|
||||
Creates a resource type association in a namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json"
|
||||
@ -88,46 +72,9 @@
|
||||
<xsdxt:code
|
||||
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"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Name of the resource type.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="prefix" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Prefix for any properties in the namespace that
|
||||
you want to apply to the resource type. If you
|
||||
specify a prefix, you must append a prefix
|
||||
separator, such as the colon (<code>:</code>)
|
||||
character.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="properties_target" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Some resource types allow more than one key and
|
||||
value pair for each instance. For example, the
|
||||
Image service allows both user and image metadata
|
||||
on volumes. The <code>properties_target</code>
|
||||
parameter enables a namespace target to remove the
|
||||
ambiguity.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&resource-type-nameRequestParameter;
|
||||
&prefixRequestParameter;
|
||||
&properties_targetRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
@ -143,11 +90,13 @@
|
||||
<method name="GET" id="listResourceTypes-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List resource types">
|
||||
<para role="shortdesc">Lists resource types.</para>
|
||||
<para role="shortdesc">
|
||||
Lists all resource types.
|
||||
</para>
|
||||
<para>
|
||||
Lists all possible resource types. You can assign metadata
|
||||
definition namespaces to these resource types. See the
|
||||
metadata definition resource types section.
|
||||
You can assign metadata definition namespaces to these
|
||||
resource types. See the metadata definition resource types
|
||||
section.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
|
||||
@ -39,61 +39,49 @@
|
||||
<resource id="v2" path="//v2">
|
||||
<resource id="schemas" path="schemas">
|
||||
<resource id="metadefs" path="metadefs">
|
||||
<resource id="namespace" type="#SchemaList"
|
||||
path="namespace">
|
||||
<resource id="namespace" type="#SchemaList" path="namespace">
|
||||
<method href="#showMetadefNamespaceSchema"/>
|
||||
</resource>
|
||||
<resource id="namespaces" type="#SchemaList"
|
||||
path="namespaces">
|
||||
<resource id="namespaces" type="#SchemaList" path="namespaces">
|
||||
<method href="#showMetadefNamespacesSchema"/>
|
||||
</resource>
|
||||
<resource id="object" type="#SchemaList"
|
||||
path="object">
|
||||
<resource id="object" type="#SchemaList" path="object">
|
||||
<method href="#showMetadefObjectSchema"/>
|
||||
</resource>
|
||||
<resource id="objects" type="#SchemaList"
|
||||
path="objects">
|
||||
<resource id="objects" type="#SchemaList" path="objects">
|
||||
<method href="#showMetadefObjectsSchema"/>
|
||||
</resource>
|
||||
<resource id="property" type="#SchemaList"
|
||||
path="property">
|
||||
<resource id="property" type="#SchemaList" path="property">
|
||||
<method href="#showMetadefPropertySchema"/>
|
||||
</resource>
|
||||
<resource id="properties" type="#SchemaList"
|
||||
path="properties">
|
||||
<resource id="properties" type="#SchemaList" path="properties">
|
||||
<method href="#showMetadefPropertiesSchema"/>
|
||||
</resource>
|
||||
<resource id="tag" type="#SchemaList"
|
||||
path="tag">
|
||||
<resource id="tag" type="#SchemaList" path="tag">
|
||||
<method href="#showMetadefTagSchema"/>
|
||||
</resource>
|
||||
<resource id="tags" type="#SchemaList"
|
||||
path="tags">
|
||||
<resource id="tags" type="#SchemaList" path="tags">
|
||||
<method href="#showMetadefTagsSchema"/>
|
||||
</resource>
|
||||
<resource id="resource_type" type="#SchemaList"
|
||||
path="resource_type">
|
||||
<resource id="resource_type" type="#SchemaList" path="resource_type">
|
||||
<method href="#showMetadefResTypeAssocSchema"/>
|
||||
</resource>
|
||||
<resource id="resource_types" type="#SchemaList"
|
||||
path="resource_types">
|
||||
<resource id="resource_types" type="#SchemaList" path="resource_types">
|
||||
<method href="#showMetadefResTypeAssocsSchema"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
|
||||
<!--*******************************************************-->
|
||||
<!-- All Methods -->
|
||||
<!--*******************************************************-->
|
||||
|
||||
<method name="GET" id="showMetadefNamespaceSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition namespace schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition namespace entity. (Since API v2.1.)
|
||||
(Since API v2.1) Shows a JSON schema document that represents
|
||||
a metadata definition namespace entity.
|
||||
</para>
|
||||
<para>
|
||||
The following schema document is an example. The authoritative
|
||||
@ -115,8 +103,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition namespaces schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition namespaces entity. (Since API v2.1.)
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition namespaces entity.
|
||||
</para>
|
||||
<para>
|
||||
A namespaces entity is a container for namespace entities.
|
||||
@ -141,8 +129,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition object schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition object entity. (Since API v2.1.)
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition object entity.
|
||||
</para>
|
||||
<para>
|
||||
The following schema document is an example. The authoritative
|
||||
@ -164,8 +152,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition objects schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition objects entity. (Since API v2.1.)
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition objects entity.
|
||||
</para>
|
||||
<para>
|
||||
An objects entity is a container for object entities.
|
||||
@ -190,8 +178,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition property schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition property entity. (Since API v2.1.)
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition property entity.
|
||||
</para>
|
||||
<para>
|
||||
The following schema document is an example. The authoritative
|
||||
@ -213,8 +201,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition properties schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition properties entity. (Since API v2.1.)
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition properties entity.
|
||||
</para>
|
||||
<para>
|
||||
A properties entity is a container for property entities.
|
||||
@ -239,8 +227,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition tag schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition tag entity. (Since API v2.1.)
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition tag entity.
|
||||
</para>
|
||||
<para>
|
||||
The following schema document is an example. The authoritative
|
||||
@ -262,8 +250,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition tags schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
definition tags entity. (Since API v2.1.)
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition tags entity.
|
||||
</para>
|
||||
<para>
|
||||
A tags entity is a container for tag entities.
|
||||
@ -288,9 +276,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition namespace resource type association schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition namespace resource type association entity.
|
||||
(Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
The following schema document is an example. The authoritative
|
||||
@ -312,9 +299,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata definition namespace resource type associations schema">
|
||||
<para role="shortdesc">
|
||||
Shows a JSON schema document that represents a metadata
|
||||
(Since API v2.1) Shows a JSON schema document that represents a metadata
|
||||
definition namespace resource type associations entity.
|
||||
(Since API v2.1.)
|
||||
</para>
|
||||
<para>
|
||||
A resource type associations entity is a container for
|
||||
|
||||
@ -27,50 +27,45 @@
|
||||
<include href="../xsd/api.xsd"/>
|
||||
<include href="../xsd/api-common.xsd"/>
|
||||
</grammars>
|
||||
|
||||
<!--*******************************************************-->
|
||||
<!-- All Resources -->
|
||||
<!--*******************************************************-->
|
||||
|
||||
<resources base="https://glance.example.com/"
|
||||
xml:id="os-image-schemas-v2">
|
||||
<resource id="info" path="//v2">
|
||||
<resource id="schemas" path="schemas">
|
||||
<resource id="Image-schemas" type="#SchemasList"
|
||||
path="images">
|
||||
<resource id="Image-schemas" type="#SchemasList" path="images">
|
||||
<method href="#showImagesSchema"/>
|
||||
</resource>
|
||||
<resource id="Image-schema" type="#SchemaList"
|
||||
path="image">
|
||||
<resource id="Image-schema" type="#SchemaList" path="image">
|
||||
<method href="#showImageSchema"/>
|
||||
</resource>
|
||||
<resource id="Image-members-schema"
|
||||
type="#SchemasList" path="members">
|
||||
<resource id="Image-members-schema" type="#SchemasList" path="members">
|
||||
<method href="#showImageMembersSchema"/>
|
||||
</resource>
|
||||
<resource id="Image-member-schema" type="#SchemaList"
|
||||
path="member">
|
||||
<resource id="Image-member-schema" type="#SchemaList" path="member">
|
||||
<method href="#showImageMemberSchema"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
|
||||
<!--*******************************************************-->
|
||||
<!-- All Methods -->
|
||||
<!--*******************************************************-->
|
||||
|
||||
<method name="GET" id="showImagesSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
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
|
||||
entities.</para>
|
||||
<para>The following schema is solely an example. Consider
|
||||
only the response to the API call as
|
||||
authoritative.</para>
|
||||
<para role="shortdesc">
|
||||
(Since Images v2.0) Shows a JSON schema document that
|
||||
represents an images entity.
|
||||
</para>
|
||||
<para>
|
||||
An images entity is a container of image entities.
|
||||
</para>
|
||||
<para>
|
||||
The following schema is solely an example. Consider only the
|
||||
response to the API call as authoritative.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -86,12 +81,14 @@
|
||||
<method name="GET" id="showImageSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
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
|
||||
only the response to the API call as
|
||||
authoritative.</para>
|
||||
<para role="shortdesc">
|
||||
(Since Images v2.0) Shows a JSON schema document that
|
||||
represents an image entity.
|
||||
</para>
|
||||
<para>
|
||||
The following schema is solely an example. Consider only the
|
||||
response to the API call as authoritative.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -107,14 +104,18 @@
|
||||
<method name="GET" id="showImageMembersSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
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
|
||||
member entities.</para>
|
||||
<para>The following schema is solely an example. Consider
|
||||
only the response to the API call as
|
||||
authoritative.</para>
|
||||
<para role="shortdesc">
|
||||
(Since Images v2.1) Shows a JSON schema document that
|
||||
represents an image members entity.
|
||||
</para>
|
||||
<para>
|
||||
An image members entity is a container of image member
|
||||
entities.
|
||||
</para>
|
||||
<para>
|
||||
The following schema is solely an example. Consider only the
|
||||
response to the API call as authoritative.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -130,12 +131,14 @@
|
||||
<method name="GET" id="showImageMemberSchema">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
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
|
||||
only the response to the API call as
|
||||
authoritative.</para>
|
||||
<para role="shortdesc">
|
||||
(Since Images v2.1) Shows a JSON schema document that
|
||||
represents an image member entity.
|
||||
</para>
|
||||
<para>
|
||||
The following schema is solely an example. Consider only the
|
||||
response to the API call as authoritative.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
||||
@ -2174,6 +2174,8 @@
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&availability_zoneResponseParameter;
|
||||
&created_at-ResponseParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
@ -2411,6 +2413,7 @@
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&created_at-ResponseParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="multiattach" style="plain"
|
||||
type="xsd:boolean" required="true">
|
||||
@ -2535,10 +2538,12 @@
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="links" style="plain" type="xsd:dict" required="true">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
&created_at-ResponseParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="metadata" style="plain" type="dict"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The volume links.
|
||||
</para>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user