openstack-attic/netconn-api
Code Issues Proposed changes

Fix wadl validation problems

Browse Source 
Removed wadl files - the source wadl files are in api-site
I'll fix wadl files in api-site

Closes-Bug: #1264347

Change-Id: I62db5f663e6e390cce0d7e3cc413cebb7b508bb1
author: diane fleming
This commit is contained in:
Diane Fleming 2014-01-05 15:46:33 -06:00
parent e111f5dffa
commit 5aae2e5f73
12 changed files with 629 additions and 2132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
v2.0/neutron-metering-ext.xml
View File

@ -36,8 +36,7 @@
xmlns:db="http://docbook.org/ns/docbook" version="5.0"
status="final" xml:id="metering-ext"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<title>Metering Labels and Rules</title>
<title>Metering labels and rules</title>
<para>Creates, modifies, and deletes OpenStack Layer3 Metering labels
and rules.</para>
<wadl:resources href="wadl/metering-labels.wadl"/>

4
v2.0/section_neutron-provider-ext.xml
View File

@ -124,10 +124,10 @@
<para>This section discusses operations for setting and
retrieving the provider networks extension attributes for
network objects.</para>
<!-- <wadl:resources
<!-- <wadl:resources
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/netconn-api/src/os-networks-provider-ext.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> -->
<section xml:id="provider_network_list">
<section xml:id="provider_network_list">
<title>List Networks</title>
<para>
<informaltable rules="all" width="100%">

2
v2.0/section_neutron_binding_ext_ports.xml
View File

@ -150,7 +150,7 @@
</tr>
</tbody>
</table>
<!-- <wadl:resources
<!-- <wadl:resources
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/netconn-api/src/os-ports-binding-ext.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>-->
<section xml:id="List_Ports_binding">

14
v2.0/section_neutron_list-extensions.xml
View File

@ -42,20 +42,20 @@
</note>
<para>The following example response shows a list of
extensions:</para>
<literallayout class="monospaced">Status Code: 200 OK
Connection: keep-alive
Content-Length: 654
Content-Type: application/xml; charset=UTF-8
Date: Wed, 12 Sep 2012 11:32:56 GMT</literallayout>
<screen><computeroutput>Status Code: 200 OK
Connection: keep-alive
Content-Length: 654
Content-Type: application/xml; charset=UTF-8
Date: Wed, 12 Sep 2012 11:32:56 GMT</computeroutput></screen>
<programlisting language="xml"><xi:include href="samples/extensionsv2.xml" parse="text"/></programlisting>
<para>Also, you can query for specific extension using the
extension alias. For instance, querying
<literal>/v2.0/extensions/router</literal>, results in the
following response:</para>
<literallayout class="monospaced">Status Code: 200 OK
<screen><computeroutput>Status Code: 200 OK
Connection: keep-alive
Content-Length: 350
Content-Type: application/xml; charset=UTF-8
Date: Wed, 12 Sep 2012 11:36:20 GMT</literallayout>
Date: Wed, 12 Sep 2012 11:36:20 GMT</computeroutput></screen>
<programlisting language="xml"><xi:include href="samples/extension.xml" parse="text"/></programlisting>
</section>

618
v2.0/wadl/common.ent Normal file
View File

