openstack/api-site
Code Issues Proposed changes

Merge "Fix wrong parameters at the "Create volume""

Browse Source
This commit is contained in:
Jenkins
2016-01-21 01:11:56 +00:00
committed by Gerrit Code Review
parent c0386db7b8 c2f25c4167
commit bfbf0edc9e
20 changed files with 2011 additions and 2169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
api-ref/src/docbkx/ch_blockstorage-api-v1.xml
View File

@@ -35,38 +35,33 @@
</itemizedlist>
<section xml:id="volumes-v1-versions">
<title>API versions</title>
<para>
Lists information about API versions.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#versions">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#versions">
<wadl:method href="#listVersionsv1"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#version">
<wadl:method href="#showVersionDetailsv1"/>
</wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#version"/>
</wadl:resources>
</section>
<section xml:id="volumes-v1-volumes">
<title>Volumes</title>
<para>
The <code>snapshot_id</code> and <code>source_volid</code>
parameters specify the ID of the snapshot or volume from which
the volume originates.
If the volume was not created from a snapshot or source volume,
these values are null.
parameters specify the ID of the snapshot or volume from which the
volume originates. If the volume was not created from a snapshot or
source volume, these values are null.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volumes">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volumes">
<wadl:method href="#createVolume"/>
<wadl:method href="#listVolumes"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#detail-volume">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#detail-volume">
<wadl:method href="#listVolumesDetail"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volume_id">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volume_id">
<wadl:method href="#showVolume"/>
<wadl:method href="#deleteVolume"/>
</wadl:resource>
@@ -74,14 +69,15 @@
</section>
<section xml:id="volumes-v1-types">
<title>Volume types</title>
<para>
Lists, creates, updates, shows information for, and deletes volume types.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#types">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#types">
<wadl:method href="#listVolumeTypes"/>
<wadl:method href="#createVolumeType"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volume_type_id">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volume_type_id">
<wadl:method href="#updateVolumeType"/>
<wadl:method href="#updateVolumeTypeExtraSpecs"/>
<wadl:method href="#showVolumeType"/>
@@ -91,23 +87,23 @@
</section>
<section xml:id="volumes-v1-snapshots">
<title>Snapshots</title>
<para>
Creates, lists, shows information for, and deletes snapshots.
Shows and updates snapshot metadata.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshots">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshots">
<wadl:method href="#createSnapshot"/>
<wadl:method href="#listSnapshots"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#detail-snapshots">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#detail-snapshots">
<wadl:method href="#listSnapshotsDetail"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshot_id">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshot_id">
<wadl:method href="#showSnapshot"/>
<wadl:method href="#deleteSnapshot"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshot-metadata">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshot-metadata">
<wadl:method href="#showSnapshotMetadata"/>
<wadl:method href="#updateSnapshotMetadata"/>
</wadl:resource>
@@ -115,28 +111,13 @@
</section>
<section xml:id="os-quota-sets-v1">
<title>Quota sets extension (os-quota-sets)</title>
<para>Administrators only, depending on policy settings.
<para>
Administrators only, depending on policy settings.
</para>
<para>
Shows, updates, and deletes quotas for a tenant.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl#tenant_id-quotas-cinder-v1">
<wadl:method href="#showQuota"/>
<wadl:method href="#updateQuota"/>
<wadl:method href="#deleteQuotas"/>
</wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl#defaults-cinder-v1">
<wadl:method href="#showQuotaDefaults"/>
</wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl#user_id-cinder-v1">
<wadl:method href="#showQuotaUser"/>
<wadl:method href="#updateQuotaUser"/>
<wadl:method href="#deleteQuotasUser"/>
</wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl#user_id-detail-cinder-v1">
<wadl:method href="#showQuotaDetailUser"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl"/>
</section>
</chapter>

25
api-ref/src/wadls/common_project.ent
View File

@@ -336,31 +336,6 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY created_atResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="created_at" style="plain" required="true"
type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The date and time when the resource was created.
</para>
<para>
The date and time stamp format is <link
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
</para>
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
<para>
For example, <code>2015-08-27T09:49:58-05:00</code>.
</para>
<para>
The <code>±hh:mm</code> value, if included, is the time zone as an
offset from UTC. In the previous example, the offset value is
<code>-05:00</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY Date-ResponseHeader '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Date" style="header" required="true"

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

File diff suppressed because it is too large Load Diff

