openstack/api-site
Code Issues Proposed changes

Merge "Update volume API v1 and v2 to make these changes"

Browse Source
This commit is contained in:
Jenkins 2015-12-14 07:05:42 +00:00 committed by Gerrit Code Review
commit 42d72cdd7e
215 changed files with 1347 additions and 1547 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -28,25 +28,25 @@
<listitem><para>IN-USE. The volume is attached to an <listitem><para>IN-USE. The volume is attached to an
instance.</para></listitem> instance.</para></listitem>
<listitem><para>DELETING. The volume is being deleted.</para></listitem> <listitem><para>DELETING. The volume is being deleted.</para></listitem>
<listitem><para>ERROR. An error has occurred with the <listitem><para>ERROR. An error occurred.</para></listitem>
volume.</para></listitem> <listitem><para>
<listitem><para>ERROR_DELETING. There was an error deleting the ERROR_DELETING. A volume deletion error occurred.
volume.</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
<section xml:id="volume-api-v1-versions"> <section xml:id="volumes-v1-versions">
<title>API versions</title> <title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#versions"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#versions">
<wadl:method href="#listVersionsv1"/> <wadl:method href="#listVersionsv1"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#version"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#version">
<wadl:method href="#showVersionDetailsv1"/> <wadl:method href="#showVersionDetailsv1"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="volume-api-v1-volumes"> <section xml:id="volumes-v1-volumes">
<title>Volumes</title> <title>Volumes</title>
<para> <para>
The <code>snapshot_id</code> and <code>source_volid</code> The <code>snapshot_id</code> and <code>source_volid</code>
@ -57,61 +57,57 @@
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#volumes"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volumes">
<wadl:method href="#createVolume"/> <wadl:method href="#createVolume"/>
<wadl:method href="#getVolumesSimple"/> <wadl:method href="#listVolumesSimple"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#detail-volume"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#detail-volume">
<wadl:method href="#getVolumesDetail"/> <wadl:method href="#listVolumesDetail"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#volume_id"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volume_id">
<wadl:method href="#getVolume"/> <wadl:method href="#showVolume"/>
<wadl:method href="#deleteVolume"/> <wadl:method href="#deleteVolume"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="volume-api-v1-types"> <section xml:id="volumes-v1-types">
<title>Volume types</title> <title>Volume types</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#types"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#types">
<wadl:method href="#getVolumeTypes"/> <wadl:method href="#listVolumeTypes"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#types">
<wadl:method href="#createVolumeType"/> <wadl:method href="#createVolumeType"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#volume_type_id"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#volume_type_id">
<wadl:method href="#getVolumeType"/> <wadl:method href="#updateVolumeType"/>
</wadl:resource> <wadl:method href="#updateVolumeTypeExtraSpecs"/>
<wadl:resource <wadl:method href="#showVolumeType"/>
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#volume_type_id">
<wadl:method href="#deleteVolumeType"/> <wadl:method href="#deleteVolumeType"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="volume-api-v1-snapshots"> <section xml:id="volumes-v1-snapshots">
<title>Snapshots</title> <title>Snapshots</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#snapshots"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshots">
<wadl:method href="#createSnapshot"/> <wadl:method href="#createSnapshot"/>
<wadl:method href="#getSnapshotsSimple"/> <wadl:method href="#listSnapshotsSimple"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#detail-snapshots"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#detail-snapshots">
<wadl:method href="#getSnapshotsDetail"/> <wadl:method href="#listSnapshotsDetail"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#snapshot_id"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshot_id">
<wadl:method href="#getSnapshot"/> <wadl:method href="#showSnapshot"/>
<wadl:method href="#deleteSnapshot"/> <wadl:method href="#deleteSnapshot"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#snapshot-metadata"> href="../wadls/volume-api/src/v1/wadl/volumes-v1.wadl#snapshot-metadata">
<wadl:method href="#showSnapshotMetadata"/> <wadl:method href="#showSnapshotMetadata"/>
<wadl:method href="#updateSnapshotMetadata"/> <wadl:method href="#updateSnapshotMetadata"/>
</wadl:resource> </wadl:resource>
@ -125,20 +121,20 @@
Shows, updates, and deletes quotas for a tenant. Shows, updates, and deletes quotas for a tenant.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v1/os-quota-sets-v1.wadl#tenant_id-quotas-cinder-v1"> <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="#showQuota"/>
<wadl:method href="#updateQuota"/> <wadl:method href="#updateQuota"/>
<wadl:method href="#deleteQuotas"/> <wadl:method href="#deleteQuotas"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v1/os-quota-sets-v1.wadl#defaults-cinder-v1"> <wadl:resource href="../wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl#defaults-cinder-v1">
<wadl:method href="#getDefaults"/> <wadl:method href="#showQuotaDefaults"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v1/os-quota-sets-v1.wadl#user_id-cinder-v1"> <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="#showQuotaUser"/>
<wadl:method href="#updateQuotaUser"/> <wadl:method href="#updateQuotaUser"/>
<wadl:method href="#deleteQuotasUser"/> <wadl:method href="#deleteQuotasUser"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v1/os-quota-sets-v1.wadl#user_id-detail-cinder-v1"> <wadl:resource href="../wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl#user_id-detail-cinder-v1">
<wadl:method href="#showQuotaDetailUser"/> <wadl:method href="#showQuotaDetailUser"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>

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