@ -0,0 +1,618 @@
<!--
A collection of common faults, these are pretty much expected
in every request.
-->
<!ENTITY commonFaults
'
<response xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:computeFault"/>
<representation mediaType="application/json"/>
</response> '>
<!ENTITY fault503
'
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY fault503macGeneration
'
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:macGenerationFailure"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY fault400
'
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badRequest"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY fault401
'
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unauthorized"/>
<representation mediaType="application/json"/>
</response> '>
<!ENTITY fault403
' <response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:forbidden"/>
<representation mediaType="application/json"/>
</response> '>
<!ENTITY fault404
'
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY fault405
' <response status="405" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMethod"/>
<representation mediaType="application/json"/>
</response> '>
<!ENTITY fault409
'
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="osapi:buildInProgress"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY fault409networkInUse
'
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:networkInUse"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY fault409conflict
'
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:conflict"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY fault413
' <response status="413" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:overLimit"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY fault415
'
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMediaType"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault422
'<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:HTTPUnprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Faults that can occur when we are building servers or images.
-->
<!ENTITY buildFaults
'
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serverCapacityUnavailable"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Holds build in progress which occurs when an operation fails
because the server is in the process of being built.
-->
<!ENTITY networkListParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="admin_state_up" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The administrative state of the network.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The network ID.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The network name.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="shared" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Indicates whether this network is shared across all tenants.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="status" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The network status.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="subnets" style="plain" type="xsd:dict">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The associated subnets.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The tenant ID.</para></wadl:doc>
</param>
'>
<!-- Network Create Parameters -->
<!ENTITY networkCreateParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="admin_state_up" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The administrative state of the network.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http:/docbook.org/ns/docbook" xml:lang="EN">
<para>The network name.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="shared" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Admin-only. Indicates whether this network is shared across all tenants.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the tenant that owns the network. Only administrative users can specify a tenant ID other than their own. You cannot change this value through authorization policies.</para></wadl:doc>
</param>
'>
<!-- Network Provider Parameters -->
<!ENTITY networkProviderParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="provider:physical_network" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The physical network where this network object is implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each Compute host.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="provider:network_type" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The type of physical network that maps to this network resource. Examples are flat, vlan, vxlan, and gre.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="provider:segmentation_id" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>An isolated segment on the physical network. The network_type attribute defines the segmentation model. For example, if network_type is vlan, this ID is a vlan identifier. If network_type is gre, this ID is a gre key.</para></wadl:doc>
</param>
'>
<!ENTITY portListParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="status" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The port status. Value is UP or DOWN.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The port name.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="admin_state_up" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The administrative state of the router.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="network_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the attached network.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="binding:vif_type" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The VIF type.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="device_owner" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the entity that uses this port. For example, a dhcp agent.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="binding:capabilities" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The binding capabilities.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="port_filter" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The port filter.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="mac_address" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The MAC address of the port.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="fixed_ips" style="plain" type="xsd:dict">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>IP addresses for the port. Includes the IP address and subnet ID. </para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the port.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="device_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the device that uses this port. For example, a virtual server.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="security_groups" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The IDs of any attached security groups.</para></wadl:doc>
</param>
'>
<!-- Port Create Parameters -->
<!ENTITY portCreateParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="status" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The status of the port.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="name" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A symbolic name for the port.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="admin_state_up" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The administrative status of the router. Set to true for UP. Set to false for DOWN.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="mac_address" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The MAC address. If you specify an address that is not valid, a 400 Bad Request error is returned. If you do not specify a MAC address, OpenStack Networking tries to allocate one. If a failure occurs, a 503 Service Unavailable error is returned.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="fixed_ips" style="plain" type="xsd:dict">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>If you specify only a subnet ID, OpenStack Networking allocates an available IP from that subnet to the port. If you specify both a subnet ID and an IP address, OpenStack Networking tries to allocate the specified address to the port.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="security_groups" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Security groups. Specify one or more security group IDs.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="network_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the The network ID.</para></wadl:doc>
</param>
'>
<!-- Port binding Parameters -->
<!ENTITY portBindingParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="binding:vif_type" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Read-only. The The vif type for the specified port.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="binding:host_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the host where the port is allocated. In some cases, different implementations can run on different hosts.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="binding:profile" style="plain" type="xsd:dict">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A dictionary the enables the application running on the specified host to pass and receive vif port-specific information to the plug-in.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="binding:capabilities" style="plain" type="xsd:dict">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Read-only. A dictionary that enables the application to pass information about functions that the Networking API povides. Specify the following value: port_filter : Boolean to define whether port filtering features such as security group and anti-MAC/IP spoofing are provided.</para></wadl:doc>
</param>
'>
<!-- Subnet Parameters -->
<!ENTITY subnetListParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The subnet name.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="network_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the attached network.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="allocation_pools" style="plain" type="xsd:dict">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The start and end addresses for the allocation pools.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="gateway_ip" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The gateway IP address.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="ip_version" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The IP version, which is 4 or 6.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="cidr" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The CIDR.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the subnet.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="enable_dhcp" style="plain" type="xsd:boolean">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Set to true if DHCP is enabled and false if DHCP is disabled.</para></wadl:doc>
</param>
'>
<!-- Subnet Create Parameters -->
<!ENTITY subnetCreateParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="name" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The subnet name.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="network_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the attached network.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="allocation_pools" style="plain" type="xsd:dict">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The start and end addresses for the allocation pools.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="gateway_ip" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The gateway IP address.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="ip_version" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The IP version, which is 4 or 6.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="cidr" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The CIDR.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the subnet.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="enable_dhcp" style="plain" type="xsd:boolean">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Set to true if DHCP is enabled and false if DHCP is disabled.</para></wadl:doc>
</param>
'>
<!-- Server List Parameters -->
<!ENTITY serverListParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="changes-since" style="query" required="false" type="xsd:dateTime">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A time/date stamp for when the server last changed status.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="image" style="query" required="false" type="xsd:anyURI">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Name of the image in URL format.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="flavor" style="query" required="false" type="xsd:anyURI">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Name of the flavor in URL format.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style"query" required="false" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Name of the server as a string.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="marker" style="query" required="false" type="csapi:UUID">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>UUID of the server at which you want to set a marker.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" required="false" type="xsd:int">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Integer value for the limit of values to return.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="query" required="false" type="csapi:ServerStatus">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Value of the status of the server so that you can filter on "ACTIVE" for example.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="host" style"query" required="false" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Name of the host as a string.</para></wadl:doc>
</param>
'>
<!-- Flavor List Parameters -->
<!ENTITY flavorListParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="changes-since" style="query" required="false" type="xsd:dateTime">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A time/date stamp for when the flavor last changed.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minDisk" style="query" required="false" type="xsd:int">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Integer value for the minimum disk space in GB so you can filter results.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minRam" style="query" required="false" type="xsd:int">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Integer value for the minimum RAM so you can filter results.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="marker" style="query" required="false" type="csapi:UUID">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>UUID of the flavor at which you want to set a marker.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" required="false" type="xsd:int">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Integer value for the limit of values to return.</para></wadl:doc>
</param>
'>
<!ENTITY securityGroupRule
'
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_group_rules"
type="xsd:string" required="true">
<wadl:doc xml:lang="EN" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook">
<para>Security group rule object.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="direction"
type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>Either ingress or egress.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="ethertype"
type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>Either IPv4 or IPv6.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id"
type="csapi:uuid" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The ID for the security group rule.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="port_range_max"
type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The maximum port ranges. Set to
null.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="port_range_min"
type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The minimum port ranges. Set to
null.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="protocol"
type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The protocol. Set to null.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="remote_group_id"
type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The remote group ID. Set to
null.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="remote_ip_prefix"
type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The remote IP prefix. Set to
null.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_group_id"
type="csapi:uuid" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The security group ID for the security group with
which the rule is
associated.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="tenant_id"
type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The tenant ID.</para></wadl:doc>
</param>'>
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>