14
api-ref/src/wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../../v2/common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
@@ -21,7 +21,7 @@
path="os-quota-sets">
<resource path="{tenant_id}"
id="tenant_id-quotas-cinder-v1">
&tenant_idAdminTemplateParameter;
&admin_tenant_idTemplateParameter;
<method href="#showQuota"/>
<method href="#updateQuota"/>
<method href="#deleteQuotas"/>
@@ -31,7 +31,7 @@
</resource>
<resource path="{tenant_id}"
id="tenantID-cinder-v1">
&tenant_idAdminTemplateParameter;
&admin_tenant_idTemplateParameter;
<resource id="user_id-cinder-v1"
path="{user_id}">
&user_idTemplateParameter;
@@ -55,8 +55,7 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show default quotas">
<para role="shortdesc">
Shows default quotas for a
tenant.
Shows default quotas for a tenant.
</para>
</wadl:doc>
<response status="200">
@@ -76,7 +75,9 @@
<xsdxt:code
href="../samples/os-quota-sets/quotas-defaults-show-response.xml"
/>
</wadl:doc>&quotaSetsResponseParameters; </representation>
</wadl:doc>
&quotaSetsResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="showQuota">
@@ -108,7 +109,6 @@
/>
</wadl:doc>
&quotaSetsResponseParameters;
&in_useResponseParameter; &reservedResponseParameter;
</representation>
</response>
</method>

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

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../../v2/common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
@@ -147,7 +147,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/volumes/volume-create-request.json"/>
</wadl:doc>
&volumeObject;
&volumeObjectParameter;
&createVolumeRequestParameters;
</representation>
</request>
@@ -161,8 +161,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/volumes/volume-show-response.json"/>
</wadl:doc>
&volumeObject;
&volumeResponseParameters;
&volumeObjectParameter;
&createVolumeResponseParameters;
</representation>
</response>
</method>
@@ -182,7 +182,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/volumes/volumes-list-response.json"/>
</wadl:doc>
&volumesObject;
&volumesObjectParameter;
&volumeSimpleResponseParameters;
</representation>
</response>
@@ -204,7 +204,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/volumes/volumes-list-response.json"/>
</wadl:doc>
&volumesObject;
&volumesObjectParameter;
&volumeResponseParameters;
</representation>
</response>
@@ -226,7 +226,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/volumes/volume-show-response.json"/>
</wadl:doc>
&volumeObject;
&volumeObjectParameter;
&volumeResponseParameters;
</representation>
</response>
@@ -343,7 +343,6 @@
<xsdxt:code href="../samples/volumes/volume-type-create-request.json"/>
</wadl:doc>
&volume_typeRequestParameters;
&extra_specsRequestParameter;
</representation>
</request>
<response status="200">
@@ -356,7 +355,6 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/volumes/volume-type-show-response.json"/>
</wadl:doc>
&volume_typeObject;
&volume_typeResponseParameters;
</representation>
</response>
@@ -405,7 +403,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/volumes/snapshot-create-request.json"/>
</wadl:doc>
&snapshotObject;
&snapshotObjectParameter;
</representation>
</request>
<response status="201">
@@ -524,7 +522,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/volumes/snapshot-metadata-update-request.json"/>
</wadl:doc>
&metadataRequestParameter;
&snapshot-metadataRequestParameter;
</representation>
</request>
<response status="200">

15
api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-request.json
View File

@@ -1,19 +1,16 @@
{
"volume": {
"status": "creating",
"description": null,
"size": 10,
"availability_zone": null,
"source_volid": null,
"consistencygroup_id": null,
"description": null,
"multiattach ": false,
"snapshot_id": null,
"source_replica": null,
"size": 10,
"user_id": null,
"name": null,
"imageRef": null,
"attach_status": "detached",
"volume_type": null,
"project_id": null,
"metadata": {}
"metadata": {},
"source_replica": null,
"consistencygroup_id": null
}
}

35
api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-response.json
View File

@@ -1,6 +1,8 @@
{
"volume": {
"status": "creating",
"migration_status": null,
"user_id": "0eea4eabcf184061a3b6db1e0daaf010",
"attachments": [],
"links": [
{
@@ -13,27 +15,20 @@
}
],
"availability_zone": "nova",
"os-vol-host-attr:host": null,
"encrypted": false,
"os-volume-replication:extended_status": null,
"replication_status": "disabled",
"snapshot_id": null,
"id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38",
"size": 2,
"user_id": "32779452fcd34ae1a53a797ac8a1e064",
"os-vol-tenant-attr:tenant_id": "bab7d5c60cd041a0a36f7c4b6e1dd978",
"os-vol-mig-status-attr:migstat": null,
"metadata": {},
"status": "creating",
"description": null,
"multiattach": true,
"os-volume-replication:driver_data": null,
"source_volid": null,
"consistencygroup_id": null,
"os-vol-mig-status-attr:name_id": null,
"name": "test-volume-attachments",
"bootable": "false",
"encrypted": false,
"created_at": "2015-11-29T03:01:44.000000",
"volume_type": "lvmdriver-1"
"description": null,
"updated_at": null,
"volume_type": "lvmdriver-1",
"name": "test-volume-attachments",
"replication_status": "disabled",
"consistencygroup_id": null,
"source_volid": null,
"snapshot_id": null,
"multiattach": false,
"metadata": {},
"id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38",
"size": 2
}
}

