openstack/api-site
Code Issues Proposed changes

Add volume replication description

Browse Source 
Add volume show/list with details to replication attribute
Add volume replication operation for volume actions
Change from (detailed) to with details for readability

Partial-Bug: #1411724
Change-Id: Ib9b64262c2d60ab96fedb1637affc3dd84037180
This commit is contained in:
Atsushi SAKAI
2015-11-06 19:00:55 +09:00
parent 2f3f09b5fc
commit eb3de8b180
7 changed files with 105 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -177,6 +177,8 @@
<wadl:method href="#attachVolume"/>
<wadl:method href="#unmanageVolume"/>
<wadl:method href="#forcedetachVolume"/>
<wadl:method href="#promotereplicaVolume"/>
<wadl:method href="#reenablereplicaVolume"/>
</wadl:resource>
</wadl:resources>
</section>

3
api-ref/src/wadls/volume-api/src/v2/api_samples/os-replica/os-promote-replica-request.json Normal file
View File

@@ -0,0 +1,3 @@
{
"os-promote-replica": {}
}

3
api-ref/src/wadls/volume-api/src/v2/api_samples/os-replica/os-reenable-replica-request.json Normal file
View File

@@ -0,0 +1,3 @@
{
"os-reenable-replica": {}
}

6
api-ref/src/wadls/volume-api/src/v2/api_samples/volume_list_detail_response.json
View File

@@ -24,6 +24,8 @@
"volume_type": "None",
"os-vol-tenant-attr:tenant_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
"size": 1,
"os-volume-replication:driver_data": null,
"os-volume-replication:extended_status": null,
"metadata": {
"contents": "junk"
}
@@ -52,9 +54,11 @@
"volume_type": "None",
"os-vol-tenant-attr:tenant_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
"size": 1,
"os-volume-replication:driver_data": null,
"os-volume-replication:extended_status": null,
"metadata": {
"contents": "not junk"
}
}
]
}
}

2
api-ref/src/wadls/volume-api/src/v2/api_samples/volume_show_response.json
View File

@@ -24,6 +24,8 @@
"volume_type": "None",
"os-vol-tenant-attr:tenant_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
"size": 1,
"os-volume-replication:driver_data": null,
"os-volume-replication:extended_status": null,
"metadata": {
"contents": "not junk"
}

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

@@ -633,6 +633,22 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The size of the volume, in gibibytes (GiB).</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-replication:driver_data" 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 name of the volume replication driver.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-replication:extended_status" 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 status of the volume replication.</para></wadl:doc>
</param>' >
<!ENTITY quotasResponse '
<param name="quota_set" style="plain" required="true"
@@ -787,6 +803,28 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY promotereplicaVolumeReqParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="os-promote-replica" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The <code>os-promote-replica</code> action.
</para>
</wadl:doc>
</param>'>
<!ENTITY reenablereplicaVolumeReqParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="os-reenable-replica" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The <code>os-reenable-replica</code> action.
</para>
</wadl:doc>
</param>'>
<!ENTITY backendParametersResponse '
<param name="namespace" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"

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

@@ -70,6 +70,8 @@
<method href="#attachVolume"/>
<method href="#unmanageVolume"/>
<method href="#forcedetachVolume"/>
<method href="#promotereplicaVolume"/>
<method href="#reenablereplicaVolume"/>
</resource>
</resource>
</resource>
@@ -103,9 +105,11 @@
required="true" type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The unique
identifier of an existing
snapshot.</para></wadl:doc>
xml:lang="EN">
<para>
The UUID of the snapshot.
</para>
</wadl:doc>
</param>
<method href="#getSnapshot"/>
<method href="#updateSnapshot"/>
@@ -500,7 +504,7 @@
</method>
<method name="POST" id="extendVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Extend volume">
title="Extend volume size">
<para role="shortdesc">
Extends the size of a volume to a requested size, in gibibytes
(GiB). Specify the <code>os-extend</code> action in the
@@ -755,6 +759,49 @@
</request>
<response status="202"/>
</method>
<method name="POST" id="promotereplicaVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Promote replicated volume">
<para role="shortdesc">
Promotes a replicated volume. Specify the
<code>os-promote-replica</code> action in
the request body.
</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-replica/os-promote-replica-request.json"
/>
</wadl:doc>
&promotereplicaVolumeReqParameters;
</representation>
</request>
<response status="202"/>
</method>
<method name="POST" id="reenablereplicaVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Reenable volume replication">
<para role="shortdesc">
Re-enables replication of a volume. Specify the
<code>os-reenable-replica</code> action in the request body.
</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-replica/os-reenable-replica-request.json"
/>
</wadl:doc>
&reenablereplicaVolumeReqParameters;
</representation>
</request>
<response status="202"/>
</method>
<method name="GET" id="getVolumeTypes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List volume types">
@@ -1072,7 +1119,7 @@
</method>
<method name="GET" id="getSnapshotsDetail">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List snapshots (detailed)">
title="List snapshots with details">
<para role="shortdesc">
Lists all Block Storage snapshots, with details, that the
tenant can access.