256
v2.0/wadl/os-networks-provider-ext.wadl
View File

@ -1,256 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-networks-provider-ext.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns="http://wadl.dev.java.net/2009/02"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:atom="http://www.w3.org/2005/Atom"
xsi:schemaLocation="http://docs.openstack.org/compute/api/v1.1
xsd/api.xsd
http://docs.openstack.org/common/api/v1.0
xsd/api-common.xsd
http://wadl.dev.java.net/2009/02
http://www.w3.org/Submission/wadl/wadl.xsd">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/">
<resource id="version" type="#VersionDetails" path="v2.0">
<resource id="Networks" type="#NetworkList"
path="networks">
<method href="#listNetworks"/>
<param name="name" style="plain" type="xsd:string">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">The
network name.</p>
</doc>
</param>
<param name="admin_state_up" style="plain"
type="xsd:bool">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml"
>Indicates the administrative status of
the network.</p>
</doc>
</param>
<param name="shared" style="plain" type="xsd:bool">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml"
>Indicates whether this network is shared
across all tenants. By default, only
administrative users can change this
value.</p>
</doc>
</param>
<param name="tenant_id" style="plain"
type="csapi:uuid">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">The ID
of the tenant that owns the network. Only
administrative users can set the tenant
ID. You cannot change this value through
authorization policies.</p>
</doc>
</param>
<param name="provider:network_type" style="plain"
type="xsd:string">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">The
type of physical network that maps to this
networks resource. Examples are flat,
vlan, and gre.</p>
</doc>
</param>
<param name="provider:physical_network" style="plain"
type="xsd:string">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">The
physical network on which this network
object is implemented. The Networking API
v2.0 does not provide a way to list
available physical networks. For example,
the Open vSwitch plug-in configuration
file defines a symbolic name that maps to
specific bridges on each Compute host.</p>
</doc>
</param>
<param name="provider:segmentation_id" style="plain"
type="csapi:uuid">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">An
isolated segment on the physical network.
The network_type attribute defines the
segmentation model. For example, if
network_type is vlan, this ID is a vlan
identifier. If network_type is gre, this
ID is a gre key.</p>
</doc>
</param>
<method href="#createNetwork"/>
<resource path="{network_id}">
<param name="network_id" style="template"
type="csapi:UUID">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml"
xml:lang="EN" title="Network ID">
<p>The UUID for the network of interest to
you.</p>
</wadl:doc>
</param>
<method href="#showNetwork"/>
<method href="#updateNetwork"/>
<method href="#deleteNetwork"/>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listNetworks">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Networks">
<p xmlns="http://www.w3.org/1999/xhtml">Lists networks
that are accessible to the tenant who submits the
request.</p>
</wadl:doc>
<response status="200"> &networkListParameters;
&networkProviderParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-get-detail-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-get-detail-resp.xml"
/>
</doc>
</representation>
</response>
</method>
<method name="POST" id="createNetwork">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Create Network">
<p xmlns="http://www.w3.org/1999/xhtml">Creates a
network.</p>
</wadl:doc>
<request> &networkCreateParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-post-req.json"/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-post-req.xml"/>
</doc>
</representation>
</request>
<response status="201"> &networkListParameters;
&networkProviderParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-post-resp.json"/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-post-resp.xml"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="showNetwork">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Show Networks">
<p xmlns="http://www.w3.org/1999/xhtml">Shows information
for the specified network.</p>
</wadl:doc>
<response status="200"> &networkListParameters;
&networkProviderParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-get-detail-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-get-detail-resp.xml"
/>
</doc>
</representation>
</response>
</method>
<method name="PUT" id="updateNetwork">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Update Network">
<p xmlns="http://www.w3.org/1999/xhtml">Updates the
specified network.</p>
</wadl:doc>
<request> &networkCreateParameters;
&networkProviderParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-put-update.req.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-put-update.req.xml"
/>
</doc>
</representation>
</request>
<response status="201"> &networkListParameters;
&networkProviderParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-put-update-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-put-update-resp.xml"
/>
</doc>
</representation>
</response>
</method>
</application>

538
v2.0/wadl/os-networks.wadl
View File