2
api-ref/src/wadls/volume-api/src/v2/wadl/backups-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;

2
api-ref/src/wadls/volume-api/src/v2/wadl/capabilities-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;

12
api-ref/src/wadls/volume-api/src/v2/wadl/cgsnapshots-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
@@ -49,9 +49,7 @@
href="../samples/cgsnapshots/cgsnapshots-list-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupSnapshotResponseParameters;
&consistencyGroupSnapshotsResponseParameters;
</representation>
</response>
</method>
@@ -72,7 +70,7 @@
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupSnapshotDetailResponseParameters;
&consistencyGroupSnapshotsResponseDetailParameters;
</representation>
</response>
</method>
@@ -105,7 +103,7 @@
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupSnapshotResponseParameters;
&consistencyGroupSnapshotsResponseDetailParameters;
</representation>
</response>
</method>
@@ -136,7 +134,7 @@
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupSnapshotDetailResponseParameters;
&consistencyGroupSnapshotsResponseDetailParameters;
</representation>
</response>
</method>

50
api-ref/src/wadls/volume-api/src/v2/wadl/consistencygroups-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
@@ -19,22 +19,22 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="consistencygroups" path="consistencygroups">
<method href="#listConsistencyGroups-v2"/>
<method href="#postConsistencygroups-v2"/>
<method href="#listConsistencyGroups"/>
<method href="#createConsistencyGroup"/>
<resource id="detail" path="detail">
<method href="#listConsistencyGroupsDetail-v2"/>
<method href="#listConsistencyGroupsDetail"/>
</resource>
<resource id="create_from_src" path="create_from_src">
<method href="#postConsistencygroupsFromSrc-v2"/>
<method href="#createConsistencyGroupFromSource"/>
</resource>
<resource path="{consistencygroup_id}" id="consistencygroup_id">
&consistencygroup_idTemplateParameter;
<method href="#showConsistencyGroup-v2"/>
<method href="#showConsistencyGroup"/>
<resource path="delete" id="delete">
<method href="#postConsistencygroupDelete-v2"/>
<method href="#deleteConsistencyGroup"/>
</resource>
<resource path="update" id="update">
<method href="#putConsistencygroupUpdate-v2"/>
<method href="#updateConsistencyGroup"/>
</resource>
</resource>
</resource>
@@ -42,7 +42,7 @@
</resource>
</resources>
<!-- consistencygroups -->
<method name="GET" id="listConsistencyGroups-v2">
<method name="GET" id="listConsistencyGroups">
<wadl:doc xml:lang="EN" title="List consistency groups"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
@@ -57,13 +57,11 @@
href="../samples/consistencygroups/consistency-groups-list-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupsResponseParameters;
&consistencyGroupResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="listConsistencyGroupsDetail-v2">
<method name="GET" id="listConsistencyGroupsDetail">
<wadl:doc xml:lang="EN" title="List consistency groups with details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
@@ -78,13 +76,11 @@
href="../samples/consistencygroups/consistency-groups-list-detailed-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupsDetailsResponseParameters;
&consistencyGroupDetailResponseParameters;
</representation>
</response>
</method>
<method name="POST" id="postConsistencygroups-v2">
<method name="POST" id="createConsistencyGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create consistency group">
<para role="shortdesc">
@@ -99,8 +95,6 @@
href="../samples/consistencygroups/consistency-group-create-request.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupCreateRequestParameters;
</representation>
</request>
@@ -114,7 +108,7 @@
</representation>
</response>
</method>
<method name="POST" id="postConsistencygroupsFromSrc-v2">
<method name="POST" id="createConsistencyGroupFromSource">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create consistency group from source">
<para role="shortdesc">
@@ -129,8 +123,6 @@
href="../samples/consistencygroups/consistency-group-create-from-src-request.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupCreateFromSourceRequestParameters;
</representation>
</request>
@@ -144,7 +136,7 @@
</representation>
</response>
</method>
<method name="POST" id="postConsistencygroupDelete-v2">
<method name="POST" id="deleteConsistencyGroup">
<wadl:doc xml:lang="EN" title="Delete consistency group"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
@@ -159,15 +151,13 @@
href="../samples/consistencygroups/consistency-group-delete-request.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&forceRequestParameter;
</representation>
</request>
<response status="202">
</response>
</method>
<method name="PUT" id="putConsistencygroupUpdate-v2">
<method name="PUT" id="updateConsistencyGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update consistency group">
<para role="shortdesc">
@@ -181,13 +171,13 @@
<xsdxt:code
href="../samples/consistencygroups/consistency-group-update-request.json"/>
</wadl:doc>
&consistencyGroupUpdateRequestParameters;
&consistencyGroupUpdateParameters;
</representation>
</request>
<response status="202">
</response>
</method>
<method name="GET" id="showConsistencyGroup-v2">
<method name="GET" id="showConsistencyGroup">
<wadl:doc xml:lang="EN" title="Show consistency group details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
@@ -202,9 +192,7 @@
href="../samples/consistencygroups/consistency-group-show-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&consistencyGroupsDetailsResponseParameters;
&consistencyGroupDetailResponseParameters;
</representation>
</response>
</method>