@ -12,21 +12,21 @@
Manages volumes and snapshots for use with the Block Storage API, also Manages volumes and snapshots for use with the Block Storage API, also
known as cinder services. known as cinder services.
</para> </para>
<section xml:id="volume-api-v2-versions"> <section xml:id="volumes-v2-versions">
<title>API versions</title> <title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#versions"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#versions">
<wadl:method href="#listVersions"/> <wadl:method href="#listVersions"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#version"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#version">
<wadl:method href="#versionDetails"/> <wadl:method href="#versionDetails"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="volume-api-v2-extensions"> <section xml:id="volumes-v2-extensions">
<title>API extensions (extensions)</title> <title>API extensions (extensions)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#extensions"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#extensions">
<wadl:method href="#listExtensions-cinder-v2"/> <wadl:method href="#listExtensions-cinder-v2"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
@ -40,10 +40,10 @@
An absolute limit value of <code>-1</code> indicates that the An absolute limit value of <code>-1</code> indicates that the
absolute limit for the item is infinite. absolute limit for the item is infinite.
</para> </para>
<wadl:resources href="../wadls/volume-api/src/v2/os-limits-v2.wadl" <wadl:resources href="../wadls/volume-api/src/v2/wadl/limits-v2.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="volume-api-v2-volumes"> <section xml:id="volumes-v2-volumes">
<title>Volumes (volumes)</title> <title>Volumes (volumes)</title>
<para> <para>
A volume is a detachable block storage device similar to a USB A volume is a detachable block storage device similar to a USB
@ -95,13 +95,14 @@
</tr> </tr>
<tr> <tr>
<td><para>error</para></td> <td><para>error</para></td>
<td><para>An error occurred during volume <td><para>
creation.</para></td> A volume creation error occurred.
</para></td>
</tr> </tr>
<tr> <tr>
<td><para>error_deleting</para></td> <td><para>error_deleting</para></td>
<td><para>An error occurred during volume <td><para>
deletion.</para></td> A volume deletion error occurred.</para></td>
</tr> </tr>
<tr> <tr>
<td><para>backing-up</para></td> <td><para>backing-up</para></td>
@ -114,8 +115,7 @@
</tr> </tr>
<tr> <tr>
<td><para>error_restoring</para></td> <td><para>error_restoring</para></td>
<td><para>An error occurred during backup restoration to a <td><para>A backup restoration error occurred.</para></td>
volume.</para></td>
</tr> </tr>
<tr> <tr>
<td><para>error_extending</para></td> <td><para>error_extending</para></td>
@ -126,19 +126,19 @@
</table> </table>
<para></para> <para></para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volumes"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#volumes">
<wadl:method href="#createVolume"/> <wadl:method href="#createVolume"/>
<wadl:method href="#getVolumesSimple"/> <wadl:method href="#listVolumesSimple"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#detail"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#detail">
<wadl:method href="#getVolumesDetail"/> <wadl:method href="#listVolumesDetail"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume_id"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#volume_id">
<wadl:method href="#getVolume"/> <wadl:method href="#showVolume"/>
<wadl:method href="#updateVolume"/> <wadl:method href="#updateVolume"/>
<wadl:method href="#deleteVolume"/> <wadl:method href="#deleteVolume"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume-metadata"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#volume-metadata">
<wadl:method href="#showVolumeMetadata"/> <wadl:method href="#showVolumeMetadata"/>
<wadl:method href="#updateVolumeMetadata"/> <wadl:method href="#updateVolumeMetadata"/>
</wadl:resource> </wadl:resource>
@ -158,12 +158,12 @@
administrative role and context. administrative role and context.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/os-volume-type-access-v2.wadl#volumes"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#volumes">
<wadl:method href="#createVolumeTypeAccessExt"/> <wadl:method href="#createVolumeTypeAccessExt"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="volume-api-v2-volumes-actions"> <section xml:id="volumes-v2-volumes-actions">
<title>Volume actions (volumes, action)</title> <title>Volume actions (volumes, action)</title>
<para> <para>
Extends the size of, resets statuses for, sets image metadata for, Extends the size of, resets statuses for, sets image metadata for,
@ -173,7 +173,7 @@
storage object associated with it. storage object associated with it.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume-action"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#volume-action">
<wadl:method href="#extendVolume"/> <wadl:method href="#extendVolume"/>
<wadl:method href="#resetVolume"/> <wadl:method href="#resetVolume"/>
<wadl:method href="#setVolumeimagemetadata"/> <wadl:method href="#setVolumeimagemetadata"/>
@ -256,7 +256,7 @@
</td> </td>
<td> <td>
<para> <para>
An error has occurred with the backup. A backup error occurred.
</para> </para>
</td> </td>
</tr> </tr>
@ -280,8 +280,7 @@
</td> </td>
<td> <td>
<para> <para>
An error occurred during backup restoration to a A backup restoration error occurred.
volume.
</para> </para>
</td> </td>
</tr> </tr>
@ -293,18 +292,18 @@
in the <code>fail_reason</code> field for the backup. in the <code>fail_reason</code> field for the backup.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/volume-backups-api-v2.wadl#backups"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/backups-v2.wadl#backups">
<wadl:method href="#createBackup"/> <wadl:method href="#createBackup"/>
<wadl:method href="#listBackups"/> <wadl:method href="#listBackups"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-backups-api-v2.wadl#detail"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/backups-v2.wadl#detail">
<wadl:method href="#listBackupsDetails"/> <wadl:method href="#listBackupsDetails"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-backups-api-v2.wadl#backup_id"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/backups-v2.wadl#backup_id">
<wadl:method href="#showBackup"/> <wadl:method href="#showBackup"/>
<wadl:method href="#deleteBackup"/> <wadl:method href="#deleteBackup"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-backups-api-v2.wadl#restore"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/backups-v2.wadl#restore">
<wadl:method href="#restoreBackup"/> <wadl:method href="#restoreBackup"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
@ -315,19 +314,19 @@
Force-deletes a backup. Force-deletes a backup.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/volume-backups-api-v2.wadl#action"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/backups-v2.wadl#action">
<wadl:method href="#forceDeleteBackup"/> <wadl:method href="#forceDeleteBackup"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="os-backend-capabilities-v2"> <section xml:id="capabilities-v2">
<title>Capabilities for storage back ends (capabilities)</title> <title>Capabilities for storage back ends (capabilities)</title>
<para> <para>
Shows capabilities for a storage back end. Shows capabilities for a storage back end.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/os-backend-capabilities-v2.wadl#hostname"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/capabilities-v2.wadl#hostname">
<wadl:method href="#getBackendCapabilities"/> <wadl:method href="#showBackendCapabilities"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
@ -340,25 +339,25 @@
Shows, updates, and deletes quotas for a tenant. Shows, updates, and deletes quotas for a tenant.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#tenant_id_cinder_v2"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl#tenant_id_cinder_v2">
<wadl:method href="#showQuota"/> <wadl:method href="#showQuota"/>
<wadl:method href="#updateQuota"/> <wadl:method href="#updateQuota"/>
<wadl:method href="#deleteQuotas"/> <wadl:method href="#deleteQuotas"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#defaults-cinder-v2"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl#defaults-cinder-v2">
<wadl:method href="#getDefaults"/> <wadl:method href="#showQuotaDefaults"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#user_id-cinder-v2"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl#user_id-cinder-v2">
<wadl:method href="#showQuotaUser"/> <wadl:method href="#showQuotaUser"/>
<wadl:method href="#updateQuotaUser"/> <wadl:method href="#updateQuotaUser"/>
<wadl:method href="#deleteQuotasUser"/> <wadl:method href="#deleteQuotasUser"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#user_id-detail-cinder-v2"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl#user_id-detail-cinder-v2">
<wadl:method href="#showQuotaDetailUser"/> <wadl:method href="#showQuotaDetailUser"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="os-qos-v2-qos-specs"> <section xml:id="qos-specs-v2-qos-specs">
<title>Quality of service (QoS) specifications (qos-specs)</title> <title>Quality of service (QoS) specifications (qos-specs)</title>
<para> <para>
Administrators only, depending on policy settings. Administrators only, depending on policy settings.
@ -369,45 +368,42 @@
specifications. specifications.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#qos-specs"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl#qos-specs">
<wadl:method href="#createQoSSpec"/> <wadl:method href="#createQoSSpec"/>
<wadl:method href="#listQoSSpecs"/> <wadl:method href="#listQoSSpecs"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#qos_id"/> <wadl:resource href="../wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl#qos_id"/>
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#associate"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl#associate">
<wadl:method href="#associateQoSSpec"/> <wadl:method href="#associateQoSSpec"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#disassociate"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl#disassociate">
<wadl:method href="#disassociateQoSSpec"/> <wadl:method href="#disassociateQoSSpec"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#disassociate_all"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl#disassociate_all">
<wadl:method href="#disassociateQoSSpecAll"/> <wadl:method href="#disassociateQoSSpecAll"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#associations"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl#associations">
<wadl:method href="#getQoSAssociations"/> <wadl:method href="#listQoSAssociations"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="volume-api-v2-types"> <section xml:id="volumes-v2-types">
<title>Volume types (types)</title> <title>Volume types (types)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#types"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#types">
<wadl:method href="#getVolumeTypes"/> <wadl:method href="#showVolumeTypes"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v2/volume-api-v2.wadl#types">
<wadl:method href="#createVolumeType"/> <wadl:method href="#createVolumeType"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume_type_id"> href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#volume_type_id">
<wadl:method href="#updateVolumeType"/> <wadl:method href="#updateVolumeType"/>
<wadl:method href="#updateVolumeTypeExtraSpecs"/> <wadl:method href="#updateVolumeTypeExtraSpecs"/>
<wadl:method href="#getVolumeType"/> <wadl:method href="#showVolumeType"/>
<wadl:method href="#deleteVolumeType"/> <wadl:method href="#deleteVolumeType"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="volume-api-v2-snapshots"> <section xml:id="volumes-v2-snapshots">
<title>Volume snapshots (snapshots)</title> <title>Volume snapshots (snapshots)</title>
<para> <para>
A snapshot is a point-in-time copy of the data that a volume A snapshot is a point-in-time copy of the data that a volume
@ -472,7 +468,7 @@
</td> </td>
<td> <td>
<para> <para>
An error occurred during snapshot creation. A snapshot creation error occurred.
</para> </para>
</td> </td>
</tr> </tr>
@ -484,7 +480,7 @@
</td> </td>
<td> <td>
<para> <para>
An error occurred during snapshot deletion. A snapshot deletion error occurred.
</para> </para>
</td> </td>
</tr> </tr>
@ -492,19 +488,19 @@
</table> </table>
<para></para> <para></para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshots"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#snapshots">
<wadl:method href="#createSnapshot"/> <wadl:method href="#createSnapshot"/>
<wadl:method href="#listSnapshots"/> <wadl:method href="#listSnapshots"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#detail-snapshot"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#detail-snapshot">
<wadl:method href="#listSnapshotsDetail"/> <wadl:method href="#listSnapshotsDetail"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot_id"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#snapshot_id">
<wadl:method href="#showSnapshot"/> <wadl:method href="#showSnapshot"/>
<wadl:method href="#updateSnapshot"/> <wadl:method href="#updateSnapshot"/>
<wadl:method href="#deleteSnapshot"/> <wadl:method href="#deleteSnapshot"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot-metadata"> <wadl:resource href="../wadls/volume-api/src/v2/wadl/volumes-v2.wadl#snapshot-metadata">
<wadl:method href="#showSnapshotMetadata"/> <wadl:method href="#showSnapshotMetadata"/>
<wadl:method href="#updateSnapshotMetadata"/> <wadl:method href="#updateSnapshotMetadata"/>
</wadl:resource> </wadl:resource>
@ -516,14 +512,14 @@
Creates volumes by using existing storage instead of allocating Creates volumes by using existing storage instead of allocating
new storage. new storage.
</para> </para>
<wadl:resources href="../wadls/volume-api/src/v2/os-volume-manage-v2.wadl"/> <wadl:resources href="../wadls/volume-api/src/v2/wadl/os-volume-manage-v2.wadl"/>
</section> </section>
<section xml:id="os-vol-image-meta-v2"> <section xml:id="os-vol-image-meta-v2">
<title>Volume image metadata extension (os-vol-image-meta)</title> <title>Volume image metadata extension (os-vol-image-meta)</title>
<para> <para>
Shows image metadata that is associated with a volume. Shows image metadata that is associated with a volume.
</para> </para>
<wadl:resources href="../wadls/volume-api/src/v2/os-vol-image-meta-v2.wadl"/> <wadl:resources href="../wadls/volume-api/src/v2/wadl/os-vol-image-meta-v2.wadl"/>
</section> </section>
<section xml:id="os-vol-pool-v2"> <section xml:id="os-vol-pool-v2">
<title>Back-end storage pools</title> <title>Back-end storage pools</title>
@ -531,14 +527,14 @@
Administrator only. Lists all back-end storage pools that are Administrator only. Lists all back-end storage pools that are
known to the scheduler service. known to the scheduler service.
</para> </para>
<wadl:resources href="../wadls/volume-api/src/v2/os-vol-pool-v2.wadl"/> <wadl:resources href="../wadls/volume-api/src/v2/wadl/scheduler-stats-v2.wadl"/>
</section> </section>
<section xml:id="os-vol-transfer-v2"> <section xml:id="os-vol-transfer-v2">
<title>Volume transfer</title> <title>Volume transfer</title>
<para> <para>
Transfers a volume from one user to another user. Transfers a volume from one user to another user.
</para> </para>
<wadl:resources href="../wadls/volume-api/src/v2/os-volume-transfer-api-v2.wadl"/> <wadl:resources href="../wadls/volume-api/src/v2/wadl/os-volume-transfer-v2.wadl"/>
</section> </section>
<section xml:id="consistencygroups-v2"> <section xml:id="consistencygroups-v2">
<title>Consistency groups</title> <title>Consistency groups</title>
@ -554,7 +550,7 @@
Use the <code>policy.json</code> file to grant permissions Use the <code>policy.json</code> file to grant permissions
for these actions to limit roles. for these actions to limit roles.
</para> </para>
<wadl:resources href="../wadls/volume-api/src/v2/consistencygroups-v2.wadl"/> <wadl:resources href="../wadls/volume-api/src/v2/wadl/consistencygroups-v2.wadl"/>
</section> </section>
<section xml:id="os-cgsnapshots-v2"> <section xml:id="os-cgsnapshots-v2">
<title>Consistency group snapshots</title> <title>Consistency group snapshots</title>
@ -562,6 +558,6 @@
Lists all, lists all with details, shows details for, creates, and Lists all, lists all with details, shows details for, creates, and
deletes consistency group snapshots. deletes consistency group snapshots.
</para> </para>
<wadl:resources href="../wadls/volume-api/src/v2/cgsnapshots-v2.wadl"/> <wadl:resources href="../wadls/volume-api/src/v2/wadl/cgsnapshots-v2.wadl"/>
</section> </section>
</chapter> </chapter>

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