@ -1,538 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-networks.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}">
<param name="tenant_id" style="template"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The tenant ID in a multi-tenancy
cloud.</para>
</wadl:doc>
</param>
<resource id="Networks" type="#NetworkList"
path="networks">
<method href="#listNetworks"/>
<method href="#createNetwork"/>
<method href="#bulkCreateNetwork"/>
<!-- <resource id="server_detail" path="detail"
type="#DetailServerList"/>-->
<resource path="{network_id}">
<param name="network_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Network ID">
<para>The UUID for the network of
interest to you.</para></wadl:doc>
</param>
<method href="#showNetwork"/>
<method href="#updateNetwork"/>
<method href="#deleteNetwork"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!-- <resource id="Networks" type="#NetworkList"
path="networks">
<method href="#listNetworks"/>
&networkCreateParameters;
<method href="#createNetwork"/>
<method href="#bulkCreateNetwork"/>
<resource path="{network_id}">
<param name="network_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Network ID">
<para>The UUID for the network of
interest to you.</para></wadl:doc>
</param>
<method href="#showNetwork"/>
<method href="#updateNetwork"/>
<method href="#deleteNetwork"/>
</resource>
</resource>
</resource>
</resource>
</resources>-->
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listNetworks">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Networks">
<para role="shortdesc">Lists networks to which the
specified tenant has access.</para>
<para>You can control which attributes are returned by
using the fields query parameter. For information, see
<link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
</wadl:doc>
<response status="200">
<param required="true" name="admin_state_up" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether the
administrative state of the network is up or
down.</para></wadl:doc>
</param>
<param required="true" name="id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
ID.</para></wadl:doc>
</param>
<param required="true" name="name" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
name.</para></wadl:doc>
</param>
<param required="true" name="shared" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether this network
is shared across all tenants. By default, only
administrative users can change this
value.</para></wadl:doc>
</param>
<param required="true" name="status" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
status.</para></wadl:doc>
</param>
<param required="true" name="subnets" style="plain"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The associated
subnets.</para></wadl:doc>
</param>
<param required="true" name="tenant_id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-get-resp.json"/>
</doc>
</representation>
<representation mediaType="application/xml"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-get-resp.xml"/>
</doc>
</representation>
</response> &fault401; </method>
<method name="POST" id="createNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create Network">
<para role="shortdesc">Creates a network.</para>
</wadl:doc>
<request>
<param required="false" name="admin_state_up"
style="plain" type="xsd:bool">
<doc
xml:lang="EN"><p xmlns="http://www.w3.org/1999/xhtml">The administrative state of
the network.</p></doc>
</param>
<representation mediaType="application/json"
element="csapi:network">
<!-- <param required="true" name="name" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
name.</para></wadl:doc>
</param>
<param required="false" name="shared" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Admin-only. Indicates whether
this network is shared across all
tenants.</para></wadl:doc>
</param>
<param required="false" name="tenant_id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the tenant that owns
the network. Only administrative users can
specify a tenant ID other than their own. You
cannot change this value through authorization
policies.</para></wadl:doc>
</param>-->
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/network-post-req.json"/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:network">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/network-post-req.xml"/>
</wadl:doc>
</representation>
</request>
<response status="201">
<param required="true" name="admin_state_up" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether the
administrative state of the network is up or
down.</para></wadl:doc>
</param>
<param required="true" name="id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
ID.</para></wadl:doc>
</param>
<param required="true" name="name" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
name.</para></wadl:doc>
</param>
<param required="true" name="shared" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether this network
is shared across all tenants. By default, only
administrative users can change this
value.</para></wadl:doc>
</param>
<param required="true" name="status" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
status.</para></wadl:doc>
</param>
<param required="true" name="subnets" style="plain"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The associated
subnets.</para></wadl:doc>
</param>
<param required="true" name="tenant_id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-post-resp.json"/>
</doc>
</representation>
<representation mediaType="application/xml"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-post-resp.xml"/>
</doc>
</representation>
</response> &fault400; &fault401; </method>
<method name="POST" id="bulkCreateNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Bulk Create Networks">
<para role="shortdesc">Creates multiple networks in a
single request.</para>
<para>In the request body, specify a list of
networks.</para>
<para>The bulk create operation is always atomic. Either
all or no networks in the request body are
created.</para>
</wadl:doc>
<request> &networkCreateParameters; <representation
mediaType="application/json" element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-post-create-bulk-req.json"
/>
</doc>
</representation>
<representation mediaType="application/xml"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-post-create-bulk-req.xml"
/>
</doc>
</representation>
</request>
<response status="201">
<param required="true" name="admin_state_up" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether the
administrative state of the network is up or
down.</para></wadl:doc>
</param>
<param required="true" name="id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
ID.</para></wadl:doc>
</param>
<param required="true" name="name" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
name.</para></wadl:doc>
</param>
<param required="true" name="shared" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether this network
is shared across all tenants. By default, only
administrative users can change this
value.</para></wadl:doc>
</param>
<param required="true" name="status" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
status.</para></wadl:doc>
</param>
<param required="true" name="subnets" style="plain"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The associated
subnets.</para></wadl:doc>
</param>
<param required="true" name="tenant_id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-create-bulk-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-create-bulk-resp.xml"
/>
</doc>
</representation>
</response> &fault400; &fault401; </method>
<method name="GET" id="showNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Network">
<para role="shortdesc">Shows information for a specified
network.</para>
<para>You can control which attributes are returned by
using the fields query parameter. For information, see
<link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
</wadl:doc>
<response status="200">
<param required="true" name="admin_state_up" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether the
administrative state of the network is up or
down.</para></wadl:doc>
</param>
<param required="true" name="id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
ID.</para></wadl:doc>
</param>
<param required="true" name="name" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
name.</para></wadl:doc>
</param>
<param required="true" name="shared" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether this network
is shared across all tenants. By default, only
administrative users can change this
value.</para></wadl:doc>
</param>
<param required="true" name="status" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
status.</para></wadl:doc>
</param>
<param required="true" name="subnets" style="plain"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The associated
subnets.</para></wadl:doc>
</param>
<param required="true" name="tenant_id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-get-detail-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/networks-get-detail-resp.xml"
/>
</doc>
</representation>
</response> &fault401; &fault404; </method>
<method name="PUT" id="updateNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update Network">
<para role="shortdesc">Updates a specified network.</para>
</wadl:doc>
<request> &networkCreateParameters; <representation
mediaType="application/json" element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-put-update.req.json"
/>
</doc>
</representation>
<representation mediaType="application/xml"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-put-update.req.xml"
/>
</doc>
</representation>
</request>
<response status="200">
<param required="true" name="admin_state_up" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether the
administrative state of the network is up or
down.</para></wadl:doc>
</param>
<param required="true" name="id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
ID.</para></wadl:doc>
</param>
<param required="true" name="name" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
name.</para></wadl:doc>
</param>
<param required="true" name="shared" style="plain"
type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Indicates whether this network
is shared across all tenants. By default, only
administrative users can change this
value.</para></wadl:doc>
</param>
<param required="true" name="status" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The network
status.</para></wadl:doc>
</param>
<param required="true" name="subnets" style="plain"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The associated
subnets.</para></wadl:doc>
</param>
<param required="true" name="tenant_id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-put-update-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml"
element="csapi:network">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/network-put-update-resp.xml"
/>
</doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404; </method>
<method name="DELETE" id="deleteNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Network">
<para role="shortdesc">Deletes a specified network and its
associated resources.</para>
</wadl:doc>
<response status="204"/> &fault401; &fault404;
&fault409conflict; </method>
</application>

