Updated show member call for image v2 API

Closes-Bug: #1240659

Change-Id: Ie00e8873add95370bd5af4b24b695c624b9d2dbe
author: diane fleming
This commit is contained in:
Diane Fleming
2014-05-02 13:51:31 -05:00
parent 4fb346f434
commit 7819d30dc8
3 changed files with 77 additions and 33 deletions

View File

@@ -69,19 +69,19 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-schemas">
<wadl:method href="#getImagesSchema-v2"/>
<wadl:method href="#getImagesSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-schema">
<wadl:method href="#getImageSchema-v2"/>
<wadl:method href="#getImageSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-members-schema">
<wadl:method href="#getImageMembersSchema-v2"/>
<wadl:method href="#getImageMembersSchema"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-member-schema">
<wadl:method href="#getImageMemberSchema-v2"/>
<wadl:method href="#getImageMemberSchema"/>
</wadl:resource>
</wadl:resources>
</section>

View File

@@ -54,7 +54,50 @@
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY memberParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="status"
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"
title="status">The status of the image.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="created_at"
style="plain" type="xsd:datetime" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="Created at">The date and time when the image member was created.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated_at"
style="plain" type="xsd:datetime" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="Updated at">The date and time when the image member was last updated.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="image_id"
style="plain" type="csapi:uuid" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="Image ID">Image ID stored through the image API.
Typically a UUID.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="member_id"
style="plain" type="csapi:uuid" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="Member ID">Member ID.
Typically a UUID.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="schema"
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"
title="Schema">The schema location for the member.</wadl:doc>
</param>' >
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>

View File

@@ -39,9 +39,9 @@
type="csapi:uuid" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Image ID">Image ID
stored through the image API. Typically a
UUID.</wadl:doc>
xml:lang="EN" title="Image ID"><para>Image
ID stored through the image API.
Typically a UUID.</para></wadl:doc>
</param>
<method href="#getImage-v2"/>
<method href="#updateImage-v2"/>
@@ -57,8 +57,9 @@
name="tag" style="template"
type="xsd:string">
<wadl:doc
xmlns="http://www.w3.org/1999/xhtml"
title="Tag">Image tag.</wadl:doc>
xmlns="http://docbook.org/ns/docbook"
title="Tag"><para>Image
tag.</para></wadl:doc>
</param>
<method href="#addImageTag-v2"/>
<method href="#deleteImageTag-v2"/>
@@ -73,11 +74,12 @@
name="member_id" style="template"
type="xsd:string">
<wadl:doc
xmlns="http://www.w3.org/1999/xhtml"
xml:lang="EN" title="Members">Image
member ID. For example, the tenant
ID of the user with whom the image
is being shared.</wadl:doc>
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Members"
><para>Image member ID. For
example, the tenant ID of the user
with whom the image is being
shared.</para></wadl:doc>
</param>
<method href="#getImageMember-v2"/>
<method href="#deleteImageMember-v2"/>
@@ -130,17 +132,17 @@
name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Images name">Name for the
image. The name of an image is not unique to a
Image Service node. The API cannot expect users to
know the names of images owned by
others.</wadl:doc>
xml:lang="EN" title="Images name"><para>Name for
the image. The name of an image is not unique
to a Image Service node. The API cannot expect
users to know the names of images owned by
others.</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"
xml:lang="EN" title="Image ID">The image
ID.</wadl:doc>
xml:lang="EN" title="Image ID"><para>The image
ID.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="visibility" style="plain" type="xsd:string"
@@ -449,8 +451,8 @@
code.</para>
</wadl:doc>
<request> </request>
<response status="200">
<representation mediaType="application/json">
<response status="200"> &memberParameters; <representation
mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
@@ -524,15 +526,14 @@
<response status="204"/>
</method>
<method name="GET" id="getImageMember-v2">
<wadl:doc xml:lang="EN" title="Get image member details"
<wadl:doc xml:lang="EN" title="Show image member details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets details for a specified image
member.</para>
<para role="shortdesc">Shows image member details.</para>
<para>Response body is a single image member entity.
(Since Image API 2.2.)</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<response status="200"> &memberParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="samples/image-member-details-response.json"
@@ -568,8 +569,8 @@
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<response status="200"> &memberParameters; <representation
mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
@@ -608,8 +609,8 @@
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<response status="200"> &memberParameters; <representation
mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code