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>

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

File diff suppressed because it is too large Load Diff

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>