openstack/api-site
Code Issues Proposed changes

Add xml:ids to resources

Browse Source 
Add xml:ids to resources. This is a new requirement that has to do with
the generation of PDFs from WADL files – without this, the paths are
not unique across WADL files

Change-Id: I94fcc00d5325a723a4e100e612933f02dcef3311
Related-Bug: #1275007
This commit is contained in:
Andreas Jaeger 2014-01-31 20:05:50 +01:00 committed by Diane Fleming
parent 2894dea2a5
commit a2b5c9d918
6 changed files with 21 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/src/wadls/compute-api/src/ext/os-floating-ips-bulk.wadl
View File

@ -5,7 +5,8 @@
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com">
<resources base="https://servers.api.openstack.com"
xml:id="os-floating-ips-bulk-v2">
<resource id="version" type="#VersionDetails" path="v2">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"

4
api-ref/src/wadls/compute-api/src/ext/os-floating-ips.wadl
View File

@ -5,8 +5,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com">
<resources base="https://servers.api.openstack.com"
xml:id="os-floating-ips-v2">
<resource id="version" type="#VersionDetails" path="v2">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"

4
api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl
View File

@ -11,7 +11,6 @@
<!ENTITY % common SYSTEM "common.ent">
%common;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
xmlns:HP-IDM="http://docs.openstack.org/identity/api/ext/HP-IDM/v1.0"
@ -28,9 +27,8 @@
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357">
<resources base="http://localhost:35357" xml:id="RAX-KSKEY-admin-v2.0">
<resource id="version" path="v2.0">
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">

16
api-ref/src/wadls/netconn-api/src/metering-labels.wadl
View File

@ -1,9 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application [<!ENTITY % common SYSTEM "common.ent">
%common;]>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -13,7 +11,8 @@
<grammars>
<include href="../xsd/metering.xsd"/>
</grammars>
<resources base="https://servers.api.openstack.com/">
<resources base="https://servers.api.openstack.com/"
xml:id="metering-labels-v2.0">
<resource id="version">
<resource id="metering_labels" path="metering-labels">
<method href="#listMeteringLabels"/>
@ -24,7 +23,7 @@
type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the metering
label. </p></doc>
label.</p></doc>
</param>
<method href="#getMeteringLabel"/>
<method href="#deleteMeteringLabel"/>
@ -38,8 +37,7 @@
<param name="metering-label-rule-id"
style="template" type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of metering label rule.
</p></doc>
The unique identifier of metering label rule.</p></doc>
</param>
<method href="#getMeteringLabelRule"/>
<method href="#deleteMeteringLabelRule"/>
@ -85,8 +83,7 @@
<method name="POST" id="createMeteringLabel">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create Metering Label">
<para role="shortdesc">Creates a l3 metering label.
</para>
<para role="shortdesc">Creates a l3 metering label.</para>
<para>This operation requires a request body.</para>
<para>The following table describes the required and
optional attributes in the request body:</para>
@ -104,8 +101,7 @@
</para></td></tr>
</tbody></table>
<para>This operation returns a response body, which
contains the following informations about the metering label:
</para>
contains the following informations about the metering label:</para>
<itemizedlist><listitem><para><code>name</code>.
Name of the metering label.</para></listitem>
<listitem><para><code>description</code>. Description of

2
api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl
View File

@ -12,7 +12,7 @@
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:Enum="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<resources base="http://www.example.com">
<resources base="http://www.example.com" xml:id="os-telemetry-api-v2.0">
<resource path="v2" id="v2">
<resource path="alarms" id="alarms">
<method href="#listAlarms"/>

18
api-ref/src/wadls/volume-api/src/v1/volume-api.wadl
View File

@ -4,7 +4,7 @@
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/api/openstack-block-storage/1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://volume.example.com/">
<resources base="https://volume.example.com/" xml:id="volume-api-v1.0">
<resource id="version" path="v1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"
@ -12,7 +12,7 @@
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">The
unique identifier of the tenant or
account. </p>
account.</p>
</doc>
</param>
<resource id="volumes" path="volumes">
@ -27,7 +27,7 @@
<doc><p
xmlns="http://www.w3.org/1999/xhtml"
> The unique identifier of an
existing Volume. </p></doc>
existing Volume.</p></doc>
</param>
<method href="#getVolume"/>
<method href="#deleteVolume"/>
@ -41,7 +41,7 @@
<doc><p
xmlns="http://www.w3.org/1999/xhtml"
>The unique identifier of an
existing volume type. </p></doc>
existing volume type.</p></doc>
</param>
<method href="#getVolumeType"/>
</resource>
@ -58,7 +58,7 @@
<doc><p
xmlns="http://www.w3.org/1999/xhtml"
>The unique identifier of an
existing snapshot. </p></doc>
existing snapshot.</p></doc>
</param>
<method href="#getSnapshot"/>
<method href="#deleteSnapshot"/>
@ -78,7 +78,7 @@
type="csapi:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A
partial representation of a volume used in the
creation process. </p></doc>
creation process.</p></doc>
</param>
<representation mediaType="application/xml">
<doc xml:lang="EN">
@ -222,7 +222,7 @@
type="csapi:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">A
partial representation of a snapshot used in
the creation process. </p></doc>
the creation process.</p></doc>
</param>
<representation mediaType="application/xml">
<doc xml:lang="EN">
@ -273,7 +273,7 @@
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Snapshots (Detailed)">
<p xmlns="http://www.w3.org/1999/xhtml">Lists
details for snapshot entities. </p>
details for snapshot entities.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
@ -294,7 +294,7 @@
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Describe Snapshot">
<p xmlns="http://www.w3.org/1999/xhtml">Shows
information about a specified snapshot. </p>
information about a specified snapshot.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">