Update share API with multiple changes

- Spell-check and remove passive voice
- Added wadl directory, which contains wadl files
- Renamed code samples using this naming convention:
  <resource>-<action>-request.json or <resource>-<action>-response.json.
  For example, volume-create-request.json and volume-create-response.json.
- Removed unused code samples
- Made method names consistent throughout - use list<resource> for list
  operations, show<resource> for show operations, and so on.
- change csapi:uuid -> csapi:UUID
- Add information for time stamps

Change-Id: I437d4707e454501ecd5f00df96e4914a811c4c33
Partial-Bug: #1521244
This commit is contained in:
Diane Fleming
2015-12-09 21:28:10 -06:00
parent d0338d4e23
commit 7624fc7bd9
35 changed files with 2442 additions and 1917 deletions

View File

@@ -22,6 +22,6 @@
v1.
</para>
<para>
Starting with API v2.0, the API uses Compute-style micro-versions.
(Since API v2.0) The API uses Compute-style micro-versions.
</para>
</chapter>

View File

@@ -20,8 +20,8 @@
<section xml:id="migrate-share">
<title>Share actions (since API v2.5)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#action">
<wadl:method href="#migrateShare"/>
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#action">
<wadl:method href="#migrateShare" />
</wadl:resource>
</wadl:resources>
</section>
@@ -42,19 +42,19 @@
these actions to other roles.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#consistency-groups">
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#consistency-groups">
<wadl:method href="#createConsistencyGroup"/>
<wadl:method href="#getConsistencyGroups"/>
<wadl:method href="#listConsistencyGroups"/>
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#detail-consistency-groups">
<wadl:method href="#getConsistencyGroupsDetails"/>
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#detail-consistency-groups">
<wadl:method href="#listConsistencyGroupsDetails"/>
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#consistency_group_id">
<wadl:method href="#getConsistencyGroup"/>
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#consistency_group_id">
<wadl:method href="#showConsistencyGroup"/>
<wadl:method href="#updateConsistencyGroup"/>
<wadl:method href="#deleteConsistencyGroup"/>
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#consistency-groups-action">
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#consistency-groups-action">
<wadl:method href="#resetConsistencyGroupState"/>
<wadl:method href="#force-deleteConsistencyGroup"/>
</wadl:resource>
@@ -85,26 +85,24 @@
</para>
<para></para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshots">
<wadl:method href="#createConsistencyGroupSnapshot"/>
<wadl:method href="#getConsistencyGroupSnapshots"/>
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#cgsnapshots">
<wadl:method href="#createConsistencyGroupSnapshot" />
<wadl:method href="#listConsistencyGroupsnapshots" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#detail-cgsnapshots">
<wadl:method href="#listConsistencyGroupsnapshotsDetails" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#detail-cgsnapshots">
<wadl:method href="#getConsistencyGroupSnapshotsDetails"/>
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#cgsnapshot_id">
<wadl:method href="#listConsistencyGroupsnapshot" />
<wadl:method href="#updateConsistencyGroupSnapshot" />
<wadl:method href="#deleteConsistencyGroupSnapshot" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshot_id">
<wadl:method href="#getConsistencyGroupSnapshot"/>
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#cgsnapshot-members">
<wadl:method href="#listConsistencyGroupsnapshotMembers" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshot-members">
<wadl:method href="#getConsistencyGroupSnapshotMembers"/>
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshot_id">
<wadl:method href="#updateConsistencyGroupSnapshot"/>
<wadl:method href="#deleteConsistencyGroupSnapshot"/>
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshots-action">
<wadl:method href="#resetConsistencyGroupSnapshotState"/>
<wadl:method href="#force-deleteConsistencyGroupSnapshot"/>
<wadl:resource href="../wadls/share-api/src/v2/experimental/wadl/os-share-v2-experimental.wadl#cgsnapshots-action">
<wadl:method href="#resetConsistencyGroupSnapshotState" />
<wadl:method href="#force-deleteConsistencyGroupSnapshot" />
</wadl:resource>
</wadl:resources>
</section>

View File