140
v2.0/wadl/os-ports-binding-ext.wadl
View File

@ -1,140 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-ports-binding-ext.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns="http://wadl.dev.java.net/2009/02"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:atom="http://www.w3.org/2005/Atom"
xsi:schemaLocation="http://docs.openstack.org/compute/api/v1.1
xsd/api.xsd
http://docs.openstack.org/common/api/v1.0
xsd/api-common.xsd
http://wadl.dev.java.net/2009/02
http://www.w3.org/Submission/wadl/wadl.xsd">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/">
<resource id="version" type="#VersionDetails" path="v2">
<resource id="Ports" type="#PortList" path="ports">
<method href="#listPorts" />
<method href="#createPort" />
<resource path="{port_id}">
<param name="port_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Port ID">
<para>The UUID for the port of interest to you.</para></wadl:doc>
</param>
<method href="#showPort"/>
<method href="#updatePort"/>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listPorts">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Ports">
<para role="shortdesc">Lists ports to which the tenant has access.</para>
</wadl:doc>
<response status="200"> &portListParameters; &portBindingParameters;
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/ports-get-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/ports-get-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="createPort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create Port">
<para role="shortdesc">Creates a port on the specified network.</para>
</wadl:doc>
<!-- Need to verify, samples are mixed -->
<request> &portCreateParameters; &portBindingParameters; <representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/port-post-create-req.json" />
</doc>
</representation>
</request>
<response status="200"> &portListParameters; &portBindingParameters;
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/port_create_or_update_resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/port_create_or_update_resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="showPort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show Port">
<para role="shortdesc">Shows information for the specified port.</para>
</wadl:doc>
<!-- Need to verify, samples are mixed -->
<response status="200"> &portListParameters; &portBindingParameters;
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/port-get-resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/port-get-resp.xml" />
</doc>
</representation>
</response>
</method>
<method name="PUT" id="updatePort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update Port">
<para role="shortdesc">Updates the specified port.</para>
</wadl:doc>
<!-- Need to verify, samples are mixed -->
<request> &portCreateParameters; &portBindingParameters; <representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/port-post-create-req.json" />
</doc>
</representation>
</request>
<response status="200"> &portListParameters; &portBindingParameters;
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/port_create_or_update_resp.json" />
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/port_create_or_update_resp.xml" />
</doc>
</representation>
</response>
</method>
</application>

246
v2.0/wadl/os-ports.wadl
View File

@ -1,246 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-ports.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}">
<param name="tenant_id" style="template"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The tenant ID in a multi-tenancy
cloud.</para>
</wadl:doc>
</param>
<resource id="Ports" type="#PortList" path="ports">
<method href="#listPorts"/>
<method href="#createPort"/>
<method href="#bulkCreatePorts"/>
<resource path="{port_id}">
<param name="port_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Port ID">
<para>The UUID for the port of
interest to you.</para></wadl:doc>
</param>
<method href="#showPort"/>
<method href="#updatePort"/>
<method href="#removePort"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listPorts">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Ports">
<para role="shortdesc">Lists ports to which the tenant has
access.</para>
<para>Default policy settings return only those subnets
that are owned by the tenant who submits the request,
unless the request is submitted by an user with
administrative rights. Users can control which
attributes are returned by using the fields query
parameter. Additionally, you can filter results by
using query string parameters. For information, see
<link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
</wadl:doc>
<response status="200"> &portListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/ports-get-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/ports-get-resp.xml"
/>
</doc>
</representation>
</response> &fault401; </method>
<method name="POST" id="createPort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create Port">
<para role="shortdesc">Creates a port on a specified
network.</para>
<para>You must specify the network where the port is to
created in the <code>network_id</code> attribute in
the request body.</para>
</wadl:doc>
<request> &portCreateParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/port-post-create-req.json"/>
</doc>
</representation>
</request>
<response status="201"> &portListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/port_create_or_update_resp.json"
/>
</doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404;
&fault503macGeneration; &fault503; </method>
<method name="POST" id="bulkCreatePorts">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Bulk Create Ports">
<para role="shortdesc">Creates multiple ports in a single
request. Specify a list of ports in the request
body.</para>
<para>Guarantees the atomic completion of the bulk
operation.</para>
</wadl:doc>
<request> &portCreateParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/ports-post-create-bulk-req.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/ports-post-create-bulk-req.xml"
/>
</doc>
</representation>
</request>
<response status="201"> &portListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/ports-create-bulk-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/ports-create-bulk-resp.xml"
/>
</doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404;
&fault409conflict; &fault503macGeneration; </method>
<method name="GET" id="showPort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Port">
<para role="shortdesc">Shows information for a specified
port.</para>
</wadl:doc>
<response status="200"> &portListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/ports-get-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/ports-get-resp.xml"
/>
</doc>
</representation>
</response> &fault401; &fault404; </method>
<method name="PUT" id="updatePort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update Port">
<para role="shortdesc">Updates a specified port.</para>
<para>You can update information for a port, such as its
symbolic name and associated IPs. When you update IPs
for a port, any previously associated IPs are removed,
returned to the respective subnets allocation pools,
and replaced by the IPs specified in the body for the
update request. Therefore, this operation replaces the
<code>fixed_ip</code> attribute when it is
specified in the request body. If the updated IP
addresses are not valid or are already in use, the
operation fails and the existing IP addresses are not
removed from the port.</para>
<para>When you update security groups for a port and the
operation succeeds, any associated security groups are
removed and replaced by the security groups specified
in the body for the update request. Therefore, this
operation replaces the <code>security_groups</code>
attribute when you specify it in the request body.
However, if the specified security groups are not
valid, the operation fails and the existing security
groups are not removed from the port.</para>
</wadl:doc>
<request> &portCreateParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/port-post-create-req.json"/>
</doc>
</representation>
</request>
<response status="200"> &portListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/port_create_or_update_resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/port_create_or_update_resp.xml"
/>
</doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404;
&fault409conflict; </method>
<method name="DELETE" id="removePort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Port">
<para role="shortdesc">Deletes a specified port.</para>
<para>Any IP addresses that are associated with the port
are returned to the respective subnets allocation
pools.</para>
</wadl:doc>
<response status="204"/> &fault401; &fault403; &fault404;
</method>
</application>

