openstack/api-site
Code Issues Proposed changes

Merge "Add description of discoverability API (GET /info)"

Browse Source
This commit is contained in:
Jenkins 2015-08-17 20:37:26 +00:00 committed by Gerrit Code Review
commit ac24dcd2cc
4 changed files with 75 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
api-ref/src/docbkx/ch_objectstorage-v1.xml
View File

@ -45,6 +45,19 @@ Accept-Ranges: bytes</programlisting>
see <link
xlink:href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14"
>Header Field Definitions</link>.</para>
<section xml:id="storage_info">
<title>Discoverability</title>
<para>
If configured, lists the activated capabilities for this version
of the OpenStack Object Storage API.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/object-api/src/os-object-api-1.0.wadl#info">
<wadl:method href="#infoDiscoverability"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="storage_endpoints">
<title>Endpoints</title>
<para>If configured, lists endpoints for a specified account.</para>

23
api-ref/src/wadls/object-api/src/common.ent
View File

@ -604,6 +604,29 @@ include them in this header.</para>
</param>
'>
<!--! Request parameters -->
<!ENTITY info-requestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="swiftinfo_sig"
style="query" required="false" type="xsd:char">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
>
<para>
A hash-based message authentication code (HMAC) that enables
access to administrator-only information. To use this parameter,
the <code>swiftinfo_expires</code> parameter is also required.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="swiftinfo_expires"
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>
Sets the expiration time in UNIX Epoch timestamp format.
</para>
</wadl:doc>
</param>'>
<!ENTITY delimiter-requestParameter '<param xmlns="http://wadl.dev.java.net/2009/02" name="delimiter"
style="query" required="false" type="xsd:char">
<wadl:doc xmlns="http://docbook.org/ns/docbook"

33
api-ref/src/wadls/object-api/src/os-object-api-1.0.wadl
View File

@ -76,6 +76,9 @@
</resource>
</resource>
</resource>
<resource id="info" path="//info">
<method href="#infoDiscoverability"/>
</resource>
</resources>
<!--*******************************************************-->
<!-- Resource Types -->
@ -93,6 +96,35 @@
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="infoDiscoverability">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
title="List activated capabilities">
<para role="shortdesc">
Lists the activated capabilities for this version of the
OpenStack Object Storage API.
</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
&info-requestParameter;
</representation>
</request>
<!--No request body is provided-->
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="samples/info_response.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
</response>
</method>
<!--*******************************************************-->
<method name="GET" id="listEndpoints">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
@ -127,7 +159,6 @@
</representation>
</response>
</method>
<!--*******************************************************-->
<!-- Account-level operations -->
<!--*******************************************************-->

7
api-ref/src/wadls/object-api/src/samples/info_response.json Normal file
View File

@ -0,0 +1,7 @@
{
"swift": {
"version": "1.11.0"
},
"staticweb": {},
"tempurl": {}
}