openstack/api-site
Code Issues Proposed changes

Update /versions related API description

Browse Source 
Add /versions (with HTTP 200 response)
Fix / response code
  remove 200 response for '/' (i.e keep HTTP 300 response)
Update version response example (adds v2.3/v3.0)
Remove comment out XML description.

Ref.
Source Code for URL definition
  https://github.com/openstack/glance/blob/master/etc/glance-api-paste.ini
Source Code for URL handling
  https://github.com/openstack/glance/blob/master/glance/api/middleware/version_negotiation.py
  https://github.com/openstack/glance/blob/master/glance/api/versions.py
Test code for response
  https://github.com/openstack/glance/blob/master/glance/tests/functional/test_api.py

Changes
  Don't return 300 when requesting /versions
  3fc253c197

Change-Id: Id7052ece6a120bf63b086910460b57a7d0e7e15b
Closes-Bug: #1515022
Closes-Bug: #1404857
This commit is contained in:
Atsushi SAKAI 2015-11-11 17:23:25 +09:00
parent 45bdab7947
commit dab89ac0b5
6 changed files with 91 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref/src/docbkx/ch_images-v1.xml
View File

@ -24,6 +24,10 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#versions">
<wadl:method href="#listVersions-image-null-v1"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#versionspath">
<wadl:method href="#listVersions-image-v1"/>
</wadl:resource>
<!-- need to get a valid response for this one -->

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

@ -8,7 +8,7 @@
version="5.0-extension RackBook-2.0" xml:id="images-api-v2"
role="api-reference">
<title>Image service API v2 (CURRENT)</title>
<para>Image service API v2.0, API v2.1, and API v2.2.</para>
<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.
@ -22,6 +22,10 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#versions">
<wadl:method href="#listVersions-image-null-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#versionspath">
<wadl:method href="#listVersions-image-v2"/>
</wadl:resource>
</wadl:resources>

148
api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl
View File

@ -31,16 +31,12 @@
<!--*******************************************************-->
<resources base="https://glance.example.com/"
xml:id="os-image-v1.0">
<resource id="versions" path="//">
<method href="#listVersions-image-v1"/>
</resource>
<!-- <resource id="extensions" path="extensions">
<method href="#listExtensions"/>
<resource id="extension" path="{alias}">
<param xmlns="http://wadl.dev.java.net/2009/02" name="alias" style="template" type="xsd:string"/>
<method href="#getExtension"/>
<resource id="versions" path="/">
<method href="#listVersions-image-null-v1"/>
<resource id="versionspath" path="versions">
<method href="#listVersions-image-v1"/>
</resource>
</resource>-->
</resource>
<resource id="version" type="#VersionDetails" path="//v1">
<resource id="Images" type="#ImageList" path="images">
<method href="#createImage-v1"/>
@ -87,26 +83,17 @@
</wadl:doc>
<method href="#showVersionDetails-image-v1"/>
</resource_type>
<!-- <resource_type id="ExtensionList">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="Extension List">
<para>A list of supported extensions.</para>
</wadl:doc>
<method href="#listExtensions"/>
</resource_type>-->
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listVersions-image-v1">
<method name="GET" id="listVersions-image-null-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="List API versions"><para
role="shortdesc">Lists information about all Image
role="shortdesc">Lists information about available Image
service API versions.</para>
</wadl:doc>
<response status="200 300">
<response status="300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -117,112 +104,24 @@
</representation>
</response>
</method>
<!--<method name="GET" id="showVersionDetails-image-v1">
<method name="GET" id="listVersions-image-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="Show API v1 details">
<para role="shortdesc">Shows details for Image service API
v1.</para>
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="List API versions"><para
role="shortdesc">Lists information about available Image
service API versions.</para>
</wadl:doc>
<response status="200 203">
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<xsdxt:code
href="../api_samples/imagedetails.json"
/>
href="samples/image-versions-response.json"/>
</wadl:doc>
</representation>
<!-\- this call fails - opened bug 1311243 -\->
<representation mediaType="application/xml"
element="common:version">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/version-get-resp.xml"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="location" style="plain" type="xsd:anyURI"
required="true"
path="/common:version/atom:link[@rel='self']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Location"><para>Full URL
to a service or server.</para></wadl:doc>
<link resource_type="#VersionDetails" rel="self"/>
</param>
</representation>
</response>
</method>-->
<!-- Extensions -->
<!--<method name="GET" id="listExtensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="List extensions">
<para>Lists available extensions.</para>
</wadl:doc>
<response status="200 203">
<param xmlns="http://wadl.dev.java.net/2009/02" name="next" style="plain" type="xsd:anyURI"
path="/capi:extensions/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Moves to the next item in the
list.</wadl:doc>
<link resource_type="#ExtensionList" rel="next"/>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="previous" style="plain" type="xsd:anyURI"
path="/capi:extensions/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Moves to the previous item in the
list.</wadl:doc>
<link resource_type="#ExtensionList" rel="previous"/>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List extensions: JSON response">
<xsdxt:code href="../samples/extensions.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
<!-\- <representation mediaType="application/xml"
element="capi:extensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List extensions: XML response">
<xsdxt:code href="../samples/extensions.xml"/>
</xsdxt:sample>
</wadl:doc>
</representation>-\->
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getExtension">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="Show extension details">
<para>Shows details for an
extension.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get extension details: JSON response">
<xsdxt:code href="../samples/extension.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<!-\- <representation mediaType="application/xml"
element="capi:extension">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get extension details: XML response">
<xsdxt:code href="../samples/extension.xml"/>
</xsdxt:sample>
</wadl:doc>
</representation>-\->
</response> &commonFaults; &getFaults; </method>-->
</method>
<method name="POST" id="createImage-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -441,19 +340,6 @@
</response>
&fault403;
</method>
<!--<method name="HEAD" id="getImageHeaders-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"
title="Show image details as headers">
<para role="shortdesc">Shows the image details as
response headers.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml"
element="imageapi:image"/>
</response>
</method>-->
<method name="DELETE" id="deleteImage-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"