162
v2.0/wadl/os-quotas.wadl
View File

@ -1,162 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-quotas.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "common.ent">
%common;]>
<application xmlns:capi="http://docs.openstack.org/common/api/v1.0"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:csapi="http://docs.openstack.org/netconn/api/v1.0"
xmlns:osapi="http://docs.openstack.org/netconn/api/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:atom="http://www.w3.org/2005/Atom"
xsi:schemaLocation="http://docs.openstack.org/netconn/api/v1.0
xsd/api.xsd
http://docs.openstack.org/common/api/v1.0
xsd/common.xsd
http://wadl.dev.java.net/2009/02
http://www.w3.org/Submission/wadl/wadl.xsd
">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}">
<param name="tenant_id" style="template"
type="csapi:UUID">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">The
tenant ID in a multi-tenancy cloud.</p>
</doc>
</param>
<resource id="Quotas" type="#QuotaList" path="quotas">
<method href="#listQuotas"/>
<resource path="{quota_id}">
<param name="quota_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Quota ID">
<p>The UUID for the quota of interest to you.</p></wadl:doc>
</param>
<method href="#showQuota"/>
<method href="#updateQuota"/>
<method href="#resetQuota"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listQuotas">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook" title="List Quotas">
<para role="shortdesc">Lists quotas for tenants who have non-default quota values.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/quotas-list-res.json" />
</doc>
</representation>
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="showQuota">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook" title="Show Quota">
<para role="shortdesc">
Shows information for a specified quota.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/quotas-show-res.json" />
</doc>
</representation>
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="osapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="osapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="PUT" id="updateQuota">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook" title="Update Quota">
<para role="shortdesc">
Updates quotas for a specified tenant. Use when non-default quotas are desired.
</para>
</wadl:doc>
<request><representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/quotas-put-req.json" />
</doc>
</representation></request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/quotas-put-res.json" />
</doc>
</representation>
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="osapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="osapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="DELETE" id="resetQuota">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook" title="Reset Quota">
<para role="shortdesc">
Resets quotas to default values for a specified tenant.
</para>
</wadl:doc>
<response status="204" />
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="osapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="osapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
</method>
</application>

284
v2.0/wadl/os-subnets.wadl
View File