@@ -32,25 +32,24 @@
Look for notes that identify in which post-v2 micro-version a feature,
method, or parameter was introduced.
</para>
<section xml:id="share-versions">
<title>API versions</title>
<para>
Lists information for all Shared File Systems API versions.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#versions">
<wadl:method href="#share-listVersions" />
</wadl:resource>
</wadl:resources>
</section>
<!-- <section xml:id="share-versions">
<title>API versions</title>
<para>
Lists information for all Shared File Systems API versions.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-versions-v2"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-version-v2"/>
</wadl:resources>
</section> -->
<section xml:id="share-extensions">
<title>API extensions</title>
<para>
Lists available Shared File Systems API extensions.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#extensions">
<wadl:method href="#getExtensions"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#extensions">
<wadl:method href="#listExtensions" />
</wadl:resource>
</wadl:resources>
</section>
@@ -94,8 +93,8 @@
a one-minute period.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#limits">
<wadl:method href="#getLimits"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#limits">
<wadl:method href="#listLimits" />
</wadl:resource>
</wadl:resources>
</section>
@@ -284,17 +283,17 @@
</table>
<para></para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#shares">
<wadl:method href="#createShare"/>
<wadl:method href="#getShares"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#shares">
<wadl:method href="#createShare" />
<wadl:method href="#listShares" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#detail-share">
<wadl:method href="#getSharesDetails"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#detail-share">
<wadl:method href="#listSharesDetails" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share_id">
<wadl:method href="#getShare"/>
<wadl:method href="#updateShare"/>
<wadl:method href="#deleteShare"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share_id">
<wadl:method href="#showShare" />
<wadl:method href="#updateShare" />
<wadl:method href="#deleteShare" />
</wadl:resource>
</wadl:resources>
</section>
@@ -304,13 +303,13 @@
Shows, sets, updates, and unsets share metadata.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#metadata-share">
<wadl:method href="#getShareMetadata"/>
<wadl:method href="#updateShareMetadata"/>
<wadl:method href="#setShareMetadata"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#metadata-share">
<wadl:method href="#showShareMetadata" />
<wadl:method href="#updateShareMetadata" />
<wadl:method href="#setShareMetadata" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#metadata_key">
<wadl:method href="#unSetShareMetadata"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#metadata_key">
<wadl:method href="#unSetShareMetadata" />
</wadl:resource>
</wadl:resources>
</section>
@@ -396,7 +395,7 @@
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#action">
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#action">
<wadl:method href="#grantAccess" />
<wadl:method href="#revokeAccess" />
<wadl:method href="#listAccessRules" />
@@ -444,19 +443,19 @@
these actions to other roles.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#snapshots">
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#snapshots">
<wadl:method href="#share-createSnapshot" />
<wadl:method href="#share-getSnapshots" />
<wadl:method href="#share-listSnapshots" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#detail-snapshot">
<wadl:method href="#share-getSnapshotsDetails" />
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#detail-snapshot">
<wadl:method href="#share-listSnapshotsDetails" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#snapshot_id">
<wadl:method href="#share-getSnapshot" />
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#snapshot_id">
<wadl:method href="#share-showSnapshot" />
<wadl:method href="#share-updateSnapshot" />
<wadl:method href="#share-deleteSnapshot" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#snapshot-action">
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#snapshot-action">
<wadl:method href="#resetSnapshotState" />
<wadl:method href="#forceshare-deleteSnapshot" />
</wadl:resource>
@@ -524,21 +523,21 @@
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share-networks">
<wadl:method href="#createShareNetwork"/>
<wadl:method href="#getShareNetworks"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-networks">
<wadl:method href="#createShareNetwork" />
<wadl:method href="#listShareNetworks" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#detail-share-network">
<wadl:method href="#getShareNetworksDetails"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#detail-share-network">
<wadl:method href="#listShareNetworksDetails" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share_network_id">
<wadl:method href="#getShareNetwork"/>
<wadl:method href="#updateShareNetwork"/>
<wadl:method href="#deleteShareNetwork"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share_network_id">
<wadl:method href="#showShareNetwork" />
<wadl:method href="#updateShareNetwork" />
<wadl:method href="#deleteShareNetwork" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share-network-action">
<wadl:method href="#addSecurityService"/>
<wadl:method href="#removeSecurityService"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-network-action">
<wadl:method href="#addSecurityService" />
<wadl:method href="#removeSecurityService" />
</wadl:resource>
</wadl:resources>
</section>
@@ -593,17 +592,17 @@
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#security-services">
<wadl:method href="#createSecurityService"/>
<wadl:method href="#getSecurityServices"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#security-services">
<wadl:method href="#createSecurityService" />
<wadl:method href="#listSecurityServices" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#detail-security-service">
<wadl:method href="#getSecurityServicesDetails"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#detail-security-service">
<wadl:method href="#listSecurityServicesDetails" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#security_service_id">
<wadl:method href="#getSecurityService"/>
<wadl:method href="#updateSecurityService"/>
<wadl:method href="#deleteSecurityService"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#security_service_id">
<wadl:method href="#showSecurityService" />
<wadl:method href="#updateSecurityService" />
<wadl:method href="#deleteSecurityService" />
</wadl:resource>
</wadl:resources>
</section>
@@ -687,15 +686,12 @@
</table>
<para></para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share-servers">
<wadl:method href="#getShareServers"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-servers-v2">
<wadl:method href="#listShareServers" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share_server_id">
<wadl:method href="#getShareServer"/>
<wadl:method href="#deleteShareServer"/>
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#detail-share-server">
<wadl:method href="#getShareServerDetails"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share_server_id">
<wadl:method href="#showShareServer" />
<wadl:method href="#deleteShareServer" />
</wadl:resource>
</wadl:resources>
</section>
@@ -708,15 +704,15 @@
actions to other roles.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share-instances">
<wadl:method href="#getShareInstances"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-instances">
<wadl:method href="#listShareInstances" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share_instance_id">
<wadl:method href="#getShareInstance"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share_instance_id">
<wadl:method href="#showShareInstance" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share-instances-action">
<wadl:method href="#resetShareInstanceState"/>
<wadl:method href="#force-deleteShareInstance"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-instances-action">
<wadl:method href="#resetShareInstanceState" />
<wadl:method href="#force-deleteShareInstance" />
</wadl:resource>
</wadl:resources>
</section>
@@ -830,29 +826,29 @@
specifications to other roles.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share-type">
<wadl:method href="#share-createShareType"/>
<wadl:method href="#share-getShareTypes"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-type">
<wadl:method href="#share-createShareType" />
<wadl:method href="#share-listShareTypes" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#default-share-type">
<wadl:method href="#getDefaultShareTypes"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#default-share-type">
<wadl:method href="#listDefaultShareTypes" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share_type_id">
<wadl:method href="#share-deleteShareType"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share_type_id">
<wadl:method href="#share-deleteShareType" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#share-type-action">
<wadl:method href="#addShareTypeAccess"/>
<wadl:method href="#removeShareTypeAccess"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#extra-specs-share-type">
<wadl:method href="#listExtraSpecsShareType" />
<wadl:method href="#setExtraSpecShareType" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-share-type-access">
<wadl:method href="#listShareTypeAccess"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#extra-spec-key">
<wadl:method href="#unsetExtraSpecShareType" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#extra-specs-share-type">
<wadl:method href="#getExtraSpecsShareType"/>
<wadl:method href="#setExtraSpecShareType"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#share-type-action">
<wadl:method href="#addShareTypeAccess" />
<wadl:method href="#removeShareTypeAccess" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#extra-spec-key">
<wadl:method href="#unsetExtraSpecShareType"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#os-share-type-access">
<wadl:method href="#showShareTypeAccess" />
</wadl:resource>
</wadl:resources>
</section>
@@ -863,11 +859,11 @@
known to the scheduler service.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#pools">
<wadl:method href="#getPools"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#pools">
<wadl:method href="#listPools" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#detail-pools">
<wadl:method href="#getPoolsDetails"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#detail-pools">
<wadl:method href="#listPoolsDetails" />
</wadl:resource>
</wadl:resources>
</section>
@@ -883,14 +879,14 @@
Administrators can also enable or disable a service.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-services">
<wadl:method href="#getServices"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#os-services">
<wadl:method href="#listServices" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#enable-service">
<wadl:method href="#enableService"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#enable-service">
<wadl:method href="#enableService" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#disable-service">
<wadl:method href="#disableService"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#disable-service">
<wadl:method href="#disableService" />
</wadl:resource>
</wadl:resources>
</section>
@@ -900,28 +896,17 @@
Describes availability zones.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-availability-zone">
<wadl:method href="#getAvailabilityZones"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#os-availability-zone">
<wadl:method href="#listAvailabilityZones" />
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="share-os-share-manage" xmlns="http://docbook.org/ns/docbook">
<title>Manage share</title>
<para>
Configures Shared File Systems to manage a share.
Configures Shared File Systems to manage or unmanage a share.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-share-manage">
<wadl:method href="#manageShare"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="share-os-share-unmanage" xmlns="http://docbook.org/ns/docbook">
<title>Unmanage share</title>
<para>
Configures Shared File Systems to unmanage a share.
</para>
<para>
The share unmanage operation is not supported for shares that are
created on top of share servers (created with share networks).
</para>
@@ -929,8 +914,11 @@
You can unmanage a share that has no dependent snapshots.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#unmanage">
<wadl:method href="#unmanageShare"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#os-share-manage">
<wadl:method href="#manageShare" />
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#unmanage">
<wadl:method href="#unmanageShare" />
</wadl:resource>
</wadl:resources>
</section>
@@ -940,13 +928,13 @@
Provides quotas management support.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#tenant_id_quota">
<wadl:method href="#getQuota"/>
<wadl:method href="#share-updateQuota"/>
<wadl:method href="#share-deleteQuotas"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#tenant_id-os-quota-sets">
<wadl:method href="#os-quota-sets-showQuota"/>
<wadl:method href="#os-quota-sets-updateQuota"/>
<wadl:method href="#os-quota-sets-deleteQuota"/>
</wadl:resource>
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#quota-defaults">
<wadl:method href="#getDefaultQuotas"/>
<wadl:resource href="../wadls/share-api/src/v2/wadl/os-share-v2.wadl#os-quota-sets-defaults">
<wadl:method href="#os-quota-sets-listDefaultQuotas"/>
</wadl:resource>
</wadl:resources>
</section>

