openstack/api-site
Code Issues Proposed changes

Edits to fix makeswagger error "WARNING No tags for method listVersions"

Browse Source 
Also updates the tools/build-api-ref-swagger.sh script so that
the errant WADL file name is output.

Change-Id: I312c0be565983950a9fce0f6d653eacdcef2695c
This commit is contained in:
Anne Gentle 2016-04-04 15:39:55 -05:00 committed by Anne Gentle
parent 0ec6c87f43
commit c4d648d3e5
3 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/src/docbkx/ch_share-v2.xml
View File

@ -45,16 +45,18 @@
History of all Manila API changes. History of all Manila API changes.
</link> </link>
</para> </para>
<!-- <section xml:id="share-versions"> <section xml:id="share-versions">
<title>API versions</title> <title>API versions</title>
<para> <para>
Lists information for all Shared File Systems API versions. Lists information for all Shared File Systems API versions.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-versions-v2"/> <wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-versions-v2"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-version-v2"/> <wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-version">
<wadl:method href="#listVersions" />
</wadl:resource>
</wadl:resources> </wadl:resources>
</section> --> </section>
<section xml:id="share-extensions"> <section xml:id="share-extensions">
<title>API extensions</title> <title>API extensions</title>
<para> <para>

5
api-ref/src/wadls/share-api/src/v2/wadl/os-share-v2.wadl
View File

@ -20,13 +20,12 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para> <para>
The HTTP header to specify a valid Shared File Systems API The HTTP header to specify a valid Shared File Systems API
micro-version. For example, <code>"X-Openstack-Manila-Api-Version: microversion. For example, <code>"X-Openstack-Manila-Api-Version:
2.15"</code>. If you omit this header, the default micro- version is 2.6"</code>. If you omit this header, the default microversion is
2.0. 2.0.
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
<method href="#listVersions"/>
<resource id="share-version" path="v2"> <resource id="share-version" path="v2">
<resource id="tenant_id" path="{tenant_id}"> <resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter; &tenant_idTemplateParameter;

7
tools/build-api-ref-swagger.sh
View File

@ -25,8 +25,11 @@ function convert_to_swagger {
find api-ref/src/docbkx/ -name api-ref-\* -type f -exec fairy-slipper-docbkx-to-json -o swagger {} \; find api-ref/src/docbkx/ -name api-ref-\* -type f -exec fairy-slipper-docbkx-to-json -o swagger {} \;
# Generate Swagger # Generate Swagger
find swagger -name api-ref\*json -type f -exec fairy-slipper-wadl-to-swagger-valid -o swagger {} \; for file in swagger/*.json
do
echo $file
fairy-slipper-wadl-to-swagger-valid $file -o swagger
done
# Remove interim JSON files # Remove interim JSON files
rm -r swagger/api-ref* rm -r swagger/api-ref*