@ -1,284 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-subnets.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}">
<param name="tenant_id" style="template"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The tenant ID in a multi-tenancy
cloud.</para>
</wadl:doc>
</param>
<resource id="Subnets" type="#SubnetList"
path="subnets">
<method href="#listSubnets"/>
<method href="#createSubnet"/>
<method href="#bulkCreateSubnet"/>
<resource path="{subnet_id}">
<param name="subnet_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Subnet ID">
<para>The UUID for the subnet of
interest to you.</para>
</wadl:doc>
</param>
<method href="#showSubnet"/>
<method href="#updateSubnet"/>
<method href="#removeSubnet"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listSubnets">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Subnets">
<para role="shortdesc">Lists subnets to which the
specified tenant has access.</para>
<para>Default policy settings returns exclusively subnets
owned by the tenant submitting the request, unless the
request is submitted by an user with administrative
rights. You can control which attributes are returned
by using the fields query parameter. You can filter
results by using query string parameters. For
information, see <link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-get-res.json"/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/subnets-get-res.xml"
/>
</doc>
</representation>
</response>
&fault401;
</method>
<method name="POST" id="createSubnet">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create Subnet">
<para role="shortdesc">Creates a subnet on a specified
network.</para>
<para>By default, OpenStack Networking creates IP v4
subnets. To create an IP v6 subnet, you must specify
the value 6 for the <code>ip_version</code> attribute
in the request body. OpenStack Networking does not try
to derive the correct IP version from the provided
CIDR. If the parameter for the gateway address,
<code>gateway_ip</code>, is not specified,
OpenStack Networking allocates an address from the
cidr for the gateway for the subnet.</para>
<para>To specify a subnet without a gateway, specify the
value null for the <code>gateway_ip</code> attribute
in the request body. If allocation pools attribute,
<code>allocation_pools</code>, is not specified,
OpenStack Networking automatically allocates pools for
covering all IP addresses in the CIDR, excluding the
address reserved for the subnet gateway. Otherwise,
you can explicitly specify allocation pools as shown
in the following example.</para>
<para>When <code>allocation_pools</code> and
<code>gateway_ip</code> are both specified, it is
up to the user to ensure that the gateway IP does not
overlap with the specified allocation pools; otherwise
a 409 Conflict error occurs.</para>
</wadl:doc>
<request> &subnetCreateParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-post-create-bulk-req.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-post-create-bulk-req.xml"
/>
</doc>
</representation>
</request>
<response status="201"> &subnetListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-create-bulk-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-create-bulk-resp.xml"
/>
</doc>
</representation>
</response>
&fault400; &fault401; &fault403; &fault404; &fault409conflict;
</method>
<method name="POST" id="bulkCreateSubnet">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create Subnet">
<para role="shortdesc">Creates multiple subnets in a
single request. Specify a list of subnets in the
request body.</para>
<para>The bulk create operation is always atomic. Either
all or no subnets in the request body are
created.</para>
</wadl:doc>
<request> &subnetCreateParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-post-create-bulk-req.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-post-create-bulk-req.xml"
/>
</doc>
</representation>
</request>
<response status="201"> &subnetListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-create-bulk-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnets-create-bulk-resp.xml"
/>
</doc>
</representation>
</response>
&fault400; &fault401; &fault403; &fault404; &fault409conflict;
</method>
<method name="GET" id="showSubnet">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Subnet">
<para role="shortdesc">Shows information for a specified
subnet.</para>
<para>You can control which attributes are returned by
using the fields query parameter. For information, see
<link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
</wadl:doc>
<response status="201"> &subnetListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/subnet-get-res.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/subnet-get-res.xml"
/>
</doc>
</representation>
</response>
&fault401; &fault404;
</method>
<method name="PUT" id="updateSubnet">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update Subnet">
<para role="shortdesc">Updates a specified subnet.</para>
<para>Some attributes, such as IP version (ip_version),
CIDR (cidr), and IP allocation pools
(allocation_pools) cannot be updated. Attempting to
update these attributes results in a 400 Bad Request
error.</para>
</wadl:doc>
<request> &subnetCreateParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnet-post-req.json"/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/subnet-post-req.xml"
/>
</doc>
</representation>
</request>
<response status="201"> &subnetListParameters; <representation
mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="api_samples/subnet-post-res.json"/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="api_samples/subnet-post-res.xml"
/>
</doc>
</representation>
</response>
&fault400; &fault401; &fault403; &fault404;
</method>
<method name="DELETE" id="removeSubnet">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Subnet">
<para role="shortdesc">Deletes a specified subnet.</para>
<para>The operation fails if subnet IP addresses are still
allocated.</para>
</wadl:doc>
<response status="204"/>
&fault401; &fault404; &fault409conflict;
</method>
</application>

494
v2.0/wadl/security-groups.wadl
View File