5
api-ref/src/wadls/volume-api/src/v2/wadl/limits-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
@@ -35,7 +35,7 @@
absolute limit for the item is infinite.
</para>
</wadl:doc>
<response status="200"> &limitsResponseParameters;
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -44,6 +44,7 @@
href="../samples/limits/limits-show-response.json"
/>
</wadl:doc>
&limitsResponseParameters;
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"

2
api-ref/src/wadls/volume-api/src/v2/wadl/os-attach-interfaces-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;

10
api-ref/src/wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
@@ -18,7 +18,7 @@
&tenant_idTemplateParameter;
<resource id="os-quota-sets-for-cinder-v2" path="os-quota-sets">
<resource path="{tenant_id}" id="tenant_id_cinder_v2">
&tenant_idAdminTemplateParameter;
&admin_tenant_idTemplateParameter;
<method href="#showQuota"/>
<method href="#updateQuota"/>
<method href="#deleteQuotas"/>
@@ -27,7 +27,7 @@
<method href="#showQuotaDefaults"/>
</resource>
<resource path="{tenant_id}" id="tenantID-cinder-v2">
&tenant_idAdminTemplateParameter;
&admin_tenant_idTemplateParameter;
<resource id="user_id-cinder-v2" path="{user_id}">
&user_idTemplateParameter;
<method href="#showQuotaUser"/>
@@ -35,8 +35,7 @@
<method href="#deleteQuotasUser"/>
</resource>
<resource id="detail-cinder-v2" path="detail">
<resource id="user_id-detail-cinder-v2"
path="{user_id}">
<resource id="user_id-detail-cinder-v2" path="{user_id}">
&user_idTemplateParameter;
<method href="#showQuotaDetailUser"/>
</resource>
@@ -104,7 +103,6 @@
/>
</wadl:doc>
&quotaSetsResponseParameters;
&in_useResponseParameter; &reservedResponseParameter;
</representation>
</response>
</method>

2
api-ref/src/wadls/volume-api/src/v2/wadl/os-vol-image-meta-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;

2
api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-manage-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;

2
api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-transfer-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;

12
api-ref/src/wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
@@ -76,7 +76,7 @@
<xsdxt:code
href="../samples/qos-specs/qos-create-request.xml"/>
</wadl:doc>
&qos_specsObject;
&qos_specsObjectParameter;
<param name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -111,7 +111,7 @@
<xsdxt:code
href="../samples/qos-specs/qos-create-response.xml"/>
</wadl:doc>
&qos_specsObject;
&qos_specsObjectParameter;
<param name="specs" style="plain" type="xsd:dict"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -187,7 +187,7 @@
xml:lang="EN">
<xsdxt:code href="../samples/qos-specs/qos-list-response.xml"/>
</wadl:doc>
&qos_specsObject;
&qos_specsObjectParameter;
<param name="specs" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -251,7 +251,7 @@
href="../samples/qos-specs/qos-show-response.xml"
/>
</wadl:doc>
&qos_specsObject;
&qos_specsObjectParameter;
<param name="specs" style="plain" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -379,7 +379,7 @@
<xsdxt:code
href="../samples/qos-specs/qos-update-request.json"/>
</wadl:doc>
&qos_specsObject;
&qos_specsObjectParameter;
<param name="specs" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"

2
api-ref/src/wadls/volume-api/src/v2/wadl/scheduler-stats-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;