@ -6,12 +6,11 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Requests a page size of returned items from the query. Requests a page size of items. Returns a number of items up to a
Returns a number of items up to a limit value. Use the limit value. Use the <code>limit</code> parameter to make an
<code>limit</code> parameter to make an initial limited request initial limited request and use the ID of the last-seen item from
and use the ID of the last-seen item from the response as the the response as the <code>marker</code> parameter value in a
<code>marker</code> parameter value in a subsequent limited subsequent limited request.
request.
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -22,10 +21,10 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Specifies the ID of the last-seen item. Use the <code>limit</code> The ID of the last-seen item. Use the <code>limit</code> parameter
parameter to make an initial limited request and use the ID of the to make an initial limited request and use the ID of the last-seen
last-seen item from the response as the <code>marker</code> item from the response as the <code>marker</code> parameter value
parameter value in a subsequent limited request. in a subsequent limited request.
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -71,12 +70,12 @@
The date and time when the image or server last changed status. The date and time when the image or server last changed status.
</para> </para>
<para> <para>
Use this query parameter to check for changes since a previous request Use this query parameter to check for changes since a previous
rather than re-downloading and re-parsing the full status at each request rather than re-downloading and re-parsing the full status
polling interval. If data has changed, only the items changed since at each polling interval. If data has changed, the response
the <code>changes-since</code> time are returned in the response. If returns only the items that have changed since the
data has not changed since the <code>changes-since</code> time, an <code>changes-since</code> time. If data has not changed since the
empty list is returned. <code>changes-since</code> time, the response returns an empty list.
</para> </para>
<para> <para>
For example, issue a &GET; request against the following endpoint to For example, issue a &GET; request against the following endpoint to
@ -86,9 +85,10 @@
<programlisting>GET /v2/010101/servers?changes-since=2015-01-24T17:08:00Z</programlisting> <programlisting>GET /v2/010101/servers?changes-since=2015-01-24T17:08:00Z</programlisting>
<para> <para>
To enable you to keep track of changes, this filter also displays To enable you to keep track of changes, this filter also displays
images and servers that were deleted if the <code>changes-since</code> deleted images and servers if the <code>changes-since</code> value
value specifies a date in the last 30 days. Items deleted more than 30 specifies a date in the last 30 days. The response might include
days ago might be returned, but it is not guaranteed. items that were deleted more than 30 days ago, but it is not
guaranteed.
</para> </para>
<para> <para>
The date and time stamp format is <link The date and time stamp format is <link
@ -193,11 +193,13 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para> <para>
The nonce. This random string is uniquely generated for each The nonce. The API generates this unique, random string for each
request and enables the service provider to verify that a request has never request and enables the service provider to verify that a request
been made before. A nonce helps prevent replay attacks when requests are made has never been made before. A nonce helps prevent replay attacks
over a non-secure channel, such as HTTP. For information, see <link when requests are made over a non-secure channel, such as HTTP.
xlink:href="http://oauth.net/core/1.0a/#nonce">Nonce and Timestamp</link>. For information, see <link
xlink:href="http://oauth.net/core/1.0a/#nonce">Nonce and
Timestamp</link>.
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
@ -693,7 +695,7 @@
Wed, 26 Aug 2015 19:57:28 GMT</code>. Wed, 26 Aug 2015 19:57:28 GMT</code>.
</para> </para>
<para> <para>
If not set, this header is not returned by this operation. If not set, this operation does not return this header.
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>

16
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-user-show-get-resp.json
View File

@ -1,16 +0,0 @@
{
"quota_set": {
"cores": 20,
"floating_ips": 10,
"id": "fake_tenant",
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"injected_files": 5,
"instances": 10,
"key_pairs": 100,
"metadata_items": 128,
"ram": 51200,
"security_group_rules": 20,
"security_groups": 10
}
}

14
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-user-show-get-resp.xml
View File

@ -1,14 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<quota_set id="fake_tenant">
<cores>20</cores>
<floating_ips>10</floating_ips>
<injected_file_content_bytes>10240</injected_file_content_bytes>
<injected_file_path_bytes>255</injected_file_path_bytes>
<injected_files>5</injected_files>
<instances>10</instances>
<key_pairs>100</key_pairs>
<metadata_items>128</metadata_items>
<ram>51200</ram>
<security_group_rules>20</security_group_rules>
<security_groups>10</security_groups>
</quota_set>

28
api-ref/src/wadls/volume-api/src/v1/api_samples/versionv1-get-resp.json
View File

@ -1,28 +0,0 @@
{
"version": {
"id": "v1.0",
"links": [
{
"href": "http://23.253.211.234:8776/v1/",
"rel": "self"
},
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
}
],
"media-types": [
{
"base": "application/xml",
"type": "application/vnd.openstack.volume+xml;version=1"
},
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"status": "DEPRECATED",
"updated": "2014-06-28T12:20:21Z"
}
}

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-show-defaults-get-resp.json → api-ref/src/wadls/volume-api/src/v1/samples/os-quota-sets/quotas-defaults-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-show-defaults-get-resp.xml → api-ref/src/wadls/volume-api/src/v1/samples/os-quota-sets/quotas-defaults-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-show-get-resp.json → api-ref/src/wadls/volume-api/src/v1/samples/os-quota-sets/quotas-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-show-get-resp.xml → api-ref/src/wadls/volume-api/src/v1/samples/os-quota-sets/quotas-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-update-post-req.json → api-ref/src/wadls/volume-api/src/v1/samples/os-quota-sets/quotas-update-request.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-update-post-req.xml → api-ref/src/wadls/volume-api/src/v1/samples/os-quota-sets/quotas-update-request.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-update-post-resp.json → api-ref/src/wadls/volume-api/src/v1/samples/os-quota-sets/quotas-update-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-update-post-resp.xml → api-ref/src/wadls/volume-api/src/v1/samples/os-quota-sets/quotas-update-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-quota-sets/quotas-user-show-detail-get-resp.json → api-ref/src/wadls/volume-api/src/v1/samples/os-user-quotas/user-quotas-show-detail-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-user-quotas/user-quotas-show-get-resp.json → api-ref/src/wadls/volume-api/src/v1/samples/os-user-quotas/user-quotas-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-user-quotas/user-quotas-show-get-resp.xml → api-ref/src/wadls/volume-api/src/v1/samples/os-user-quotas/user-quotas-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-user-quotas/user-quotas-update-post-req.json → api-ref/src/wadls/volume-api/src/v1/samples/os-user-quotas/user-quotas-update-request.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-user-quotas/user-quotas-update-post-req.xml → api-ref/src/wadls/volume-api/src/v1/samples/os-user-quotas/user-quotas-update-request.xml
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-user-quotas/user-quotas-update-post-resp.json → api-ref/src/wadls/volume-api/src/v1/samples/os-user-quotas/user-quotas-update-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/os-user-quotas/user-quotas-update-post-resp.xml → api-ref/src/wadls/volume-api/src/v1/samples/os-user-quotas/user-quotas-update-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_create.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-create-request.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_create.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-create-request.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_metadata_response.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-metadata-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_metadata_response.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-metadata-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_update_metadata_request.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-metadata-update-request.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_update_metadata_request.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-metadata-update-request.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_update_metadata_response.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-metadata-update-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_update_metadata_response.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-metadata-update-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_show.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_show.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshot-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_list_simple.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshots-list-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/snapshot_list_simple.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/snapshots-list-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/version-get-resp.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/version-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/cinder-versions-response.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/versions-list-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_create.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-create-request.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_create.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-create-request.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_show.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_show.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_type_create_request.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-type-create-request.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_type_create_request.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-type-create-request.xml
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/volume_type_show.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-type-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_type_show.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-type-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_type_list.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-types-list-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_type_list.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volume-types-list-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_list_simple.json → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volumes-list-response.json
View File

