Merge "Note the removal of Neutron XML API support"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
19a6c08dec
@ -381,6 +381,13 @@
|
||||
</para>
|
||||
<wadl:resources href="../wadls/volume-api/src/v2/os-volume-manage-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="os-vol-image-meta-v2">
|
||||
<title>Volume image metadata extension (os-vol-image-meta)</title>
|
||||
<para>
|
||||
Shows image metadata that is associated with a specified volume.
|
||||
</para>
|
||||
<wadl:resources href="../wadls/volume-api/src/v2/os-vol-image-meta-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="os-volume-type-access-v2">
|
||||
<title>Volume type access (volumes)</title>
|
||||
<para>
|
||||
|
||||
@ -12,15 +12,18 @@
|
||||
Use virtual networking services among devices that are managed by the
|
||||
OpenStack Compute service. The Networking (neutron) API v2.0 combines
|
||||
the API v1.1 functionality with some essential Internet Protocol
|
||||
Address Management (IPAM) functionality. Enables users to associate IP
|
||||
address blocks and other network configuration settings with an
|
||||
OpenStack Networking network. You can choose a specific IP address
|
||||
from the block or let OpenStack Networking choose the first available
|
||||
IP address.
|
||||
Address Management (IPAM) functionality. The API enables users to
|
||||
associate IP address blocks and other network configuration settings
|
||||
with an OpenStack Networking network. You can choose a specific IP
|
||||
address from the block or let OpenStack Networking choose the first
|
||||
available IP address.
|
||||
</para>
|
||||
<para>Effective in the OpenStack Liberty release, XML support in requests
|
||||
and responses was removed for the Networking API v2.0.</para>
|
||||
<section xml:id="neutron-versions-v2">
|
||||
<title>API versions</title>
|
||||
<para>Lists information for all Networking API versions and shows details about API v2.</para>
|
||||
<para>Lists information for all Networking API versions and shows
|
||||
details about API v2.0.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/netconn-api/src/os-networks.wadl#versions">
|
||||
@ -36,8 +39,7 @@
|
||||
<title>Networks</title>
|
||||
<para>Lists, shows information for, creates, updates, and deletes
|
||||
networks.</para>
|
||||
<wadl:resources
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/netconn-api/src/os-networks.wadl#Networks">
|
||||
<wadl:method href="#listNetworks"/>
|
||||
@ -54,10 +56,11 @@
|
||||
</section>
|
||||
<section xml:id="subnets">
|
||||
<title>Subnets</title>
|
||||
<para>Lists, shows information for, creates, updates, and deletes
|
||||
subnet resources.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/netconn-api/src/os-subnets.wadl"
|
||||
<para>
|
||||
Lists, shows information for, creates, updates, and deletes subnet
|
||||
resources.
|
||||
</para>
|
||||
<wadl:resources href="../wadls/netconn-api/src/os-subnets.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ports">
|
||||
|
||||
138
api-ref/src/wadls/volume-api/src/v2/os-vol-image-meta-v2.wadl
Normal file
138
api-ref/src/wadls/volume-api/src/v2/os-vol-image-meta-v2.wadl
Normal file
@ -0,0 +1,138 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
|
||||
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://wadl.dev.java.net/2009/02 http://www.w3.org/Submission/wadl/wadl.xsd"
|
||||
xmlns:csapi="http://docs.openstack.org/api/openstack-block-storage/v2"
|
||||
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">
|
||||
<resources base="https://manage.example.com/"
|
||||
xml:id="os-vol-image-meta-v2">
|
||||
<resource id="version" path="//v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The unique identifier of the tenant or
|
||||
account.</para></wadl:doc>
|
||||
</param>
|
||||
<resource id="os-vol-image-meta" path="os-vol-image-meta">
|
||||
<method href="#showImageMetadataForVolume"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="showImageMetadataForVolume">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show image metadata for volume">
|
||||
<para role="shortdesc">
|
||||
Shows image metadata that is associated with a specified
|
||||
volume.
|
||||
</para>
|
||||
<para>When the request is made, the caller must specify
|
||||
(in the <parameter>ref</parameter> element) a
|
||||
reference to an existing storage volume. Each storage
|
||||
driver may interpret the existing storage volume
|
||||
reference differently, but should accept a reference
|
||||
structure containing either a
|
||||
<parameter>source-volume-id</parameter> or
|
||||
<parameter>source-volume-name</parameter> element if
|
||||
possible.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Show manage existing request: JSON">
|
||||
<xsdxt:code
|
||||
href="api_samples/os-manage-existing/manage_existing_request.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
<param name="volume" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>A <code>volume</code>
|
||||
object.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="host" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The OpenStack Block Storage host where the
|
||||
existing volume resides.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="ref" style="plain" type="xsd:string"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>A reference to the existing volume.
|
||||
The internal structure of this reference
|
||||
is dependent on the implementation of the
|
||||
volume driver, see the specific driver's
|
||||
documentation for details of the required
|
||||
elements in the structure.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="name" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The volume name.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="availability_zone" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The availability zone.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="description" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The volume
|
||||
description.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="volume_type" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The associated volume
|
||||
type.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="bootable" style="plain"
|
||||
type="xsd:boolean" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Enables or disables the bootable
|
||||
attribute. You can boot an instance from a
|
||||
bootable volume.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="metadata" style="plain" type="xsd:string"
|
||||
required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>One or more metadata key and value pairs
|
||||
to associate with the
|
||||
volume.</para></wadl:doc>
|
||||
</param>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The response is the same as for a volume
|
||||
create API call. The size of the volume is chosen
|
||||
by inspecting the size of the existing storage
|
||||
volume and rounding up to the next
|
||||
gibibyte (GiB).</para>
|
||||
<xsdxt:code
|
||||
href="api_samples/os-manage-existing/manage_existing_response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
</application>
|
||||
Loading…
x
Reference in New Issue
Block a user