openstack/api-site
Code Issues Proposed changes

Merge "Add os-volume-type-access extension to Block Storage API v2."

Browse Source
This commit is contained in:
Jenkins 2015-04-06 18:50:40 +00:00 committed by Gerrit Code Review
commit f34a3e8742
7 changed files with 626 additions and 443 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
api-ref/src/docbkx/ch_blockstorage-api-v2.xml
View File

@ -309,4 +309,23 @@
<para>Create new volumes using existing storage, rather than allocating new storage.</para>
<wadl:resources href="../wadls/volume-api/src/v2/os-volume-manage.wadl"/>
</section>
<section xml:id="ext-os-volume-type-access">
<title>Volume type access (volumes)</title>
<para>
Create private volumes.
</para>
<para>
By default, volumes are public. To create a private volume, set
the <code>is_public</code> boolean field to <code>false</code> at
volume creation time. To control access to a private volume, you
add a project to or remove a project from the volume. Private
volume types without projects are only visible by users with the
administrative role and context.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/os-volume-type-access.wadl#os-volume-type-access">
<wadl:method href="#createVolumeTypeAccessExt"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

14
api-ref/src/wadls/volume-api/src/v2/api_samples/os-volume-type-access/volume_create_request.json Normal file
View File

@ -0,0 +1,14 @@
{
"volume": {
"availability_zone": null,
"source_volid": null,
"description": null,
"snapshot_id": null,
"size": 10,
"name": "my_volume",
"imageRef": null,
"volume_type": null,
"metadata": {},
"os-volume-type-access: is_public": false
}
}

2
api-ref/src/wadls/volume-api/src/v2/api_samples/os-volume-type-access/volume_create_request.xml Normal file
View File

@ -0,0 +1,2 @@
<?xml version="1.0" encoding="UTF-8"?>
<volume xmlns="http://docs.openstack.org/openstack-block-storage/2.0/content" xmlns:os-volume-type-access="http://docs.openstack.org/openstack-block-storage/2.0/ext/os-volume-type-access/api/v2.0" name="vol-001" description="Another volume." size="2" os-volume-type-access:is_public="false" />

18
api-ref/src/wadls/volume-api/src/v2/api_samples/os-volume-type-access/volume_create_response.json Normal file
View File

@ -0,0 +1,18 @@
{
"volume": {
"status": "creating",
"name": "my_volume",
"attachments": [],
"availability_zone": "nova",
"bootable": "false",
"created_at": "2014-02-21T19: 52: 04.949734",
"description": null,
"volume_type": "None",
"snapshot_id": null,
"source_volid": null,
"metadata": {},
"id": "93c2e2aa-7744-4fd6-a31a-80c4726b08d7",
"size": 10,
"os-volume-type-access: is_public": false
}
}

5
api-ref/src/wadls/volume-api/src/v2/api_samples/os-volume-type-access/volume_create_response.xml Normal file
View File

@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<volume xmlns="http://docs.openstack.org/openstack-block-storage/2.0/content" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:os-volume-type-access="http://docs.openstack.org/openstack-block-storage/2.0/ext/os-volume-type-access/api/v2.0" status="creating" name="vol-001" availability_zone="nova" bootable="false" created_at="2014-02-21 20:18:33.122452" description="Another volume." volume_type="None" snapshot_id="None" source_volid="None" id="83960a54-8dad-4fd8-bc41-33c71e098e04" size="2" os-volume-type-access:is_public="false">
<attachments />
<metadata />
</volume>

307
api-ref/src/wadls/volume-api/src/v2/common.ent
View File

