openstack/api-site
Code Issues Proposed changes

Merge "Add name for specify restore volume and fix parameter type"

Browse Source
This commit is contained in:
Jenkins 2015-08-17 20:59:51 +00:00 committed by Gerrit Code Review
commit 3462e975a2
2 changed files with 52 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_restore_request.json
View File

@ -1,5 +1,6 @@
{
"restore": {
"name": "vol-01",
"volume_id": "64f5d2fb-d836-4063-b7e2-544d5c1ff607"
}
}
}

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

@ -13,8 +13,10 @@
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>
<para>
The unique identifier of the tenant or account.
</para>
</wadl:doc>
</param>
<resource id="backups" path="backups">
<method href="#createBackup"/>
@ -27,9 +29,11 @@
required="true" type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The unique
identifier for a
backup.</para></wadl:doc>
xml:lang="EN">
<para>
The unique identifier for a backup.
</para>
</wadl:doc>
</param>
<method href="#showBackup"/>
<method href="#deleteBackup"/>
@ -50,8 +54,9 @@
<method name="POST" id="createBackup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create backup">
<para role="shortdesc">Creates a Block Storage backup from
a volume.</para>
<para role="shortdesc">
Creates a Block Storage backup from a volume.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -65,15 +70,19 @@
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A <code>backup</code>
object.</para></wadl:doc>
<para>
A <code>backup</code> object.
</para>
</wadl:doc>
</param>
<param name="container" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The container name or
null.</para></wadl:doc>
<para>
The container name or null.
</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string"
required="true">
@ -136,9 +145,10 @@
<method name="GET" id="listBackups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List backups">
<para role="shortdesc">Lists backups defined in Block
Storage to which the tenant who submits the request
has access.</para>
<para role="shortdesc">
Lists backups defined in Block Storage to which the tenant who
submits the request has access.
</para>
</wadl:doc>
<response status="200">
@ -180,9 +190,11 @@
<method name="GET" id="listBackupsDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List backups (detailed)">
<para role="shortdesc">Lists detailed information for
backups defined in Block Storage to which the tenant
who submits the request has access.</para>
<para role="shortdesc">
Lists detailed information for backups defined in Block
Storage to which the tenant who submits the request has
access.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
@ -398,8 +410,14 @@
<method name="POST" id="restoreBackup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Restore backup">
<para role="shortdesc">Restores a Block Storage backup to
an existing or new Block Storage volume.</para>
<para role="shortdesc">
Restores a Block Storage backup to an existing or new Block
Storage volume.
</para>
<para>
You must specify either the volume ID or name. If you specify
both the volume ID and name, the ID takes priority.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -409,20 +427,27 @@
href="api_samples/backup/backup_restore_request.json"
/>
</wadl:doc>
<param name="restore" style="plain" type="string"
<param name="restore" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The <code>restore</code>
action.</para>
</wadl:doc>
</param>
<param name="volume_id" style="plain" type="string"
required="true">
<param name="volume_id" style="plain" type="csapi:UUID"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the volume to
which you want to restore a backup.</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 name of the volume to
which you want to restore a backup.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202">
@ -433,21 +458,21 @@
href="api_samples/backup/backup_restore_response.json"
/>
</wadl:doc>
<param name="restore" style="plain" type="string"
<param name="restore" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The <code>restore</code>
action.</para>
</wadl:doc>
</param>
<param name="backup_id" style="plain" type="string"
<param name="backup_id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the
backup.</para>
</wadl:doc>
</param>
<param name="volume_id" style="plain" type="string"
<param name="volume_id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the volume to