0
api-ref/src/wadls/volume-api/src/v1/api_samples/volume_list_simple.xml → api-ref/src/wadls/volume-api/src/v1/samples/volumes/volumes-list-response.xml
View File

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

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved --> <!-- (C) 2013-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [ <!DOCTYPE application [
<!ENTITY % common SYSTEM "../v2/common.ent"> <!ENTITY % common SYSTEM "../../v2/common.ent">
%common; %common;
<!ENTITY % common SYSTEM "../common_project.ent"> <!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project; %common_project;
]> ]>
<application xmlns="http://wadl.dev.java.net/2009/02" <application xmlns="http://wadl.dev.java.net/2009/02"
@ -16,62 +16,25 @@
<resource id="version-cinder-v1" type="#VersionDetails" <resource id="version-cinder-v1" type="#VersionDetails"
path="//v1"> path="//v1">
<resource id="tenant_id-cinder-v1" path="{tenant_id}"> <resource id="tenant_id-cinder-v1" path="{tenant_id}">
&tenantIdRequestParameter; &tenant_idTemplateParameter;
<resource id="os-quota-sets-cinder-for-v1" <resource id="os-quota-sets-cinder-for-v1"
path="os-quota-sets"> path="os-quota-sets">
<resource path="{tenant_id}" <resource path="{tenant_id}"
id="tenant_id-quotas-cinder-v1"> id="tenant_id-quotas-cinder-v1">
<param name="tenant_id" style="template" &tenant_idTemplateParameter2;
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Project ID">
<para>
The ID for the tenant for which you want
to show, update, or delete quotas. This ID
is different from the first tenant ID that
you specify in the URI: That ID is for the
admin tenant.
</para>
</wadl:doc>
</param>
<method href="#showQuota"/> <method href="#showQuota"/>
<method href="#updateQuota"/> <method href="#updateQuota"/>
<method href="#deleteQuotas"/> <method href="#deleteQuotas"/>
</resource> </resource>
<resource path="defaults" id="defaults-cinder-v1"> <resource path="defaults" id="defaults-cinder-v1">
<method href="#getDefaults"/> <method href="#showQuotaDefaults"/>
</resource> </resource>
<resource path="{tenant_id}" <resource path="{tenant_id}"
id="tenantID-cinder-v1"> id="tenantID-cinder-v1">
<param name="tenant_id" style="template" &tenant_idTemplateParameter2;
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Project ID">
<para>
The ID of the tenant for which you want to
show or update quotas. This ID is
different from the first tenant ID that
you specify in the URI: That ID is for the
admin tenant.
</para>
</wadl:doc>
</param>
<resource id="user_id-cinder-v1" <resource id="user_id-cinder-v1"
path="{user_id}"> path="{user_id}">
<param name="user_id" style="template" &user_idTemplateParameter;
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="User ID">
<para>
The user ID. Specify in the
URI as a query string:
<code>user_id={user_id}</code>.
</para>
</wadl:doc>
</param>
<method href="#showQuotaUser"/> <method href="#showQuotaUser"/>
<method href="#updateQuotaUser"/> <method href="#updateQuotaUser"/>
<method href="#deleteQuotasUser"/> <method href="#deleteQuotasUser"/>
@ -79,18 +42,7 @@
<resource id="detail-cinder-v1" path="detail"> <resource id="detail-cinder-v1" path="detail">
<resource id="user_id-detail-cinder-v1" <resource id="user_id-detail-cinder-v1"
path="{user_id}"> path="{user_id}">
<param name="user_id" style="template" &user_idTemplateParameter;
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="User ID">
<para>
The user ID. Specify in the
URI as a query string:
<code>user_id={user_id}</code>.
</para>
</wadl:doc>
</param>
<method href="#showQuotaDetailUser"/> <method href="#showQuotaDetailUser"/>
</resource> </resource>
</resource> </resource>
@ -99,11 +51,11 @@
</resource> </resource>
</resource> </resource>
</resources> </resources>
<method name="GET" id="getDefaults"> <method name="GET" id="showQuotaDefaults">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get default quotas"> title="Show default quotas">
<para role="shortdesc"> <para role="shortdesc">
Gets default quotas for a Shows default quotas for a
tenant. tenant.
</para> </para>
</wadl:doc> </wadl:doc>
@ -111,18 +63,18 @@
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" xml:lang="EN"
title="Get default quotas response: JSON"> title="Show default quotas: JSON response">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-show-defaults-get-resp.json" href="../samples/os-quota-sets/quotas-defaults-show-response.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" xml:lang="EN"
title="Get default quotas response: XML"> title="Show default quotas: XML response">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-show-defaults-get-resp.xml" href="../samples/os-quota-sets/quotas-defaults-show-response.xml"
/> />
</wadl:doc>&quotaSetsRespParameters; </representation> </wadl:doc>&quotaSetsRespParameters; </representation>
</response> </response>
@ -144,7 +96,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show quotas response: JSON"> xml:lang="EN" title="Show quotas response: JSON">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-show-get-resp.json" href="../samples/os-quota-sets/quotas-show-response.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@ -152,9 +104,10 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show quotas response: XML"> xml:lang="EN" title="Show quotas response: XML">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-show-get-resp.xml" href="../samples/os-quota-sets/quotas-show-response.xml"
/> />
</wadl:doc>&quotaSetsRespParameters; </wadl:doc>
&quotaSetsRespParameters;
&quotasShowResponse; &quotasShowResponse;
</representation> </representation>
</response> </response>
@ -171,7 +124,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update quotas response: JSON"> xml:lang="EN" title="Update quotas response: JSON">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-update-post-req.json" href="../samples/os-quota-sets/quotas-update-request.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@ -179,7 +132,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show quotas response: XML"> xml:lang="EN" title="Show quotas response: XML">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-update-post-req.xml" href="../samples/os-quota-sets/quotas-update-request.xml"
/> />
</wadl:doc>&quotaSetsReqParameters; </representation> </wadl:doc>&quotaSetsReqParameters; </representation>
</request> </request>
@ -188,7 +141,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update quota response: JSON"> xml:lang="EN" title="Update quota response: JSON">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-update-post-resp.json" href="../samples/os-quota-sets/quotas-update-response.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@ -196,7 +149,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update quota response: XML"> xml:lang="EN" title="Update quota response: XML">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-update-post-resp.xml" href="../samples/os-quota-sets/quotas-update-response.xml"
/> />
</wadl:doc> &quotaSetsRespParameters; </wadl:doc> &quotaSetsRespParameters;
</representation> </representation>
@ -226,7 +179,7 @@
xml:lang="EN" xml:lang="EN"
title="Show quotas for user response: JSON"> title="Show quotas for user response: JSON">
<xsdxt:code <xsdxt:code
href="api_samples/os-user-quotas/user-quotas-show-get-resp.json" href="../samples/os-user-quotas/user-quotas-show-response.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@ -235,7 +188,7 @@
xml:lang="EN" xml:lang="EN"
title="Show quotas for user response: XML"> title="Show quotas for user response: XML">
<xsdxt:code <xsdxt:code
href="api_samples/os-user-quotas/user-quotas-show-get-resp.xml" href="../samples/os-user-quotas/user-quotas-show-response.xml"
/> />
</wadl:doc> &quotaSetsRespParameters; </wadl:doc> &quotaSetsRespParameters;
</representation> </representation>
@ -254,7 +207,7 @@
xml:lang="EN" xml:lang="EN"
title="Update quotas for user request: JSON"> title="Update quotas for user request: JSON">
<xsdxt:code <xsdxt:code
href="api_samples/os-user-quotas/user-quotas-update-post-req.json" href="../samples/os-user-quotas/user-quotas-update-request.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@ -263,7 +216,7 @@
xml:lang="EN" xml:lang="EN"
title="Update quotas for user request: XML"> title="Update quotas for user request: XML">
<xsdxt:code <xsdxt:code
href="api_samples/os-user-quotas/user-quotas-update-post-req.xml" href="../samples/os-user-quotas/user-quotas-update-request.xml"
/> />
</wadl:doc> &quotaSetsReqParameters; </representation> </wadl:doc> &quotaSetsReqParameters; </representation>
</request> </request>
@ -273,7 +226,7 @@
xml:lang="EN" xml:lang="EN"
title="Update quotas for user response: JSON"> title="Update quotas for user response: JSON">
<xsdxt:code <xsdxt:code
href="api_samples/os-user-quotas/user-quotas-update-post-resp.json" href="../samples/os-user-quotas/user-quotas-update-response.json"
/> />
</wadl:doc> </wadl:doc>
</representation> </representation>
@ -282,7 +235,7 @@
xml:lang="EN" xml:lang="EN"
title="Show quotas for user response: XML"> title="Show quotas for user response: XML">
<xsdxt:code <xsdxt:code
href="api_samples/os-user-quotas/user-quotas-update-post-resp.xml" href="../samples/os-user-quotas/user-quotas-update-response.xml"
/> />
</wadl:doc>&quotaSetsRespParameters; </representation> </wadl:doc>&quotaSetsRespParameters; </representation>
</response> </response>
@ -311,7 +264,7 @@
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
title="Show quota details for user response: JSON"> title="Show quota details for user response: JSON">
<xsdxt:code <xsdxt:code
href="api_samples/os-quota-sets/quotas-user-show-detail-get-resp.json" href="../samples/os-user-quotas/user-quotas-show-detail-response.json"
/> />
</wadl:doc> </wadl:doc>
<param name="quota_set" style="plain" required="true" <param name="quota_set" style="plain" required="true"

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

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2015 OpenStack Foundation, All Rights Reserved --> <!-- (C) 2012-2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [ <!DOCTYPE application [
<!ENTITY % common SYSTEM "../v2/common.ent"> <!ENTITY % common SYSTEM "../../v2/common.ent">
%common; %common;
<!ENTITY % common SYSTEM "../common_project.ent"> <!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project; %common_project;
]> ]>
<application xmlns="http://wadl.dev.java.net/2009/02" <application xmlns="http://wadl.dev.java.net/2009/02"
@ -18,52 +18,39 @@
</resource> </resource>
<resource id="version" type="#VersionDetails" path="//v1"> <resource id="version" type="#VersionDetails" path="//v1">
<resource id="tenant_id" path="{tenant_id}"> <resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter; &tenant_idTemplateParameter;
<resource id="volumes" path="volumes"> <resource id="volumes" path="volumes">
<method href="#createVolume"/> <method href="#createVolume"/>
<method href="#getVolumesSimple"/> <method href="#listVolumesSimple"/>
<resource path="detail" id="detail-volume"> <resource path="detail" id="detail-volume">
<method href="#getVolumesDetail"/> <method href="#listVolumesDetail"/>
</resource> </resource>
<resource path="{volume_id}" id="volume_id"> <resource path="{volume_id}" id="volume_id">
<param name="volume_id" style="template" required="true" type="csapi:UUID"> &volume_idTemplateParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <method href="#showVolume"/>
<para>The unique identifier of an existing volume.</para>
</wadl:doc>
</param>
<method href="#getVolume"/>
<method href="#deleteVolume"/> <method href="#deleteVolume"/>
</resource> </resource>
</resource> </resource>
<resource id="types" path="types"> <resource id="types" path="types">
<method href="#getVolumeTypes"/> <method href="#listVolumeTypes"/>
<method href="#createVolumeType"/> <method href="#createVolumeType"/>
<resource path="{volume_type_id}" id="volume_type_id"> <resource path="{volume_type_id}" id="volume_type_id">
<param name="volume_type_id" style="template" required="true" &vol_type_idTemplateParameter;
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an existing volume type.</para>
</wadl:doc>
</param>
<method href="#updateVolumeType"/> <method href="#updateVolumeType"/>
<method href="#updateVolumeTypeExtraSpecs"/> <method href="#updateVolumeTypeExtraSpecs"/>
<method href="#getVolumeType"/> <method href="#showVolumeType"/>
<method href="#deleteVolumeType"/> <method href="#deleteVolumeType"/>
</resource> </resource>
</resource> </resource>
<resource id="snapshots" path="snapshots"> <resource id="snapshots" path="snapshots">
<method href="#createSnapshot"/> <method href="#createSnapshot"/>
<method href="#getSnapshotsSimple"/> <method href="#listSnapshotsSimple"/>
<resource path="detail" id="detail-snapshots"> <resource path="detail" id="detail-snapshots">
<method href="#getSnapshotsDetail"/> <method href="#listSnapshotsDetail"/>
</resource> </resource>
<resource path="{snapshot_id}" id="snapshot_id"> <resource path="{snapshot_id}" id="snapshot_id">
<param name="snapshot_id" style="template" required="true" type="csapi:UUID"> &snapshot_idTemplateParameter;
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <method href="#showSnapshot"/>
<para>The unique identifier of an existing snapshot.</para>
</wadl:doc>
</param>
<method href="#getSnapshot"/>
<method href="#deleteSnapshot"/> <method href="#deleteSnapshot"/>
<resource path="metadata" id="snapshot-metadata"> <resource path="metadata" id="snapshot-metadata">
<method href="#showSnapshotMetadata"/> <method href="#showSnapshotMetadata"/>
@ -91,7 +78,7 @@
<response status="200 300"> <response status="200 300">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/cinder-versions-response.json"/> <xsdxt:code href="../samples/volumes/versions-list-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<!-- The following call fails - opened bug #1311243 --> <!-- The following call fails - opened bug #1311243 -->
@ -99,7 +86,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"> xml:lang="EN">
<xsdxt:code <xsdxt:code
href="samples/cinder-versions-response.xml" href="../samples/volumes/cinder-versions-response.xml"
/> />
</wadl:doc> </wadl:doc>
</representation>--> </representation>-->
@ -114,7 +101,7 @@
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/versionv1-get-resp.json"/> <xsdxt:code href="../samples/volumes/version-show-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<!-- this call fails - opened bug 1311243 --> <!-- this call fails - opened bug 1311243 -->
@ -123,7 +110,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"> xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/version-get-resp.xml"/> href="../samples/version-show-resp.xml"/>
</wadl:doc> </wadl:doc>
<param name="location" style="plain" type="xsd:anyURI" <param name="location" style="plain" type="xsd:anyURI"
required="true" required="true"
@ -138,7 +125,7 @@
<response status="203"> <response status="203">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/versionv1-get-resp.json"/> <xsdxt:code href="../samples/volumes/version-show-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
@ -152,17 +139,19 @@
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_create.xml"/> <xsdxt:code href="../samples/volumes/volume-create-request.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_create.json"/> <xsdxt:code href="../samples/volumes/volume-create-request.json"/>
</wadl:doc> </wadl:doc>
<param name="volume" style="plain" required="true" type="csapi:string"> <param name="volume" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A partial representation of a volume used in the creation <para>
process.</para> A partial representation of a volume that the
creation process uses.
</para>
</wadl:doc> </wadl:doc>
</param> </param>
&createVolumeParameters; &createVolumeParameters;
@ -171,12 +160,12 @@
<response status="201"> <response status="201">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_show.xml"/> <xsdxt:code href="../samples/volumes/volume-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_show.json"/> <xsdxt:code href="../samples/volumes/volume-show-response.json"/>
</wadl:doc> </wadl:doc>
<param name="volume" style="plain" required="true" type="csapi:string"> <param name="volume" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@ -187,7 +176,7 @@
</representation> </representation>
</response> </response>
</method> </method>
<method name="GET" id="getVolumesSimple"> <method name="GET" id="listVolumesSimple">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List volumes"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List volumes">
<para role="shortdesc"> <para role="shortdesc">
Lists volumes. Lists volumes.
@ -196,12 +185,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_list_simple.xml"/> <xsdxt:code href="../samples/volumes/volumes-list-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_list_simple.json"/> <xsdxt:code href="../samples/volumes/volumes-list-response.json"/>
</wadl:doc> </wadl:doc>
<param name="volumes" style="plain" required="true" type="csapi:string"> <param name="volumes" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@ -212,7 +201,7 @@
</representation> </representation>
</response> </response>
</method> </method>
<method name="GET" id="getVolumesDetail"> <method name="GET" id="listVolumesDetail">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List volumes, with details"> title="List volumes, with details">
<para role="shortdesc"> <para role="shortdesc">
@ -222,12 +211,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_list_simple.xml"/> <xsdxt:code href="../samples/volumes/volumes-list-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_list_simple.json"/> <xsdxt:code href="../samples/volumes/volumes-list-response.json"/>
</wadl:doc> </wadl:doc>
<param name="volumes" style="plain" required="true" type="csapi:string"> <param name="volumes" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@ -238,7 +227,7 @@
</representation> </representation>
</response> </response>
</method> </method>
<method name="GET" id="getVolume"> <method name="GET" id="showVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show volume details"> title="Show volume details">
<para role="shortdesc"> <para role="shortdesc">
@ -248,12 +237,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_show.xml"/> <xsdxt:code href="../samples/volumes/volume-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_show.json"/> <xsdxt:code href="../samples/volumes/volume-show-response.json"/>
</wadl:doc> </wadl:doc>
<param name="volume" style="plain" required="true" type="csapi:string"> <param name="volume" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@ -274,7 +263,7 @@
</wadl:doc> </wadl:doc>
<response status="202"/> <response status="202"/>
</method> </method>
<method name="GET" id="getVolumeTypes"> <method name="GET" id="listVolumeTypes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List volume types"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List volume types">
<para role="shortdesc"> <para role="shortdesc">
Lists volume types. Lists volume types.
@ -283,12 +272,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_list.xml"/> <xsdxt:code href="../samples/volumes/volume-types-list-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_list.json"/> <xsdxt:code href="../samples/volumes/volume-types-list-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
@ -302,18 +291,18 @@
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_create_request.xml"/> <xsdxt:code href="../samples/volumes/volume-type-create-request.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_create_request.json"/> <xsdxt:code href="../samples/volumes/volume-type-create-request.json"/>
</wadl:doc> </wadl:doc>
<param name="volume_type" style="plain" required="true" type="csapi:string"> <param name="volume_type" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para> <para>
A partial representation of a volume type used in the creation A partial representation of a volume type that the
process. creation process uses.
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
@ -322,12 +311,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_show.xml"/> <xsdxt:code href="../samples/volumes/volume-type-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_show.json"/> <xsdxt:code href="../samples/volumes/volume-type-show-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
@ -342,17 +331,19 @@
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_create_request.xml"/> <xsdxt:code href="../samples/volumes/volume-type-create-request.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_create_request.json"/> <xsdxt:code href="../samples/volumes/volume-type-create-request.json"/>
</wadl:doc> </wadl:doc>
<param name="volume_type" style="plain" required="true" type="csapi:string"> <param name="volume_type" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A volume type offers a way to categorize <para>
or group volumes.</para> Use volume types to categorize
or group volumes.
</para>
</wadl:doc> </wadl:doc>
</param> </param>
</representation> </representation>
@ -360,12 +351,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_show.xml"/> <xsdxt:code href="../samples/volumes/volume-type-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_show.json"/> <xsdxt:code href="../samples/volumes/volume-type-show-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
@ -374,25 +365,23 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update extra specs for a volume type"> title="Update extra specs for a volume type">
<para role="shortdesc"> <para role="shortdesc">
Updates the extra specifications that are Updates the extra specifications for a volume type.
assigned to a volume type.
</para> </para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_create_request.xml"/> <xsdxt:code href="../samples/volumes/volume-type-create-request.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_create_request.json"/> <xsdxt:code href="../samples/volumes/volume-type-create-request.json"/>
</wadl:doc> </wadl:doc>
<param name="volume_type" style="plain" required="true" type="csapi:string"> <param name="volume_type" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para> <para>
A volume type. Use to categorize A volume type. Use to categorize or group volumes.
or group volumes.
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
@ -400,10 +389,9 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para> <para>
A key and value pair that contains additional A key and value pair that contains additional
specifications associated with the volume type. specifications for the volume type. Examples
Examples include capabilities, capacity, include capabilities, capacity, compression, and
compression, and so on, depending on the storage so on, depending on the storage driver in use.
driver in use.
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
@ -412,24 +400,26 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_show.xml"/> <xsdxt:code href="../samples/volumes/volume-type-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_show.json"/> <xsdxt:code href="../samples/volumes/volume-type-show-response.json"/>
</wadl:doc> </wadl:doc>
<param name="volume" style="plain" required="true" type="csapi:string"> <param name="volume" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A partial representation of a volume used in the creation <para>
process.</para> A partial representation of a volume that the
creation process uses.
</para>
</wadl:doc> </wadl:doc>
</param> </param>
&volumeDetailResponseParameters; &volumeDetailResponseParameters;
</representation> </representation>
</response> </response>
</method> </method>
<method name="GET" id="getVolumeType"> <method name="GET" id="showVolumeType">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show volume type details"> title="Show volume type details">
<para role="shortdesc"> <para role="shortdesc">
@ -439,12 +429,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_show.xml"/> <xsdxt:code href="../samples/volumes/volume-type-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_type_show.json"/> <xsdxt:code href="../samples/volumes/volume-type-show-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
@ -466,17 +456,19 @@
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_create.xml"/> <xsdxt:code href="../samples/volumes/snapshot-create-request.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_create.json"/> <xsdxt:code href="../samples/volumes/snapshot-create-request.json"/>
</wadl:doc> </wadl:doc>
<param name="snapshot" style="plain" required="true" type="csapi:string"> <param name="snapshot" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A partial representation of a snapshot used in the creation <para>
process.</para> A partial representation of a snapshot that the
creation process uses.
</para>
</wadl:doc> </wadl:doc>
</param> </param>
</representation> </representation>
@ -484,17 +476,17 @@
<response status="201"> <response status="201">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_show.xml"/> <xsdxt:code href="../samples/volumes/snapshot-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_show.json"/> <xsdxt:code href="../samples/volumes/snapshot-show-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
<method name="GET" id="getSnapshotsSimple"> <method name="GET" id="listSnapshotsSimple">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List snapshots"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List snapshots">
<para role="shortdesc"> <para role="shortdesc">
Lists simple snapshots. Lists simple snapshots.
@ -503,17 +495,17 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_list_simple.xml"/> <xsdxt:code href="../samples/volumes/snapshots-list-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_list_simple.json"/> <xsdxt:code href="../samples/volumes/snapshots-list-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
<method name="GET" id="getSnapshotsDetail"> <method name="GET" id="listSnapshotsDetail">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List snapshots with details"> title="List snapshots with details">
<para role="shortdesc">Lists all snapshots, with details.</para> <para role="shortdesc">Lists all snapshots, with details.</para>
@ -521,17 +513,17 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_list_simple.xml"/> <xsdxt:code href="../samples/volumes/snapshots-list-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_list_simple.json"/> <xsdxt:code href="../samples/volumes/snapshots-list-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
<method name="GET" id="getSnapshot"> <method name="GET" id="showSnapshot">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show snapshot details"> title="Show snapshot details">
<para role="shortdesc"> <para role="shortdesc">
@ -541,12 +533,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_show.xml"/> <xsdxt:code href="../samples/volumes/snapshot-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_show.json"/> <xsdxt:code href="../samples/volumes/snapshot-show-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
@ -568,12 +560,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_metadata_response.xml"/> <xsdxt:code href="../samples/volumes/snapshot-metadata-show-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_metadata_response.json"/> <xsdxt:code href="../samples/volumes/snapshot-metadata-show-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
@ -588,12 +580,12 @@
<request> <request>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_update_metadata_request.xml"/> <xsdxt:code href="../samples/volumes/snapshot-metadata-update-request.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_update_metadata_request.json"/> <xsdxt:code href="../samples/volumes/snapshot-metadata-update-request.json"/>
</wadl:doc> </wadl:doc>
<param name="metadata" style="plain" type="xsd:string" required="false"> <param name="metadata" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
@ -601,12 +593,19 @@
One or more metadata key and value pairs to set or unset for the One or more metadata key and value pairs to set or unset for the
snapshot. snapshot.
</para> </para>
<para>To unset a metadata key value, specify only the key name.</para> <para>
<para>To set a metadata key value, specify the key and value pair.</para> To unset a metadata key value, specify only the key name.
<para>The Block Storage server does not respect case-sensitive key names. </para>
For example, if you specify both <code>"key": "v1"</code> and <para>
<code>"KEY": "V1"</code>, the server sets and returns only the To set a metadata key value, specify the key and value pair.
<code>KEY</code> key and value pair.</para> </para>
<para>
The Block Storage server does not respect case-
sensitive key names. For example, if you specify
both <code>"key": "v1"</code> and <code>"KEY":
"V1"</code>, the server sets and returns only the
<code>KEY</code> key and value pair.
</para>
</wadl:doc> </wadl:doc>
</param> </param>
</representation> </representation>
@ -614,12 +613,12 @@
<response status="200"> <response status="200">
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_update_metadata_response.xml"/> <xsdxt:code href="../samples/volumes/snapshot-metadata-update-response.xml"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/snapshot_update_metadata_response.json"/> <xsdxt:code href="../samples/volumes/snapshot-metadata-update-response.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>

2
api-ref/src/wadls/volume-api/src/v2/api_samples/qos_create_request.xml
View File

@ -1,2 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<qos_specs name="performance-spec" delay="0" throughput="100"/>

11
api-ref/src/wadls/volume-api/src/v2/api_samples/qos_create_response.xml
View File

@ -1,11 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<qos_specs>
<qos_spec consumer="back-end"
id="ecfc6e2e-7117-44a4-8eec-f84d04f531a8"
name="performance-spec">
<specs>
<delay>0</delay>
<throughput>100</throughput>
</specs>
</qos_spec>
</qos_specs>

21
api-ref/src/wadls/volume-api/src/v2/api_samples/qos_details_show_response.json
View File

@ -1,21 +0,0 @@
{
"qos_specs": {
"specs": {
"availability": "100",
"numberOfFailures": "0"
},
"consumer": "back-end",
"name": "reliability-spec",
"id": "0388d6c6-d5d4-42a3-b289-95205c50dd15"
},
"links": [
{
"href": "http://23.253.228.211:8776/v2/e1cf63117ae74309a5bcc2002a23be8b/qos_specs/0388d6c6-d5d4-42a3-b289-95205c50dd15",
"rel": "self"
},
{
"href": "http://23.253.228.211:8776/e1cf63117ae74309a5bcc2002a23be8b/qos_specs/0388d6c6-d5d4-42a3-b289-95205c50dd15",
"rel": "bookmark"
}
]
}

2
api-ref/src/wadls/volume-api/src/v2/api_samples/qos_update_request.xml
View File

@ -1,2 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<qos_specs delay="2" throughput="100"/>

22
api-ref/src/wadls/volume-api/src/v2/api_samples/versionv2-get-resp.json
View File

@ -1,22 +0,0 @@
{
"version": {
"id": "v2.0",
"links": [
{
"href": "http://23.253.211.234:8776/v2/v2.0",
"rel": "self"
}
],
"media-types": [
{
"base": "application/xml",
"type": "application/vnd.openstack.volume+xml;version=1"
},
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"status": "CURRENT"
}
}

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

@ -38,8 +38,112 @@
<representation mediaType="application/xml" element="csapi:itemNotFound"/> <representation mediaType="application/xml" element="csapi:itemNotFound"/>
<representation mediaType="application/json"/> <representation mediaType="application/json"/>
</response>'> </response>'>
<!-- tenantIdRequestParameter --> <!ENTITY aliasTemplateParameter '
<!ENTITY tenantIdRequestParameter ' <param required="true"
xmlns="http://wadl.dev.java.net/2009/02"
name="alias" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
An alias, which is a name for a pointer to a resource. For example, a
named extension.
</para>
</wadl:doc>
</param>'>
<!ENTITY backup_idTemplateParameter '
<param name="backup_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for a backup.
</para>
</wadl:doc>
</param>'>
<!ENTITY cgsnapshot_idTemplateParameter '
<param name="cgsnapshot_id" style="template"
type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The unique identifier of the consistency
group snapshot.
</para>
</wadl:doc>
</param>'>
<!ENTITY consistencygroup_idTemplateParameter '
<param name="consistencygroup_id" style="template"
type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The unique identifier of the consistency
group.
</para>
</wadl:doc>
</param>'>
<!ENTITY hostnameTemplateParameter '
<param name="hostname" style="template"
type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<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 host that hosts the storage back end.
</para>
</wadl:doc>
</param>'>
<!ENTITY interface_idTemplateParameter '
<param name="attachment_id"
style="template" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The interface ID.
</para>
</wadl:doc>
</param>'>
<!ENTITY qos_idTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="qos_id" style="template"
type="xsd:string">
<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 QoS specification.
</para>
</wadl:doc>
</param>'>
<!ENTITY server_idTemplateParameter '
<param name="server_id" style="template"
type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The UUID for the server of
interest to you.</para>
</wadl:doc>
</param>'>
<!ENTITY snapshot_idTemplateParameter '
<param name="snapshot_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the snapshot.
</para>
</wadl:doc>
</param>'>
<!-- tenant_idTemplateParameter -->
<!ENTITY tenant_idTemplateParameter '
<param name="tenant_id" style="template" type="csapi:UUID" <param name="tenant_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02"> xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -50,6 +154,64 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY tenant_idTemplateParameter2 '
<param name="tenant_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for the tenant for which you want to show, update, or delete
quotas. This UUID is different from the first tenant ID that you specify
in the URI: That UUID is for the administrative tenant.
</para>
</wadl:doc>
</param>'>
<!ENTITY user_idTemplateParameter '
<param name="user_id" style="template"
type="xsd:string" required="true" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The user ID. Specify in the URI as <code>user_id={user_id}</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY vol_type_idTemplateParameter '
<param name="vol_type_id" id="vol_type_id"
style="query" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<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 volume type.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_idTemplateParameter '
<param name="volume_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the volume.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_type_idTemplateParameter '
<param name="volume_type_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for an existing volume type.
</para>
</wadl:doc>
</param>'>
<!ENTITY volumeListQueryParameters ' <!ENTITY volumeListQueryParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort" <param xmlns="http://wadl.dev.java.net/2009/02" name="sort"
style="query" required="false" type="xsd:string"> style="query" required="false" type="xsd:string">
@ -434,7 +596,7 @@
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" style="plain" name="source_volid" style="plain"
type="csapi:uuid" required="false"> type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
@ -467,7 +629,7 @@
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="snapshot_id" style="plain" name="snapshot_id" style="plain"
type="csapi:uuid" required="false"> type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
@ -498,7 +660,7 @@
<para>The volume name.</para></wadl:doc> <para>The volume name.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="imageRef" style="plain" type="csapi:uuid" name="imageRef" style="plain" type="csapi:UUID"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -547,6 +709,107 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param>' > </param>' >
<!ENTITY createVolumeResponseParameters '
<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 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>
The UUID of the source volume, if any.
</para>
</wadl:doc>
</param>
<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>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="multiattach" style="plain"
type="xsd:boolean" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
If <code>true</code>, this volume can attach to more than one instance.
</para>
</wadl:doc>
</param>
<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>
The UUID of the source snapshot, if any.
</para>
</wadl:doc>
</param>
<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 gibibytes (GiB).
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" 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 name.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="imageRef" 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 UUID of the source image, if any.
</para>
</wadl:doc>
</param>
<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>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="metadata" 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>
Metadata key and value pairs that are associated with the
volume.
</para>
</wadl:doc>
</param>'>
<!ENTITY isPublicParameterReq ' <!ENTITY isPublicParameterReq '
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-type-access:is_public" style="plain" required="false" name="os-volume-type-access:is_public" style="plain" required="false"
@ -583,7 +846,7 @@
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" <param xmlns="http://wadl.dev.java.net/2009/02" name="id"
style="plain" type="csapi:uuid" style="plain" type="csapi:UUID"
required="true"> required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -676,7 +939,7 @@
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="snapshot_id" style="plain" <param xmlns="http://wadl.dev.java.net/2009/02" name="snapshot_id" style="plain"
type="csapi:uuid" required="true"> type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
@ -687,7 +950,7 @@
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" style="plain" name="source_volid" style="plain"
type="csapi:uuid" required="true"> type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
@ -709,7 +972,7 @@
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" <param xmlns="http://wadl.dev.java.net/2009/02" name="id"
style="plain" type="csapi:uuid" style="plain" type="csapi:UUID"
required="true"> required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -815,7 +1078,7 @@
<para>The associated volume type.</para></wadl:doc> <para>The associated volume type.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="snapshot_id" style="plain" <param xmlns="http://wadl.dev.java.net/2009/02" name="snapshot_id" style="plain"
type="csapi:uuid" required="true"> type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
@ -826,7 +1089,7 @@
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" style="plain" name="source_volid" style="plain"
type="csapi:uuid" required="true"> type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
@ -848,7 +1111,7 @@
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" <param xmlns="http://wadl.dev.java.net/2009/02" name="id"
style="plain" type="csapi:uuid" style="plain" type="csapi:UUID"
required="true"> required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -1169,7 +1432,7 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY getConsistencyGroupsResponseParameters ' <!ENTITY listConsistencyGroupsResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true" name="id" style="plain" required="true"
type="csapi:UUID"> type="csapi:UUID">
@ -1192,7 +1455,7 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY getConsistencyGroupsDetailResponseParameters ' <!ENTITY listConsistencyGroupsDetailResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true" name="id" style="plain" required="true"
type="csapi:UUID"> type="csapi:UUID">
@ -1499,6 +1762,17 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY qos_specsParameter '
<param name="qos_specs" style="plain"
type="xsd:dict" required="true" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A <code>qos_specs</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY getCGsnapshotsListResponseParameters ' <!ENTITY getCGsnapshotsListResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true" name="id" style="plain" required="true"
@ -1718,7 +1992,7 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="volume_id" style="plain" type="csapi:uuid" <param xmlns="http://wadl.dev.java.net/2009/02" name="volume_id" style="plain" type="csapi:UUID"
required="true"> required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -1738,7 +2012,7 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" 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"> required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"

40
api-ref/src/wadls/volume-api/src/v2/grammar/requests/create-snapshot.json
View File

@ -1,40 +0,0 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#post",
"type": "object",
"properties": {
"snapshot": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#post/snapshot",
"type": "object",
"documentation": "A partial representation of a snapshot used in the creation process.",
"properties": {
"name": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#post/snapshot/name",
"type": "string",
"documentation": "Name of the snapshot. The default is None."
},
"description": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#post/snapshot/description",
"type": "string",
"documentation": "Description of the snapshot. The default is None."
},
"volume_id": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#post/snapshot/volume_id",
"type": "string",
"documentation": "To create a snapshot from an existing volume, specify the ID of the existing volume."
},
"force": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#post/snapshot/force",
"type": "boolean",
"documentation": "[True/False] Indicate whether to snapshot, even if the volume is attached. Default==False."
}
},
"required": [
"volume_id"
]
}
},
"required": [
"snapshot"
]
}