@ -1,494 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!-- (C) 2013 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"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://www.w3.org/2001/XMLSchema"
xmlns:secgr="http://docs.openstack.org/neutron/api/v2.0">
<grammars>
<include href="../xsd/secgr.xsd"/>
</grammars>
<resources base="https://servers.api.openstack.com/">
<resource id="version">
<resource id="security_groups" path="security-groups">
<method href="#listSecGroups"/>
<method href="#createSecGroup"/>
<resource id="get_security_group"
path="{security_group_id}">
<param name="security_group_id" style="template"
type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml"
>The unique identifier of the security
group. </p></doc>
</param>
<method href="#getSecGroup"/>
<method href="#deleteSecGroup"/>
</resource>
</resource>
<resource id="security_groups_rules"
path="security-group-rules">
<method href="#listSecGroupRules"/>
<method href="#createSecGroupRule"/>
<resource path="{rules-security-groups-id}">
<param name="rules-security-groups-id"
style="template" type="csapi:uuid">
<doc><p xmlns="http://www.w3.org/1999/xhtml"
>The unique identifier of the security
group rule. </p></doc>
</param>
<method href="#getSecGroupRule"/>
<method href="#deleteSecGroupRule"/>
</resource>
</resource>
<resource id="Servers" path="servers">
<resource path="{server_id}">
<param name="server_id" style="template"
type="csapi:UUID">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml"
>The UUID of the instance. </p>
</doc>
</param>
<resource path="os-security-groups">
<method href="#listSecGroupsByServer"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listSecGroups">
<wadl:doc xml:lang="EN" title="List Security Groups"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists a summary of all OpenStack
Networking security groups that the specified tenant
can access.</para>
<para>The list includes the unique ID for each security
group.</para>
<para>This operation does not require a request
body.</para>
<para>This operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN"><xsdxt:code
href="../samples/security-groups-list-get-req.json"
/></doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-list-get-resp.json"
/>
</doc>
</representation>
</response>
<response status="401"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:unauthorized"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="POST" id="createSecGroup">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create Security Group">
<para role="shortdesc">Creates an OpenStack Networking
security group.</para>
<para>This operation requires a request body. The request
body must include one or both of the following
attributes:</para>
<itemizedlist>
<listitem><para><code>name</code>. String. Specifies a
symbolic name for the security group. Not
required to be unique.</para></listitem>
<listitem>
<para><code>description</code>. String. Describes
the security group.</para></listitem>
</itemizedlist>
<para>This operation creates a security group with default
security group rules for the IPv4 and IPv6 ethertypes.
The following attributes of a security group rule have
a value of <code>null</code>:</para>
<itemizedlist><listitem><para><code>port_range_max</code></para></listitem>
<listitem><para><code>port_range_min</code></para></listitem>
<listitem><para><code>protocol</code></para></listitem>
<listitem><para><code>remote_group_id</code></para></listitem>
<listitem><para><code>remote_ip_prefix</code></para></listitem></itemizedlist>
<para>This operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-create-req.json"
/>
</doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-create-resp.json"
/>
</doc>
</representation>
</response>
<response status="400"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:unauthorized"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getSecGroup">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show Security Group">
<para role="shortdesc">Shows information for a specified
security group.</para>
<para>This operation does not require a request
body.</para>
<para>This operation returns a response body that contains
the description, name, ID, and security group rules
associated with the specified security group and
tenant ID.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-get-req.json"
/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-get-resp.json"
/>
</doc>
</representation>
</response>
<response status="401"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="404"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="DELETE" id="deleteSecGroup">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete Security Group">
<para role="shortdesc">Deletes an OpenStack Networking
security group.</para>
<para>This operation deletes an OpenStack Networking
security group and its associated security group
rules, provided that a port is not associated with the
security group.</para>
<para>This operation does not require a request body. This
operation does not return a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-delete-req.json"
/>
</doc>
</representation>
</request>
<response status="204">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-delete-resp.json"
/>
</doc>
</representation>
</response>
<response status="401"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="404"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="listSecGroupRules">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List Security Group Rules">
<para role="shortdesc">Lists a summary of all OpenStack
Networking security group rules that the specified
tenant can access.</para>
<para>The list provides the unique ID for each security
group rule.</para>
<para>This operation does not require a request body. This
operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/rules-security-groups-list-get-req.json"
/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/rules-security-groups-list-get-resp.json"
/>
</doc>
</representation>
</response>
<response status="401"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:unauthorized"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="POST" id="createSecGroupRule">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create Security Group Rule">
<para role="shortdesc">Creates an OpenStack Networking
security group rule.</para>
<para>This operation requires a request body.</para>
<para>The following table describes the required and
optional attributes in the request body:</para>
<table width="75%" rules="all"><caption>Create Security
Group Rule Request Attributes</caption>
<thead><tr><th>Attribute</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td><para>direction</para></td>
<td><para>Required</para></td>
<td><para>Ingress or egress: The direction in
which the security group rule is
applied. For a compute instance, an
‘ingress’ security group rule matches
traffic that is incoming (ingress) for
that instance. An ‘egress’ rule is
applied to traffic leaving the
instance.</para></td></tr>
<tr><td><para>security_group_id</para></td>
<td><para>Required</para></td>
<td><para>The security group ID to associate
with this security group
rule.</para></td></tr>
<tr><td><para>port_range_min</para></td>
<td><para>Optional</para></td><td><para>The
minimum port number in the range that
is matched by the security group rule.
If the protocol is TCP or UDP, this
value must be less than or equal to
the value of the port_range_max
attribute. If the protocol is ICMP,
this value must be an ICMP
type.</para></td></tr>
<tr><td><para>port_range_max</para></td>
<td><para>Optional</para></td><td><para>The
maximum port number in the range that
is matched by the security group rule.
The port_range_min attribute
constrains the port_range_max
attribute. If the protocol is ICMP,
this value must be an ICMP
type.</para></td></tr>
<tr><td><para>protocol</para></td>
<td><para>Optional</para></td><td><para>The
protocol that is matched by the
security group rule. Valid values are
null, tcp, udp, and icmp.
</para></td></tr>
<tr><td><para>remote_group_id</para></td>
<td><para>Optional</para></td><td><para>The
remote group ID to be associated with
this security group rule. You can
specify either remote_group_id or
remote_ip_prefix in the request body.
</para></td></tr>
<tr><td><para>remote_ip_prefix</para></td>
<td><para>Optional</para></td><td><para>The
remote IP prefix to be associated with
this security group rule. You can
specify either remote_group_id or
remote_ip_prefix in the request body.
This attribute matches the specified
IP prefix as the source IP address of
the IP
packet.</para></td></tr></tbody></table>
<para>This operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-create-req.json"
/>
</doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/security-groups-create-resp.json"
/>
</doc>
</representation>
</response>
<response status="400"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="404"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
<response status="409"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:buildInProgress"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getSecGroupRule">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show Security Group Rule">
<para role="shortdesc">Shows detailed information for a
specified security group rule.</para>
<para>This operation does not require a request
body.</para>
<para>This operation returns a response body, which
contains the following information about the security
group rule:</para>
<itemizedlist><listitem><para><code>direction</code>.
Either ingress or egress.</para></listitem>
<listitem><para><code>ethertype</code>. Either IPv4 or
IPv6.</para></listitem>
<listitem><para>The ID for the specified security
group rule</para></listitem>
<listitem><para>The min and max port ranges
</para></listitem>
<listitem><para>The protocol</para></listitem>
<listitem><para>The tenant ID</para></listitem>
<listitem><para>The remote group ID</para></listitem>
<listitem><para>The remote IP prefix</para></listitem>
<listitem><para>The security group ID for the security
group with which the rule is
associated</para></listitem>
<listitem><para>The tenant
ID</para></listitem></itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/rules-security-groups-get-req.json"
/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/rules-security-groups-get-resp.json"
/>
</doc>
</representation>
</response>
<response status="401"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="404"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
<method name="DELETE" id="deleteSecGroupRule">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete Security Group Rule">
<para role="shortdesc">Deletes a specified rule from a
OpenStack Networking security group.</para>
<para>This operation does not require a request
body.</para>
<para>This operation does not return a response body.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/rules-security-groups-delete-req.json"
/>
</doc>
</representation>
</request>
<response status="204">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../samples/rules-security-groups-delete-resp.json"
/>
</doc>
</representation>
</response>
<response status="401"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="404"
xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="secgr:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
</method>
</application>