@ -3,48 +3,46 @@
A collection of common faults, these are pretty much expected
in every request.
-->
<!ENTITY commonFaults
'
<response xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY commonFaults '
<response xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:computeFault"/>
<representation mediaType="application/json"/>
</response>
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
</response>
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
</response>
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
</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">
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
</response>
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413" xmlns="http://wadl.dev.java.net/2009/02">
</response>
<response status="413" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:overLimit"/>
<representation mediaType="application/json"/>
</response>
'>
</response>'>
<!ENTITY volumeListQueryParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="sort" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Comma-separated list of sort keys and optional sort
directions in the form of &lt;key&gt;[:&lt;direction&gt;].
Valid directions are <code>asc</code> (ascending) or
<code>desc</code> (descending).</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort"
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>
Comma-separated list of sort keys and optional sort directions in the
form of &lt;key&gt;[:&lt;direction&gt;]. A valid direction is
<code>asc</code> (ascending) or <code>desc</code> (descending).
</para>
</wadl:doc>
</param>'>
<!ENTITY quotaSetsReqParameters '
<param name="quota_set" style="plain" required="true"
@ -64,27 +62,26 @@
<para>The number of instance cores allowed for
each tenant.</para></wadl:doc>
</param>
<param name="fixed_ips " style="plain"
required="false"
<param name="fixed_ips" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of fixed IP addresses allowed
for each tenant. Must be equal to or
greater than the number of allowed
instances.</para></wadl:doc>
<para>
The number of fixed IP addresses allowed for each tenant. Must be
equal to or greater than the number of allowed instances.
</para></wadl:doc>
</param>
<param name="floating_ips" style="plain"
required="false"
<param name="floating_ips" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of floating IP addresses
allowed for each tenant.</para></wadl:doc>
<para>
The number of floating IP addresses allowed for each tenant.
</para></wadl:doc>
</param>
<param name="id" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
@ -92,20 +89,19 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID for the quota
set.</para></wadl:doc>
<para>The ID for the quota set.</para></wadl:doc>
</param>
<param name="injected_file_content_bytes"
style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
style="plain" xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of bytes of content allowed
for each injected file.</para></wadl:doc>
<para>
The number of bytes of content allowed for each injected file.
</para></wadl:doc>
</param>
<param name="injected_file_path_bytes " style="plain"
<param name="injected_file_path_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -177,7 +173,8 @@
<para>The number of security groups allowed
for each tenant.</para></wadl:doc>
</param>'>
<!ENTITY quotaSetsRespParameters '<param name="quota_set" style="plain" required="true"
<!ENTITY quotaSetsRespParameters '
<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -194,19 +191,18 @@
<para>The number of instance cores allowed for
each tenant.</para></wadl:doc>
</param>
<param name="fixed_ips " style="plain" required="true"
<param name="fixed_ips" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of fixed IP addresses allowed
for each tenant. Must be equal to or
greater than the number of allowed
instances.</para></wadl:doc>
<para>
The number of fixed IP addresses allowed for each tenant. Must be
equal to or greater than the number of allowed instances.
</para></wadl:doc>
</param>
<param name="floating_ips" style="plain"
required="true"
<param name="floating_ips" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -221,8 +217,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID for the quota
set.</para></wadl:doc>
<para>The ID for the quota set.</para></wadl:doc>
</param>
<param name="injected_file_content_bytes"
style="plain"
@ -234,7 +229,7 @@
<para>The number of bytes of content allowed
for each injected file.</para></wadl:doc>
</param>
<param name="injected_file_path_bytes " style="plain"
<param name="injected_file_path_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -276,8 +271,9 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of metadata items allowed for
each instance.</para></wadl:doc>
<para>
The number of metadata items allowed for each instance.
</para></wadl:doc>
</param>
<param name="ram" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
@ -303,11 +299,12 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of security groups allowed
for each tenant.</para></wadl:doc>
<para>
The number of security groups allowed for each tenant.
</para></wadl:doc>
</param>'>
<!ENTITY limitsRespParameters '
<param name="limits" style="plain"
<param name="limits" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -339,7 +336,7 @@
xml:lang="EN">
<para>Maximum total amount of volumes (GB).</para></wadl:doc>
</param>
<param name="totalGigabytesUsed " style="plain" required="true"
<param name="totalGigabytesUsed" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -347,8 +344,7 @@
xml:lang="EN">
<para>Total number of GBs used.</para></wadl:doc>
</param>
<param name="maxTotalSnapshots" style="plain"
required="true"
<param name="maxTotalSnapshots" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -364,8 +360,7 @@
xml:lang="EN">
<para>Total number of volumes used.</para></wadl:doc>
</param>
<param name="maxTotalVolumes"
style="plain"
<param name="maxTotalVolumes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -374,160 +369,212 @@
<para>Maximum number of volumes.</para></wadl:doc>
</param>'>
<!ENTITY createVolumeParameters '
<param name="availability_zone" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The availability zone.</para></wadl:doc>
</param>
<param name="source_volid" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" style="plain"
type="csapi:uuid" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To create a volume from an existing
volume, specify the ID of the existing volume. The volume
is created with the same size as the source volume.</para>
</wadl:doc>
</param>
<param name="description" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The volume
description.</para></wadl:doc>
<para>The volume description.</para></wadl:doc>
</param>
<param name="snapshot_id" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="snapshot_id" style="plain"
type="csapi:uuid" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To create a volume from an existing
snapshot, specify the ID of the existing
volume snapshot. The volume is created in same availability
zone and with same size as the snapshot.</para></wadl:doc>
</param>
<param name="size" style="plain" type="xsd:int"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="size" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The size of the volume, in
GBs.</para></wadl:doc>
</param>
<param name="name" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The volume name.</para></wadl:doc>
</param>
<param name="imageRef" style="plain" type="csapi:uuid"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="imageRef" style="plain" type="csapi:uuid"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID of the image from which you want
to create the volume. Required to create a
bootable volume.</para></wadl:doc>
</param>
<param name="volume_type" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The associated volume
type.</para></wadl:doc>
<para>The associated volume type.</para></wadl:doc>
</param>
<param name="metadata" style="plain" type="xsd:string"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="metadata" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>One or more metadata key and value pairs
to associate with the
volume.</para></wadl:doc>
to associate with the volume.</para></wadl:doc>
</param>' >
<!ENTITY isPublicParameterReq '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-type-access:is_public" style="plain" required="false"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The volume type access.</para>
<para>
Set to <code>true</code> if access is public. Set to
<code>false</code> if access is private.
</para></wadl:doc>
</param>'>
<!ENTITY isPublicParameterResp '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-type-access:is_public" style="plain" required="true"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The volume type access.</para>
<para>
Set to <code>true</code> if access is public. Set to
<code>false</code> if access is private.
</para></wadl:doc>
</param>'>
<!ENTITY createVolumeResponseParameters '
<param name="status" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The volume status.</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="status"
style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The volume status.</para>
</wadl:doc>
</param>
<param name="name" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The volume name.</para></wadl:doc>
</param>
<param name="attachments" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>One or more instance
attachments.</para></wadl:doc>
</param>
<param name="availability_zone" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The volume name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="attachments" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>One or more instance attachments.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The availability zone.</para></wadl:doc>
</param>
<param name="created_at" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="created_at" style="plain"
type="xsd:datetime" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Date and time when the volume was
created.</para></wadl:doc>
<para>Date and time when the volume was created.</para></wadl:doc>
</param>
<param name="description" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The volume
description.</para></wadl:doc>
<para>The volume description.</para></wadl:doc>
</param>
<param name="volume_type" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The associated volume
type.</para></wadl:doc>
<para>The associated volume type.</para></wadl:doc>
</param>
<param name="snapshot_id" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02" name="snapshot_id" style="plain"
type="csapi:uuid" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To create a volume from an existing
volume snapshot, specify the ID of the
existing volume
snapshot.</para></wadl:doc>
<para>
To create a volume from an existing volume snapshot, specify the ID of
the existing volume snapshot.
</para></wadl:doc>
</param>
<param name="source_volid" style="plain"
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" style="plain"
type="csapi:uuid" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To create a volume from an existing
volume, specify the ID of the existing
volume.</para></wadl:doc>
<para>
To create a volume from an existing volume, specify the ID of the
existing volume.
</para></wadl:doc>
</param>
<param name="metadata" style="plain" type="xsd:string"
<param xmlns="http://wadl.dev.java.net/2009/02" name="metadata"
style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>One or more metadata key and value pairs
to associate with the
volume.</para></wadl:doc>
<para>
One or more metadata key and value pairs to associate with the
volume.
</para></wadl:doc>
</param>
<param name="id" style="plain" type="csapi:uuid"
<param xmlns="http://wadl.dev.java.net/2009/02" name="id"
style="plain" type="csapi:uuid"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The volume ID.</para></wadl:doc>
</param>
<param name="size" style="plain" type="xsd:int"
<param xmlns="http://wadl.dev.java.net/2009/02" name="size"
style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The size of the volume, in
GBs.</para></wadl:doc>
<para>The size of the volume, in GBs.</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>'>

78
api-ref/src/wadls/volume-api/src/v2/os-volume-type-access.wadl Normal file
View File

@ -0,0 +1,78 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
%common_project;
]>
<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="volume-type-access-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="volumes" path="volumes">
<method href="#createVolumeTypeAccessExt"/>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="createVolumeTypeAccessExt">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create volume">
<para role="shortdesc">
Create and get details for private Block Storage volume.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/os-volume-type-access/volume_create_request.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/os-volume-type-access/volume_create_request.xml"/>
</wadl:doc>
&createVolumeParameters;
&isPublicParameterReq;
</representation>
</request>
<response status="202">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/os-volume-type-access/volume_create_response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/os-volume-type-access/volume_create_response.xml"
/>
</wadl:doc>
&createVolumeResponseParameters;
&isPublicParameterResp;
</representation>
</response>
</method>
</application>