33
api-ref/src/wadls/volume-api/src/v2/grammar/requests/create-volume-type.json
View File

@ -1,33 +0,0 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/types#post",
"type": "object",
"properties": {
"volume_type": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/types#post/volume_type",
"type": "object",
"documentation": "A partial representation of a volume type used in the creation process.",
"properties": {
"name": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/types#post/volume_type/name",
"type": "string",
"documentation": "The name of the volume type."
},
"extra_specs": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/types#post/volume_type/extra_specs",
"type": "object",
"properties": {
"capabilities": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/types#post/volume_type/extra_specs/capabilities",
"type": "string"
}
}
}
},
"required": []
}
},
"required": [
"volume_type"
]
}

75
api-ref/src/wadls/volume-api/src/v2/grammar/requests/create-volume.json
View File

@ -1,75 +0,0 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://docs.openstack.org/api/openstack-block-storage/v2",
"type": "object",
"properties": {
"volume": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post",
"type": "object",
"properties": {
"availability_zone": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/availability_zone",
"type": "string",
"documentation": "The availability zone."
},
"source_volid": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/source_volid",
"type": "string",
"documentation": "To create a volume from an existing volume, specify the ID of the existing volume. If specified, the volume is created with same size of the source volume."
},
"description": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/description",
"type": "string",
"documentation": "The volume description."
},
"snapshot_id": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/snapshot_id",
"type": "string",
"documentation": "To create a volume from an existing snapshot, specify the ID of the existing volume snapshot. If specified, the volume is created in same availability zone and with same size of the snapshot."
},
"size": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/size",
"type": "integer",
"documentation": "The size of the volume, in GBs."
},
"name": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/name",
"type": "string",
"documentation": "The volume name."
},
"imageRef": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/imageRef",
"type": "string",
"documentation": "The ID of the image from which you want to create the volume. Required to create a bootable volume."
},
"volume_type": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/volume_type",
"type": "string",
"documentation": "The associated volume type."
},
"bootable": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/metadata",
"type": "boolean",
"documentation": "Enables or disables the bootable attribute. You can boot an instance from a bootable volume."
},
"metadata": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/metadata",
"type": "object",
"documentation": "One or more metadata key and value pairs to associate with the volume.",
"properties": {}
},
"encrypted": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volume#post/metadata",
"type": "boolean",
"documentation": "Enables or disables encryption of the volume. You must choose the same volume type as the source volume to restore an encrypted backup volume. Must be set to true to encrypt a volume."
}
},
"required": [
"size"
]
}
},
"required": [
"volume"
]
}