42
api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2016 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
<!ENTITY % common SYSTEM "../../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
@@ -281,7 +281,6 @@
<xsdxt:code
href="../samples/volumes/volume-create-request.xml"/>
</wadl:doc>
&volumeObject;
&createVolumeRequestParameters;
</representation>
</request>
@@ -301,7 +300,7 @@
href="../samples/volumes/volume-create-response.xml"
/>
</wadl:doc>
&volumeObject;
&volumeObjectParameter;
&volumeResponseParameters;
</representation>
</response>
@@ -336,7 +335,7 @@
href="../samples/volumes/volumes-list-response.json"
/>
</wadl:doc>
&volumesObject;
&volumesObjectParameter;
&volumeSimpleResponseParameters;
</representation>
</response>
@@ -371,7 +370,7 @@
href="../samples/volumes/volumes-list-detailed-response.json"
/>
</wadl:doc>
&volumesObject;
&volumesObjectParameter;
&volumeResponseParameters;
</representation>
</response>
@@ -405,7 +404,7 @@
<xsdxt:code
href="../samples/volumes/volume-show-response.json"/>
</wadl:doc>
&volumeObject;
&volumeObjectParameter;
&volumeResponseParameters;
</representation>
</response>
@@ -451,7 +450,7 @@
href="../samples/volumes/volume-update-response.json"
/>
</wadl:doc>
&volumeObject;
&volumeObjectParameter;
&volumeResponseParameters;
</representation>
</response>
@@ -489,9 +488,14 @@
</itemizedlist>
<para>Troubleshooting</para>
<itemizedlist>
<listitem><para>If volume status remains in <code>deleting</code> or
becomes <code>error_deleting</code> the request failed. Ensure you meet
the preconditions then investigate the storage back end.</para></listitem>
<listitem>
<para>
If volume status remains in <code>deleting</code> or
becomes <code>error_deleting</code> the request
failed. Ensure you meet the preconditions then
investigate the storage back end.
</para>
</listitem>
<listitem><para>The volume managed by OpenStack Block Storage
is not deleted from the storage system.</para></listitem>
</itemizedlist>
@@ -773,7 +777,7 @@
href="../samples/volumes/volume-attach-request.json"
/>
</wadl:doc>
&os-attachVolumeRequestParameters;
&attachVolumeReqParameters;
</representation>
</request>
<response status="202"/>
@@ -829,7 +833,7 @@
href="../samples/volumes/volume-force-detach-request.json"
/>
</wadl:doc>
&os-force_detachVolumeRequestParameters;
&os-force_detachRequestParameter;
</representation>
</request>
<response status="202"/>
@@ -900,7 +904,7 @@
href="../samples/volumes/volume-types-list-response.json"
/>
</wadl:doc>
&volume_typesObject;
&volume_typesObjectParameter;
&volume_typeResponseParameters;
</representation>
</response>
@@ -941,7 +945,7 @@
<xsdxt:code href="../samples/volumes/volume-type-create-request.json"
/>
</wadl:doc>
&volume_typeObject;
&volume_typeObjectParameter;
</representation>
</request>
<response status="200">
@@ -956,7 +960,7 @@
xml:lang="EN">
<xsdxt:code href="../samples/volumes/volume-type-show-response.json"/>
</wadl:doc>
&volume_typeObject;
&volume_typeObjectParameter;
&volume_typeResponseParameters;
</representation>
</response>
@@ -1206,7 +1210,7 @@
href="../samples/volumes/snapshot-create-response.json"
/>
</wadl:doc>
&snapshotObject;
&snapshotObjectParameter;
&snapshotResponseParameters;
</representation>
</response>
@@ -1315,7 +1319,7 @@
href="../samples/volumes/snapshot-show-response.json"
/>
</wadl:doc>
&snapshotObject;
&snapshotObjectParameter;
&snapshotResponseParameters;
<param name="os-extended-snapshot-attributes:progress" style="plain" type="xsd:int"
required="true">
@@ -1419,7 +1423,7 @@
href="../samples/volumes/snapshot-update-response.json"
/>
</wadl:doc>
&snapshotObject;
&snapshotObjectParameter;
&snapshotResponseParameters;
</representation>
</response>
@@ -1456,7 +1460,7 @@
href="../samples/volumes/snapshot-metadata-show-response.json"
/>
</wadl:doc>
&snapshotObject;
&snapshotObjectParameter;
&snapshotResponseParameters;
<param name="os-extended-snapshot-attributes:progress" style="plain" type="xsd:int"
required="true">