File diff suppressed because it is too large Load Diff

View File

@@ -206,7 +206,7 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY getConsistencyGroupsResponseParameters '
<!ENTITY listConsistencyGroupsResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true"
type="csapi:UUID">
@@ -392,7 +392,7 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY getConsistencyGroupSnapshotsResponseParameters '
<!ENTITY listConsistencyGroupSnapshotsResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true"
type="csapi:UUID">
@@ -415,7 +415,7 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY getConsistencyGroupSnapshotMembersResponseParameters '
<!ENTITY listConsistencyGroupSnapshotMembersResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true"
type="csapi:UUID">

View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application[
<!ENTITY % common SYSTEM "common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/share/api/v1.0"
@@ -14,21 +14,21 @@
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<resources base="https://share_server_id.example.com/" xml:id="os-share-v1.0">
<resources base="https://share_server_id.example.com/" xml:id="os-share-v2.0-experimental">
<resource id="versions" path="/">
<param name="X-Openstack-Manila-Api-Version" style="header" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A valid Shared File Systems API micro-version.
For example,
<code>"X-Openstack-Manila-Api-Version: 2.6"</code>.
If you omit this header, the default micro-version is 2.0.
<para>
A valid Shared File Systems API micro-version. For example,
<code>"X-Openstack-Manila-Api-Version: 2.6"</code>. If you
omit this header, the default micro-version is 2.0.
</para>
</wadl:doc>
</param>
<method href="#share-listVersions" />
<method href="#listVersions-v2-experimental" />
<resource id="version" path="v2">
<resource id="extensions" path="extensions">
<method href="#getExtensions" />
<method href="#listExtensions" />
</resource>
<resource id="tenant_id" path="{tenant_id}">
<param name="X-OpenStack-Manila-API-Experimental" style="header" type="xsd:bool"
@@ -36,15 +36,16 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Indicates that this is an experimental Shared File
Systems API request. Set to <code>true</code>.
For example,
<code>"X-OpenStack-Manila-API-Experimental: true"</code>.
Systems API request. Set to <code>true</code>. For
example, <code>"X-OpenStack-Manila-API-Experimental:
true"</code>.
</para>
</wadl:doc>
</param>
<param name="tenant_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The tenant ID in a multi-tenancy cloud.</para>
<para>
The tenant ID in a multi-tenancy cloud.</para>
</wadl:doc>
</param>
<resource id="shares" path="shares">
@@ -63,9 +64,9 @@
</resource>
<resource id="consistency-groups" path="consistency-groups">
<method href="#createConsistencyGroup" />
<method href="#getConsistencyGroups" />
<method href="#listConsistencyGroups" />
<resource path="detail" id="detail-consistency-groups">
<method href="#getConsistencyGroupsDetails" />
<method href="#listConsistencyGroupsDetails" />
</resource>
<resource path="{consistency_group_id}" id="consistency_group_id">
<param name="consistency_group_id" style="template" type="csapi:UUID">
@@ -73,7 +74,7 @@
<para>The UUID of the consistency group.</para>
</wadl:doc>
</param>
<method href="#getConsistencyGroup" />
<method href="#showConsistencyGroup" />
<method href="#updateConsistencyGroup" />
<method href="#deleteConsistencyGroup" />
<resource id="consistency-groups-action" path="action">
@@ -84,9 +85,9 @@
</resource>
<resource id="cgsnapshots" path="cgsnapshots">
<method href="#createConsistencyGroupSnapshot" />
<method href="#getConsistencyGroupSnapshots" />
<method href="#listConsistencyGroupsnapshots" />
<resource path="detail" id="detail-cgsnapshots">
<method href="#getConsistencyGroupSnapshotsDetails" />
<method href="#listConsistencyGroupsnapshotsDetails" />
</resource>
<resource path="{cgsnapshot_id}" id="cgsnapshot_id">
<param name="cgsnapshot_id" style="template" type="csapi:UUID">
@@ -94,12 +95,12 @@
<para>The UUID of the consistency group snapshot.</para>
</wadl:doc>
</param>
<resource path="members" id="cgsnapshot-members">
<method href="#getConsistencyGroupSnapshotMembers" />
</resource>
<method href="#getConsistencyGroupSnapshot" />
<method href="#listConsistencyGroupsnapshot" />
<method href="#updateConsistencyGroupSnapshot" />
<method href="#deleteConsistencyGroupSnapshot" />
<resource path="members" id="cgsnapshot-members">
<method href="#listConsistencyGroupsnapshotMembers" />
</resource>
<resource id="cgsnapshots-action" path="action">
<method href="#resetConsistencyGroupSnapshotState" />
<method href="#force-deleteConsistencyGroupSnapshot" />
@@ -116,18 +117,17 @@
Migrates a share from one back end to another.
</para>
<para>
You can migrate a share from one back end to another but
both back ends must set the
<code>driver_handles_share_servers</code> parameter to
<code>False</code>. This action is not supported if one of the
back ends is handled by a share driver. You can configure a back
end in the <code>manila.conf</code> file.
You can migrate a share from one back end to another but both back
ends must set the <code>driver_handles_share_servers</code>
parameter to <code>False</code>. If a share driver handles one of
the back ends, this action is not supported. You can configure a
back end in the <code>manila.conf</code> file.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-share-actions-migrate-request.json" />
<xsdxt:code href="../samples/manila-share-actions-migrate-request.json" />
</wadl:doc>
&migrateShareRequestParameters;
</representation>
@@ -141,7 +141,7 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-create-request.json" />
<xsdxt:code href="../samples/manila-consistency-group-create-request.json" />
</wadl:doc>
&createConsistencyGroupRequestParameters;
</representation>
@@ -149,26 +149,26 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-create-response.json" />
<xsdxt:code href="../samples/manila-consistency-group-create-response.json" />
</wadl:doc>
&createConsistencyGroupResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="getConsistencyGroups">
<method name="GET" id="listConsistencyGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List consistency groups">
<para role="shortdesc">Lists all consistency groups.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-list-response.json" />
<xsdxt:code href="../samples/manila-consistency-groups-list-response.json" />
</wadl:doc>
&getConsistencyGroupsResponseParameters;
&listConsistencyGroupsResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="getConsistencyGroupsDetails">
<method name="GET" id="listConsistencyGroupsDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="List consistency groups with details">
<para role="shortdesc">Lists all consistency groups with details.</para>
@@ -176,13 +176,13 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-list-detailed-response.json" />
<xsdxt:code href="../samples/manila-consistency-groups-list-detailed-response.json" />
</wadl:doc>
&createConsistencyGroupResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="getConsistencyGroup">
<method name="GET" id="showConsistencyGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show consistency group details">
<para role="shortdesc">Shows details for a consistency group.</para>
@@ -190,7 +190,7 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-show-response.json" />
<xsdxt:code href="../samples/manila-consistency-group-show-response.json" />
</wadl:doc>
&createConsistencyGroupResponseParameters;
</representation>
@@ -217,7 +217,7 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-update-request.json" />
<xsdxt:code href="../samples/manila-consistency-group-update-request.json" />
</wadl:doc>
&updateConsistencyGroupRequestParameters;
</representation>
@@ -225,7 +225,7 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-update-response.json" />
<xsdxt:code href="../samples/manila-consistency-group-update-response.json" />
</wadl:doc>
&createConsistencyGroupResponseParameters;
</representation>
@@ -241,13 +241,19 @@
<method name="POST" id="resetConsistencyGroupState">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Reset consistency group state">
<para role="shortdesc">Administrator only. Explicitly updates the state of a consistency group.</para>
<para>Use the <code>policy.json</code> file to grant permissions for this action to other roles.</para>
<para role="shortdesc">
Administrator only. Explicitly updates the state of a consistency
group.
</para>
<para>
Use the <code>policy.json</code> file to grant permissions for
this action to other roles.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-reset-state-request.json" />
<xsdxt:code href="../samples/manila-consistency-group-reset-state-request.json" />
</wadl:doc>
&resetConsistencyGroupStateRequestParameter;
</representation>
@@ -257,13 +263,18 @@
<method name="POST" id="force-deleteConsistencyGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Force-delete consistency group">
<para role="shortdesc">Administrator only. Force-deletes a consistency group.</para>
<para>Use the <code>policy.json</code> file to grant permissions for this action to other roles.</para>
<para role="shortdesc">
Administrator only. Force-deletes a consistency group.
</para>
<para>
Use the <code>policy.json</code> file to grant permissions for
this action to other roles.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-consistency-group-force-delete-request.json" />
<xsdxt:code href="../samples/manila-consistency-group-force-delete-request.json" />
</wadl:doc>
&force-deleteConsistencyGroupRequestParameter;
</representation>
@@ -282,7 +293,7 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-create-request.json" />
<xsdxt:code href="../samples/manila-cg-snapshot-create-request.json" />
</wadl:doc>
&createConsistencyGroupSnapshotRequestParameters;
</representation>
@@ -290,13 +301,13 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-create-response.json" />
<xsdxt:code href="../samples/manila-cg-snapshot-create-response.json" />
</wadl:doc>
&createConsistencyGroupSnapshotResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="getConsistencyGroupSnapshots">
<method name="GET" id="listConsistencyGroupsnapshots">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="List consistency group snapshots">
<para role="shortdesc">Lists all consistency group snapshots.</para>
@@ -304,13 +315,13 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-list-response.json" />
<xsdxt:code href="../samples/manila-cg-snapshots-list-response.json" />
</wadl:doc>
&getConsistencyGroupSnapshotsResponseParameters;
&listConsistencyGroupSnapshotsResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="getConsistencyGroupSnapshotsDetails">
<method name="GET" id="listConsistencyGroupsnapshotsDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="List consistency group snapshots with details">
<para role="shortdesc">Lists all consistency group snapshots with details.</para>
@@ -318,13 +329,13 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-list-detailed-response.json" />
<xsdxt:code href="../samples/manila-cg-snapshots-list-detailed-response.json" />
</wadl:doc>
&createConsistencyGroupSnapshotResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="getConsistencyGroupSnapshot">
<method name="GET" id="listConsistencyGroupsnapshot">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show consistency group snapshot details">
<para role="shortdesc">Shows details for a consistency group snapshot.</para>
@@ -332,13 +343,13 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-show-response.json" />
<xsdxt:code href="../samples/manila-cg-snapshot-show-response.json" />
</wadl:doc>
&createConsistencyGroupSnapshotResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="getConsistencyGroupSnapshotMembers">
<method name="GET" id="listConsistencyGroupsnapshotMembers">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show consistency group snapshot member">
<para role="shortdesc">Shows information about a consistency group snapshot member.</para>
@@ -346,9 +357,9 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-list-members-response.json" />
<xsdxt:code href="../samples/manila-cg-snapshots-list-members-response.json" />
</wadl:doc>
&getConsistencyGroupSnapshotMembersResponseParameters;
&listConsistencyGroupSnapshotMembersResponseParameters;
</representation>
</response>
</method>
@@ -373,7 +384,7 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-update-request.json" />
<xsdxt:code href="../samples/manila-cg-snapshot-update-request.json" />
</wadl:doc>
&updateConsistencyGroupSnapshotRequestParameters;
</representation>
@@ -381,7 +392,7 @@
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-update-response.json" />
<xsdxt:code href="../samples/manila-cg-snapshot-update-response.json" />
</wadl:doc>
&createConsistencyGroupSnapshotResponseParameters;
</representation>
@@ -409,7 +420,7 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-reset-state-request.json" />
<xsdxt:code href="../samples/manila-cg-snapshot-reset-state-request.json" />
</wadl:doc>
&resetConsistencyGroupSnapshotStateRequestParameter;
</representation>
@@ -429,7 +440,7 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/manila-cg-snapshot-force-delete-request.json" />
<xsdxt:code href="../samples/manila-cg-snapshot-force-delete-request.json" />
</wadl:doc>
&force-deleteConsistencyGroupSnapshotRequestParameter;
</representation>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff