Add backend capabilities description
WADL file and JSON sample file are newly created. But, JSON sample file refers the original patch. Change-Id: Iec83ee75afefbeb9871b22d961cc9b06cbfd7ca5 Closes-Bug: #1491101
This commit is contained in:
Atsushi SAKAI
Diane Fleming
parent
a71bbcc114
commit
c9dd9f5c44
@ -24,25 +24,34 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="volume-api-v2-extensions">
|
||||
<title>API extensions</title>
|
||||
<title>API extensions (extensions)</title>
|
||||
<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:method href="#listExtensions-cinder-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-limits-v2">
|
||||
<title>Limits (limits)</title>
|
||||
<para>Shows absolute limits for a tenant.</para>
|
||||
<para>
|
||||
An absolute limit value of <code>-1</code> indicates that the
|
||||
absolute limit for the item is infinite.
|
||||
</para>
|
||||
<wadl:resources href="../wadls/volume-api/src/v2/os-limits-v2.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="volume-api-v2-volumes">
|
||||
<title>Volumes</title>
|
||||
<title>Volumes (volumes)</title>
|
||||
<para>
|
||||
A volume is a detachable block storage device similar to a USB
|
||||
hard drive. You can attach a volume to one instance at a time.
|
||||
</para>
|
||||
<para>
|
||||
The <code>snapshot_id</code> and <code>source_volid</code>
|
||||
parameters specify the ID of the snapshot or volume from which
|
||||
this volume originates.
|
||||
If the volume was not created from a snapshot or source volume,
|
||||
these values are null.
|
||||
The <code>snapshot_id</code> and <code>source_volid</code>
|
||||
parameters specify the ID of the snapshot or volume from which this
|
||||
volume originates. If the volume was not created from a snapshot or
|
||||
source volume, these values are null.
|
||||
</para>
|
||||
<para>When you create, list, update, or delete volumes, the possible status
|
||||
values are:</para>
|
||||
@ -111,6 +120,7 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para></para>
|
||||
<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:method href="#createVolume"/>
|
||||
@ -126,8 +136,27 @@
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-volume-type-access-v2">
|
||||
<title>Volume type access (volumes)</title>
|
||||
<para>
|
||||
Creates private volumes.
|
||||
</para>
|
||||
<para>
|
||||
By default, volumes are public. To create a private volume, set
|
||||
the <code>is_public</code> boolean field to <code>false</code> at
|
||||
volume creation time. To control access to a private volume, you
|
||||
add a project to or remove a project from the volume. Private
|
||||
volume types without projects are only accessible by users with the
|
||||
administrative role and context.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-volume-type-access-v2.wadl#volumes">
|
||||
<wadl:method href="#createVolumeTypeAccessExt"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="volume-api-v2-volumes-actions">
|
||||
<title>Volume actions</title>
|
||||
<title>Volume actions (volumes, action)</title>
|
||||
<para>
|
||||
Performs actions for a specified volume. Extends the size, resets
|
||||
statuses for, sets image metadata, or removes image metadata from
|
||||
@ -143,162 +172,15 @@
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="volume-api-v2-types">
|
||||
<title>Volume types</title>
|
||||
<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:method href="#getVolumeTypes"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api-v2.wadl#types">
|
||||
<wadl:method href="#createVolumeType"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume_type_id">
|
||||
<wadl:method href="#updateVolumeType"/>
|
||||
<wadl:method href="#updateVolumeTypeExtraSpecs"/>
|
||||
<wadl:method href="#getVolumeType"/>
|
||||
<wadl:method href="#deleteVolumeType"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="volume-api-v2-snapshots">
|
||||
<title>Snapshots</title>
|
||||
<para>A snapshot is a point-in-time copy of the data that a
|
||||
volume contains.</para>
|
||||
<para>When you create, list, or delete snapshots, these status
|
||||
values are possible:</para>
|
||||
<table rules="all" frame="border">
|
||||
<caption>Snapshot statuses</caption>
|
||||
<col width="30%"/>
|
||||
<col width="70%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Status</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<para>creating</para></td>
|
||||
<td><para>The snapshot is being created.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>available</para></td>
|
||||
<td><para>The snapshot is ready to be used.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>deleting</para></td>
|
||||
<td><para>The snapshot is being deleted.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>error</para></td>
|
||||
<td><para>An error occurred during snapshot
|
||||
creation.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>error_deleting</para></td>
|
||||
<td><para>An error occurred during snapshot
|
||||
deletion.</para></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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:method href="#createSnapshot"/>
|
||||
<wadl:method href="#getSnapshotsSimple"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#detail-snapshot">
|
||||
<wadl:method href="#getSnapshotsDetail"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot_id">
|
||||
<wadl:method href="#getSnapshot"/>
|
||||
<wadl:method href="#updateSnapshot"/>
|
||||
<wadl:method href="#deleteSnapshot"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot-metadata">
|
||||
<wadl:method href="#showSnapshotMetadata"/>
|
||||
<wadl:method href="#updateSnapshotMetadata"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-qos-v2-qos-specs">
|
||||
<title>Quality of service (QoS) specifications (qos-specs)</title>
|
||||
<para>Administrators only, depending on policy settings.</para>
|
||||
<para>
|
||||
Creates, lists, shows details for, associates, disassociates, sets keys,
|
||||
unsets keys, and deletes quality of service (QoS) specifications.
|
||||
</para>
|
||||
<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:method href="#createQoSSpec"/>
|
||||
<wadl:method href="#listQoSSpecs"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#qos_id"/>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#associate">
|
||||
<wadl:method href="#associateQoSSpec"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#disassociate">
|
||||
<wadl:method href="#disassociateQoSSpec"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#disassociate_all">
|
||||
<wadl:method href="#disassociateQoSSpecAll"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#associations">
|
||||
<wadl:method href="#getQoSAssociations"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-quota-sets-v2">
|
||||
<title>Quota sets extension (os-quota-sets)</title>
|
||||
<para>Administrators only, depending on policy settings.
|
||||
</para>
|
||||
<para>
|
||||
Shows, updates, and deletes quotas for a tenant.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#tenant_id_cinder_v2">
|
||||
<wadl:method href="#showQuota"/>
|
||||
<wadl:method href="#updateQuota"/>
|
||||
<wadl:method href="#deleteQuotas"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#defaults-cinder-v2">
|
||||
<wadl:method href="#getDefaults"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#user_id-cinder-v2">
|
||||
<wadl:method href="#showQuotaUser"/>
|
||||
<wadl:method href="#updateQuotaUser"/>
|
||||
<wadl:method href="#deleteQuotasUser"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#user_id-detail-cinder-v2">
|
||||
<wadl:method href="#showQuotaDetailUser"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-limits-v2">
|
||||
<title>Limits extension (limits)</title>
|
||||
<para>Shows absolute limits for a tenant.</para>
|
||||
<para>
|
||||
An absolute limit value of <code>-1</code> indicates that the
|
||||
absolute limit for the item is infinite.
|
||||
</para>
|
||||
<wadl:resources href="../wadls/volume-api/src/v2/os-limits-v2.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-backups-v2">
|
||||
<title>Backups</title>
|
||||
<title>Backups (backups)</title>
|
||||
<para>
|
||||
A backup is a full copy of a volume stored in an external service.
|
||||
The service can be configured. The only supported service for now
|
||||
is Object Storage. A backup can subsequently be restored from the
|
||||
The service can be configured. The only supported service is
|
||||
Object Storage. A backup can subsequently be restored from the
|
||||
external service to either the same volume that the backup was
|
||||
originally taken from, or to a new volume. Backup and restore
|
||||
operations can only be carried out on volumes which are in an
|
||||
originally taken from or to a new volume. Backup and restore
|
||||
operations can only be carried out on volumes that are in an
|
||||
unattached and available state.
|
||||
</para>
|
||||
<para>When you create, list, or delete backups, these status
|
||||
@ -350,6 +232,7 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para></para>
|
||||
<para>In the event of an error, more information about the error
|
||||
can be found in the <literal>fail_reason</literal> field for
|
||||
the backup.</para>
|
||||
@ -371,7 +254,7 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="ext-backups-actions-v2">
|
||||
<title>Backup actions</title>
|
||||
<title>Backup actions (backups, action)</title>
|
||||
<para>
|
||||
Force-deletes a backup.
|
||||
</para>
|
||||
@ -381,6 +264,155 @@
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-backend-capabilities-v2">
|
||||
<title>Capabilities for storage back ends (capabilities)</title>
|
||||
<para>
|
||||
Shows capabilities for a storage back end.
|
||||
</para>
|
||||
<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:method href="#getBackendCapabilities"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-quota-sets-v2">
|
||||
<title>Quota sets extension (os-quota-sets)</title>
|
||||
<para>Administrators only, depending on policy settings.
|
||||
</para>
|
||||
<para>
|
||||
Shows, updates, and deletes quotas for a tenant.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#tenant_id_cinder_v2">
|
||||
<wadl:method href="#showQuota"/>
|
||||
<wadl:method href="#updateQuota"/>
|
||||
<wadl:method href="#deleteQuotas"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#defaults-cinder-v2">
|
||||
<wadl:method href="#getDefaults"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#user_id-cinder-v2">
|
||||
<wadl:method href="#showQuotaUser"/>
|
||||
<wadl:method href="#updateQuotaUser"/>
|
||||
<wadl:method href="#deleteQuotasUser"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-quota-sets-v2.wadl#user_id-detail-cinder-v2">
|
||||
<wadl:method href="#showQuotaDetailUser"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-qos-v2-qos-specs">
|
||||
<title>Quality of service (QoS) specifications (qos-specs)</title>
|
||||
<para>Administrators only, depending on policy settings.</para>
|
||||
<para>
|
||||
Creates, lists, shows details for, associates, disassociates, sets keys,
|
||||
unsets keys, and deletes quality of service (QoS) specifications.
|
||||
</para>
|
||||
<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:method href="#createQoSSpec"/>
|
||||
<wadl:method href="#listQoSSpecs"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#qos_id"/>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#associate">
|
||||
<wadl:method href="#associateQoSSpec"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#disassociate">
|
||||
<wadl:method href="#disassociateQoSSpec"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#disassociate_all">
|
||||
<wadl:method href="#disassociateQoSSpecAll"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-qos-v2.wadl#associations">
|
||||
<wadl:method href="#getQoSAssociations"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="volume-api-v2-types">
|
||||
<title>Volume types (types)</title>
|
||||
<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:method href="#getVolumeTypes"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api-v2.wadl#types">
|
||||
<wadl:method href="#createVolumeType"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume_type_id">
|
||||
<wadl:method href="#updateVolumeType"/>
|
||||
<wadl:method href="#updateVolumeTypeExtraSpecs"/>
|
||||
<wadl:method href="#getVolumeType"/>
|
||||
<wadl:method href="#deleteVolumeType"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="volume-api-v2-snapshots">
|
||||
<title>Volume snapshots (snapshots)</title>
|
||||
<para>A snapshot is a point-in-time copy of the data that a
|
||||
volume contains.</para>
|
||||
<para>When you create, list, or delete snapshots, these status
|
||||
values are possible:</para>
|
||||
<table rules="all" frame="border">
|
||||
<caption>Snapshot statuses</caption>
|
||||
<col width="30%"/>
|
||||
<col width="70%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Status</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<para>creating</para></td>
|
||||
<td><para>The snapshot is being created.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>available</para></td>
|
||||
<td><para>The snapshot is ready to be used.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>deleting</para></td>
|
||||
<td><para>The snapshot is being deleted.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>error</para></td>
|
||||
<td><para>An error occurred during snapshot
|
||||
creation.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>error_deleting</para></td>
|
||||
<td><para>An error occurred during snapshot
|
||||
deletion.</para></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para></para>
|
||||
<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:method href="#createSnapshot"/>
|
||||
<wadl:method href="#getSnapshotsSimple"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#detail-snapshot">
|
||||
<wadl:method href="#getSnapshotsDetail"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot_id">
|
||||
<wadl:method href="#getSnapshot"/>
|
||||
<wadl:method href="#updateSnapshot"/>
|
||||
<wadl:method href="#deleteSnapshot"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot-metadata">
|
||||
<wadl:method href="#showSnapshotMetadata"/>
|
||||
<wadl:method href="#updateSnapshotMetadata"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-volume-manage-v2">
|
||||
<title>Volume manage extension (os-volume-manage)</title>
|
||||
<para>
|
||||
@ -396,23 +428,4 @@
|
||||
</para>
|
||||
<wadl:resources href="../wadls/volume-api/src/v2/os-vol-image-meta-v2.wadl"/>
|
||||
</section>
|
||||
<section xml:id="os-volume-type-access-v2">
|
||||
<title>Volume type access (volumes)</title>
|
||||
<para>
|
||||
Creates private volumes.
|
||||
</para>
|
||||
<para>
|
||||
By default, volumes are public. To create a private volume, set
|
||||
the <code>is_public</code> boolean field to <code>false</code> at
|
||||
volume creation time. To control access to a private volume, you
|
||||
add a project to or remove a project from the volume. Private
|
||||
volume types without projects are only accessible by users with the
|
||||
administrative role and context.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/volume-api/src/v2/os-volume-type-access-v2.wadl#volumes">
|
||||
<wadl:method href="#createVolumeTypeAccessExt"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
{
|
||||
"namespace": "OS::Storage::Capabilities::fake",
|
||||
"vendor_name": "OpenStack",
|
||||
"volume_backend_name": "lvm",
|
||||
"pool_name": "pool",
|
||||
"driver_version": "2.0.0",
|
||||
"storage_protocol": "iSCSI",
|
||||
"display_name": "Capabilities of Cinder LVM driver",
|
||||
"description": "These are volume type options provided by Cinder LVM driver, blah, blah.",
|
||||
"visibility": "public",
|
||||
"properties": {
|
||||
"compression": {
|
||||
"title": "Compression",
|
||||
"description": "Enables compression.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"qos": {
|
||||
"title": "QoS",
|
||||
"description": "Enables QoS.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"replication": {
|
||||
"title": "Replication",
|
||||
"description": "Enables replication.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"thin_provisioning": {
|
||||
"title": "Thin Provisioning",
|
||||
"description": "Sets thin provisioning.",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -729,7 +729,119 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The attaching mountpoint.
|
||||
The attaching mount point.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY backendParametersResponse '
|
||||
<param name="namespace" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
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 storage name space, such as <code>OS::Storage::Capabilities::foo</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="vendor_name" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
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 vendor name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="volume_backend_name" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Volume back-end storage name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="pool_name" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
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 pool name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="driver_version" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
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 driver version.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="storage_protocol" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
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 storage protocol, such as Fibre Channel, iSCSI, NFS, and so on.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="display_name" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
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 display name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="description" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
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 storage description.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="visibility" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Enables public or private visibility. Set to <code>True</code> to
|
||||
make the back end publicly visible.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="properties" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A set of storage properties, such as QoS, IOPS, and so on.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
|
||||
@ -0,0 +1,62 @@
|
||||
<?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 specified 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>
|
||||
Loading…
x
Reference in New Issue
Block a user