20
api-ref/src/wadls/image-api/src/v1/samples/image-versions-response.json
View File

@ -1,7 +1,27 @@
{
"versions": [
{
"status": "EXPERIMENTAL",
"id": "v3.0",
"links": [
{
"href": "http://23.253.228.211:9292/v3/",
"rel": "self"
}
]
},
{
"status": "CURRENT",
"id": "v2.3",
"links": [
{
"href": "http://23.253.228.211:9292/v2/",
"rel": "self"
}
]
},
{
"status": "SUPPORTED",
"id": "v2.2",
"links": [
{

30
api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl
View File

@ -31,8 +31,11 @@
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://glance.example.com/" xml:id="os-image-v2">
<resource id="versions" path="//">
<method href="#listVersions-image-v2"/>
<resource id="versions" path="/">
<method href="#listVersions-image-null-v2"/>
<resource id="versionspath" path="versions">
<method href="#listVersions-image-v2"/>
</resource>
</resource>
<resource id="version" path="//v2">
<resource id="Images" type="#ImageList" path="images">
@ -94,14 +97,31 @@
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listVersions-image-v2">
<method name="GET" id="listVersions-image-null-v2">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists information about all Image
<para role="shortdesc">Lists information about available Image
service API versions.
</para>
</wadl:doc>
<response status="200 300">
<response status="300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/image-versions-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="listVersions-image-v2">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists information about available Image
service API versions.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">

20
api-ref/src/wadls/image-api/src/v2/samples/image-versions-response.json
View File

@ -1,7 +1,27 @@
{
"versions": [
{
"status": "EXPERIMENTAL",
"id": "v3.0",
"links": [
{
"href": "http://23.253.228.211:9292/v3/",
"rel": "self"
}
]
},
{
"status": "CURRENT",
"id": "v2.3",
"links": [
{
"href": "http://23.253.228.211:9292/v2/",
"rel": "self"
}
]
},
{
"status": "SUPPORTED",
"id": "v2.2",
"links": [
{