24
api-ref/src/wadls/volume-api/src/v2/grammar/requests/update-snapshot-metadata.json
View File

@ -1,24 +0,0 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots/metadata#put",
"type": "object",
"properties": {
"metadata": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots/metadata#put/metadata",
"type": "object",
"documentation": "One or more metadata key and value pairs to set or unset for the snapshot. To unset a metadata key value, specify only the key name. To set a metadata key value, specify the key and value pair. The Block Storage server does not respect case-sensitive key names. For example, if you specify both \"key\": \"v1\" and \"KEY\": \"V1\", the server sets and returns only the KEY key and value pair.",
"properties": {
"key": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots/metadata#put/metadata/key",
"type": "string"
}
},
"required": [
"key"
]
}
},
"required": [
"metadata"
]
}

27
api-ref/src/wadls/volume-api/src/v2/grammar/requests/update-snapshot.json
View File

@ -1,27 +0,0 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#put",
"type": "object",
"properties": {
"snapshot": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#put/snapshot",
"type": "object",
"properties": {
"name": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#put/snapshot/name",
"type": "string",
"documentation": "The name of the snapshot."
},
"description": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/snapshots#put/snapshot/description",
"type": "string",
"documentation": "Describes the snapshot."
}
},
"required": []
}
},
"required": [
"snapshot"
]
}

25
api-ref/src/wadls/volume-api/src/v2/grammar/requests/update-volume.json
View File

@ -1,25 +0,0 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volumes#put",
"type": "object",
"properties": {
"volume": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volumes#put/volume",
"type": "object",
"properties": {
"name": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volumes#put/volume/name",
"type": "string"
},
"description": {
"id": "http://docs.openstack.org/api/openstack-block-storage/v2/volumes#put/volume/description",
"type": "string"
}
},
"required": []
}
},
"required": [
"volume"
]
}

68
api-ref/src/wadls/volume-api/src/v2/os-backend-capabilities-v2.wadl
View File

@ -1,68 +0,0 @@
<?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="backend-capabilities-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="capabilities" path="capabilities">
<resource id="hostname" path="{hostname}">
<param name="hostname" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
The name of the host that hosts the storage back end.
</para>
</wadl:doc>
</param>
<method href="#getBackendCapabilities"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="getBackendCapabilities">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show back-end capabilities">
<para role="shortdesc">
Shows capabilities for a storage back end.
</para>
</wadl:doc>
<request>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/backend-capabilities/backend-capabilities-resp.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
&backendParametersResponse;
</representation>
</response>
</method>
</application>

75
api-ref/src/wadls/volume-api/src/v2/os-volume-type-access-v2.wadl
View File

@ -1,75 +0,0 @@
<?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"
xmlns:xlink="http://www.w3.org/1999/xlink">
<resources base="https://manage.example.com/"
xml:id="volume-type-access-v2">
<resource id="version" path="//v2">
<resource id="tenant_id" path="{tenant_id}">
&tenantIdRequestParameter;
<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 private volume">
<para role="shortdesc">
Creates a 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>
&volumeDetailResponseParameters;
&isPublicParameterResp;
</representation>
</response>
</method>
</application>

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_create_request.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-create-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_create_response.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-create-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_force_delete_request.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-force-delete-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_export_record_response.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-record-export-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_import_record_request.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-record-import-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_import_record_response.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-record-import-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_restore_request.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-restore-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_restore_response.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-restore-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_show_response.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backup-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_list_detail_response.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backups-list-detailed-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backup/backup_list_simple_response.json → api-ref/src/wadls/volume-api/src/v2/samples/backups/backups-list-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/backend-capabilities/backend-capabilities-resp.json → api-ref/src/wadls/volume-api/src/v2/samples/capabilities/backend-capabilities-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/cgsnapshots/cgsnapshots-create-request.json → api-ref/src/wadls/volume-api/src/v2/samples/cgsnapshots/cgsnapshots-create-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/cgsnapshots/cgsnapshots-create-response.json → api-ref/src/wadls/volume-api/src/v2/samples/cgsnapshots/cgsnapshots-create-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/cgsnapshots/cgsnapshots-list-detailed-response.json → api-ref/src/wadls/volume-api/src/v2/samples/cgsnapshots/cgsnapshots-list-detailed-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/cgsnapshots/cgsnapshots-list-response.json → api-ref/src/wadls/volume-api/src/v2/samples/cgsnapshots/cgsnapshots-list-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/cgsnapshots/cgsnapshots-show-response.json → api-ref/src/wadls/volume-api/src/v2/samples/cgsnapshots/cgsnapshots-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/consistencygroups/consistency-group-create-from-src-request.json → api-ref/src/wadls/volume-api/src/v2/samples/consistencygroups/consistency-group-create-from-src-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/consistencygroups/consistency-group-create-request.json → api-ref/src/wadls/volume-api/src/v2/samples/consistencygroups/consistency-group-create-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/consistencygroups/consistency-group-create-response.json → api-ref/src/wadls/volume-api/src/v2/samples/consistencygroups/consistency-group-create-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/consistencygroups/consistency-group-delete-request.json → api-ref/src/wadls/volume-api/src/v2/samples/consistencygroups/consistency-group-delete-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/consistencygroups/consistency-group-response.json → api-ref/src/wadls/volume-api/src/v2/samples/consistencygroups/consistency-group-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/consistencygroups/consistency-group-update-request.json → api-ref/src/wadls/volume-api/src/v2/samples/consistencygroups/consistency-group-update-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/consistencygroups/consistency-group-list-detailed-response.json → api-ref/src/wadls/volume-api/src/v2/samples/consistencygroups/consistency-groups-list-detailed-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/consistencygroups/consistency-group-list-response.json → api-ref/src/wadls/volume-api/src/v2/samples/consistencygroups/consistency-groups-list-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/host_attach_request.json → api-ref/src/wadls/volume-api/src/v2/samples/host-attach-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/limits/limits-show-get-resp.json → api-ref/src/wadls/volume-api/src/v2/samples/limits/limits-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/limits/limits-show-get-resp.xml → api-ref/src/wadls/volume-api/src/v2/samples/limits/limits-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-show-defaults-get-resp.json → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-show-defaults-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-show-defaults-get-resp.xml → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-show-defaults-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-show-get-resp.json → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-show-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-show-get-resp.xml → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-show-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-update-post-req.json → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-update-request.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-update-post-req.xml → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-update-request.xml
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-update-post-resp.json → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-update-response.json
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-update-post-resp.xml → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-update-response.xml
View File

0
api-ref/src/wadls/volume-api/src/v2/api_samples/os-quota-sets/quotas-user-show-detail-get-resp.json → api-ref/src/wadls/volume-api/src/v2/samples/os-quota-sets/quotas-user-show-detailed-response.json
View File

Some files were not shown because too many files have changed in this diff Show More