From d947b882e2253af957f04339703b1c779f439f21 Mon Sep 17 00:00:00 2001 From: sslypushenko Date: Thu, 17 Sep 2015 19:41:43 +0300 Subject: [PATCH] Add Shared File Systems API Extensions Added the documentation of the extensions API of the Shared File Systems [1] API v1 and v2. [1] https://wiki.openstack.org/wiki/Manila Change-Id: I76e2f6f49891eaa1c635fb231e7b90adb8e76bd8 Partial-Bug: #1498053 --- api-ref-guides/src/bk-api-ref-share-v2.xml | 1 + .../src/docbkx/ch_share-v2-experimental.xml | 24 +- api-ref/src/docbkx/ch_share-v2.xml | 117 ++- api-ref/src/wadls/share-api/src/v2/common.ent | 807 +++++++++++++++++- .../common.ent} | 0 .../os-share-v2-experimental.wadl | 13 +- .../manila-cg-snapshot-create-request.json | 0 .../manila-cg-snapshot-create-response.json | 0 ...nila-cg-snapshot-force-delete-request.json | 0 ...la-cg-snapshot-list-detailed-response.json | 0 ...ila-cg-snapshot-list-members-response.json | 0 .../manila-cg-snapshot-list-response.json | 0 ...anila-cg-snapshot-reset-state-request.json | 0 .../manila-cg-snapshot-show-response.json | 0 .../manila-cg-snapshot-update-request.json | 0 .../manila-cg-snapshot-update-response.json | 0 ...nila-consistency-group-create-request.json | 0 ...ila-consistency-group-create-response.json | 0 ...onsistency-group-force-delete-request.json | 0 ...sistency-group-list-detailed-response.json | 0 ...anila-consistency-group-list-response.json | 0 ...consistency-group-reset-state-request.json | 0 ...anila-consistency-group-show-response.json | 0 ...nila-consistency-group-update-request.json | 0 ...ila-consistency-group-update-response.json | 0 ...manila-share-actions-migrate-request.json} | 0 .../wadls/share-api/src/v2/os-share-v2.wadl | 365 +++++++- ...nila-availability-zones-list-response.json | 10 + ...anila-quota-class-quota-show-response.json | 10 + ...nila-quota-class-quota-update-request.json | 6 + ...ila-quota-class-quota-update-response.json | 9 + .../samples/manila-quota-show-response.json | 10 + .../samples/manila-quota-update-request.json | 8 + .../samples/manila-quota-update-response.json | 9 + .../manila-services-disable-request.json | 4 + .../manila-services-disable-response.json | 5 + .../manila-services-enable-request.json | 4 + .../manila-services-enable-response.json | 5 + ...a-share-actions-grant-access-request.json} | 0 ...-share-actions-grant-access-response.json} | 0 ...-share-actions-revoke-access-request.json} | 0 .../samples/manila-share-manage-request.json | 14 + .../samples/manila-share-manage-response.json | 37 + ...nila-share-type-grant-access-request.json} | 0 ...ila-share-type-revoke-access-request.json} | 0 45 files changed, 1377 insertions(+), 81 deletions(-) rename api-ref/src/wadls/share-api/src/v2/{experimental.ent => experimental/common.ent} (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/os-share-v2-experimental.wadl (98%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-create-request.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-create-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-force-delete-request.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-list-detailed-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-list-members-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-list-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-reset-state-request.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-show-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-update-request.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-cg-snapshot-update-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-create-request.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-create-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-force-delete-request.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-list-detailed-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-list-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-reset-state-request.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-show-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-update-request.json (100%) rename api-ref/src/wadls/share-api/src/v2/{ => experimental}/samples/manila-consistency-group-update-response.json (100%) rename api-ref/src/wadls/share-api/src/v2/{samples/manila-share-actions-mirate-request.json => experimental/samples/manila-share-actions-migrate-request.json} (100%) create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-availability-zones-list-response.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-show-response.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-update-request.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-update-response.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-quota-show-response.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-quota-update-request.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-quota-update-response.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-services-disable-request.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-services-disable-response.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-services-enable-request.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-services-enable-response.json rename api-ref/src/wadls/share-api/src/v2/samples/{manila-share-actions-allow-access-request.json => manila-share-actions-grant-access-request.json} (100%) rename api-ref/src/wadls/share-api/src/v2/samples/{manila-share-actions-allow-access-response.json => manila-share-actions-grant-access-response.json} (100%) rename api-ref/src/wadls/share-api/src/v2/samples/{manila-share-actions-deny-access-request.json => manila-share-actions-revoke-access-request.json} (100%) create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-share-manage-request.json create mode 100644 api-ref/src/wadls/share-api/src/v2/samples/manila-share-manage-response.json rename api-ref/src/wadls/share-api/src/v2/samples/{manila-share-type-access-add-request.json => manila-share-type-grant-access-request.json} (100%) rename api-ref/src/wadls/share-api/src/v2/samples/{manila-share-type-access-remove-request.json => manila-share-type-revoke-access-request.json} (100%) diff --git a/api-ref-guides/src/bk-api-ref-share-v2.xml b/api-ref-guides/src/bk-api-ref-share-v2.xml index 6bf1b8464..a67747153 100644 --- a/api-ref-guides/src/bk-api-ref-share-v2.xml +++ b/api-ref-guides/src/bk-api-ref-share-v2.xml @@ -33,4 +33,5 @@ + diff --git a/api-ref/src/docbkx/ch_share-v2-experimental.xml b/api-ref/src/docbkx/ch_share-v2-experimental.xml index f8ed831af..7fe13526e 100644 --- a/api-ref/src/docbkx/ch_share-v2-experimental.xml +++ b/api-ref/src/docbkx/ch_share-v2-experimental.xml @@ -18,9 +18,9 @@ File Systems API without maintaining backward compatibility.
- Share actions + Share actions (since API v2.5) - + @@ -42,19 +42,19 @@ these actions to other roles. - + - + - + - + @@ -85,24 +85,24 @@ - + - + - + - + - + - + diff --git a/api-ref/src/docbkx/ch_share-v2.xml b/api-ref/src/docbkx/ch_share-v2.xml index 494a7a4b6..29916f419 100644 --- a/api-ref/src/docbkx/ch_share-v2.xml +++ b/api-ref/src/docbkx/ch_share-v2.xml @@ -318,12 +318,11 @@
Share actions - Use share actions to grant or deny access to a specified share, - list the permissions for a specified share, and explicitly update - the state of a share. + Grants or revokes share access, lists the permissions for a + specified share, and explicitly updates the state of a share. - To grant or deny access to a share, specify one of these supported + To grant or revoke share access, specify one of these supported share access levels: @@ -400,13 +399,13 @@ - - - - - - - + + + + + + +
@@ -492,7 +491,8 @@ For more information about supported plug-ins for share networks, see Manila + xlink:type="simple" + xlink:href="http://docs.openstack.org/developer/manila/adminref/network_plugins.html">Manila Network Plugins. @@ -818,7 +818,7 @@ The scheduler uses the special capabilities prefix for filtering. The scheduler can only create a share on a back end - that reports capabilities that match the un-scoped extra-spec keys + that reports capabilities that match the unscoped extra-spec keys for the share type. For details, see Capabilities and Extra-Specs. @@ -873,4 +873,95 @@
+
+ Services + + Lists services. Services include manila-share and manila-scheduler and their binaries, hosts, availability + zones, current statuses, and states (up or + down). + + + Administrators can also enable or disable a specified service. + + + + + + + + + + + + +
+
+ Availability zones + + Describes availability zones. + + + + + + +
+
+ Manage share + + Configures Shared File Systems to manage a specified share. + + + + + + +
+
+ Unmanage share + + Configures Shared File Systems to unmanage a specified share. + + + The share unmanage operation is not supported for shares that are + created on top of share servers (created with share networks). + + + You can unmanage a share that has no dependent snapshots. + + + + + + +
+
+ Quota sets + + Provides quotas management support. + + + + + + + + + + + +
+
+ Quota classes + + Provides quota classes management support. + + + + + + + +
diff --git a/api-ref/src/wadls/share-api/src/v2/common.ent b/api-ref/src/wadls/share-api/src/v2/common.ent index 11314b05c..da7904c11 100644 --- a/api-ref/src/wadls/share-api/src/v2/common.ent +++ b/api-ref/src/wadls/share-api/src/v2/common.ent @@ -460,7 +460,10 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - (Since API v2.6.) The share type ID. + (Since API v2.6.) The share type ID. + + + In minor versions, this parameter is a share type name, as a string. @@ -941,6 +944,193 @@ &sourceCgsnapshotMemberIdParameter; &isPublicParameter; &shareMetadataResponseParameter;'> + + + + The share ID. + + + +&shareNameParameter;'> + + + + The share links. + + + +&availabilityZoneRequiredParameter; + + + + The share network ID. + + + + + + + A list of export locations. For example, when a share server has more + than one network interface, it can have multiple export locations. + + + + + + + The ID of the share server. + + + + + + + The snapshot ID. + + + + + + + The share ID. + + + + + + + The share size, in GBs. + + + + + + + (Since API v2.6.) The share type ID. + + + In minor versions, this parameter is a share type name, as a string. + + + + + + + (Since API v2.6.) The share type name. + + + Minor versions support only the share_type parameter + where the share type name is expected. + + + + + + + The export location. + + + +&consistencyGroupIdParameter; + + + + The ID of the project in which the share was created. + + + +&shareMetadataResponseParameter; + + + + The share status, which is available, + manage_starting, or manage_error. + + + +&shareDescriptionParameter; + + + + The share host name. + + + +&isPublicParameter; +&snapshotSupportParameter; +&shareNameParameter; + + + + The date and time stamp when the share was created. + + + +&fileSystemProtocolParameter; +&volumeTypeParameter; +&sourceCgsnapshotMemberIdParameter;'> '> - @@ -1116,7 +1306,7 @@ '> - @@ -1224,7 +1414,7 @@ '> - @@ -2914,7 +3104,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The service binary. Default is the base name of the executable. + The service binary name. Default is the base name of the executable. @@ -2963,6 +3153,116 @@ '> + + + + The name of the service binary that you want to enable. Typically, this + name is the base name of the executable. + + + + + + + The host name of the service that you want to enable. + + +'> + + + + The name of the enabled service binary. Typically, this name is the base + name of the executable. + + + + + + + The host name of enabled service. + + + +&disabledServiceParameter;'> + + + + Indicates whether the service is disabled. + + +'> + + + + The name of the service binary that you want to disable. Typically, this + name is the base name of the executable. + + + + + + + The host name of the service that you want to disable. + + +'> + + + + The name of the disabled service binary. Typically, this name is the + base name of the executable. + + + + + + + The host name of disabled service. + + + +&disabledServiceParameter;'> - - - - The ID of the share server. - - - + @@ -3650,8 +3940,8 @@ host. The host name for the back end. - POOL. The pool name for the back end. backend. The name of the back end. + POOL. The pool name for the back end. '> @@ -3878,4 +4168,485 @@ New size of the share, in GBs. -'> \ No newline at end of file +'> + + + + The host pool of the destination back end, in this format: + host@backend#POOL. + + + host. The host name for the destination back end. + backend. The name of the destination back end. + POOL. The pool name for the destination back end. + + + + + + + Enables or disables generic host-based forced migrations, which bypasses + driver optimizations. Default is false. + + +'> + + + + + The service ID. + + + + + + + The service status, which is enabled + or disabled. + + + + + + + The service binary name. Default is the base name of the executable. + + + + + + + The availability zone. + + + + + + + The host name. + + + + + + + The current state of the service, which is up or + down. + + + + + + + The date and time stamp when the service was updated. + + +'> + + + + The number of gigabytes allowed for each tenant. + + + + + + + The number of snapshots allowed for each tenant. + + + + + + + The number of shares allowed for each tenant. + + + + + + + The number of gigabytes for the snapshots allowed for each tenant. + + + + + + + The number of share networks allowed for each tenant. + + +'> + + + + The ID of the tenant for which you manage quotas. + + + +&QuotaResponseParameters;'> + + + + The number of gigabytes for the tenant. + + + + + + + The number of snapshots for the tenant. + + + + + + + The number of shares for the tenant. + + + + + + + The number of gigabytes for the snapshots for the tenant. + + + + + + + The number of share networks for the tenant. + + + + + + + Indicates whether to permit or deny the force-update of a quota + that is already used and the requested value exceeds the configured + quota. + + + Set to True to permit the force-update of the quota. + + + Set to False to deny the force-update of the quota. + + +'> + + + + The quota class ID. + + + +&QuotaResponseParameters;'> + + + + The name of a quota class for which you + want to update the quotas. + + + + + + + The number of gigabytes for the tenant. + + + + + + + The number of snapshots for the tenant. + + + + + + + The number of shares for the tenant. + + + + + + + The number of gigabytes for the snapshots for the tenant. + + + + + + + The number of share networks for the tenant. + + +'> + + + + The Shared File Systems protocol of the share to manage. + A valid value is NFS, CIFS, + GlusterFS, or HDFS. + + + +&shareNameParameter; + + + + The share type name. + + + + + + + A set of one or more key and value pairs, as a dictionary of strings, + that describe driver options. + + + + + + + The share export path in the format appropriate for the protocol: + + + + NFS protocol. 10.0.0.1:/foo_path. For example, + 10.254.0.5:/shares/share-42033c24-0261-424f-abda + -4fef2f6dbfd5. + + + CIFS protocol. \\10.0.0.1\foo_name_of_cifs_share. + + + + + + + + The manage-share service host in this format: host@backend#POOL. + + + host. The host name for the back end. + backend. The name of the back end. + POOL. The pool name for the back end. + + + +&shareDescriptionParameter;'> + + + + The name of the availability zone. + + + + + + + The availability zone ID. + + + + + + + The date and time stamp when the availability zone was created. + + + + + + + The date and time stamp when the availability zone was updated. + + +'> + + + + A share object. + + +'> + + + + A shares object. + + +'> diff --git a/api-ref/src/wadls/share-api/src/v2/experimental.ent b/api-ref/src/wadls/share-api/src/v2/experimental/common.ent similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/experimental.ent rename to api-ref/src/wadls/share-api/src/v2/experimental/common.ent diff --git a/api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl b/api-ref/src/wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl similarity index 98% rename from api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl rename to api-ref/src/wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl index d79f8c88a..ce5424921 100644 --- a/api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl +++ b/api-ref/src/wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl @@ -3,9 +3,7 @@ %common; - - %experimental; - + %common_project; ]> - The ID of an existing share. + + The ID of the share. + @@ -113,7 +113,8 @@ - Migrates a specified share from one back end to another. (Since API v2.5.) + Migrates a specified share from one back end to another. + You can migrate a specified share from one back end to another but both back ends must set the @@ -126,7 +127,7 @@ - + &migrateShareRequestParameters; diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-create-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-create-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-create-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-create-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-create-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-create-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-create-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-create-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-force-delete-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-force-delete-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-force-delete-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-force-delete-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-detailed-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-list-detailed-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-detailed-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-list-detailed-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-members-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-list-members-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-members-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-list-members-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-list-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-list-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-reset-state-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-reset-state-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-reset-state-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-reset-state-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-show-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-show-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-show-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-show-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-update-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-update-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-update-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-update-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-update-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-update-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-update-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-cg-snapshot-update-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-create-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-create-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-create-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-create-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-create-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-create-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-create-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-create-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-force-delete-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-force-delete-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-force-delete-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-force-delete-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-list-detailed-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-list-detailed-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-list-detailed-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-list-detailed-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-list-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-list-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-list-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-list-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-reset-state-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-reset-state-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-reset-state-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-reset-state-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-show-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-show-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-show-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-show-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-update-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-update-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-update-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-update-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-update-response.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-update-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-update-response.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-consistency-group-update-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-mirate-request.json b/api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-share-actions-migrate-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-mirate-request.json rename to api-ref/src/wadls/share-api/src/v2/experimental/samples/manila-share-actions-migrate-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/os-share-v2.wadl b/api-ref/src/wadls/share-api/src/v2/os-share-v2.wadl index 16a304e59..9eedfafa1 100644 --- a/api-ref/src/wadls/share-api/src/v2/os-share-v2.wadl +++ b/api-ref/src/wadls/share-api/src/v2/os-share-v2.wadl @@ -56,15 +56,17 @@ - The ID of an existing share. + + The ID of the share. + - - + + @@ -95,7 +97,9 @@ - The ID of an existing snapshot. + + The ID of the snapshot. + @@ -116,7 +120,9 @@ - The ID of an existing share network. + + The ID of the share network. + @@ -137,7 +143,7 @@ - The ID of an existing security service. + The ID of the security service. @@ -150,7 +156,7 @@ - The ID of an existing share server. + The ID of the share server. @@ -169,7 +175,7 @@ - The ID of an existing share type. + The ID of the share type. @@ -199,7 +205,7 @@ - The ID of an existing share instance. + The ID of the share instance. @@ -209,6 +215,86 @@ + + + + + + + + + + + + + + + + + The ID of a share. + + + + + + + + + + + + + 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. + + + + + + + The user ID. If you specify this query + parameter, you update the quotas for this + user in the specified tenant. If you omit + this parameter, you update the quotas for + the specified project. + + + + + + + + + + + + + + + + The name of the quota class for which you + want to manage quotas. + + + + + + + + + @@ -302,14 +388,14 @@ - display_name, which also changes the - name of the share. + display_name, which also changes the + name of the share. - display_description, which also changes the - description of the share. + display_description, which also changes the + description of the share. @@ -318,8 +404,10 @@ - If you try to update other attributes, they retain their - previous values. + + If you try to update other attributes, they retain their + previous values. + @@ -412,37 +500,37 @@ - - + + Grants access to a specified share. - + - &allowAccessRequestParameters; + &grantAccessRequestParameters; - + - &allowAccessResponseParameters; + &grantAccessResponseParameters; - - - Denies access to a specified share. + + + Revokes access from a specified share. - + - &denyAccessRequestParameters; + &revokeAccessRequestParameters; @@ -470,8 +558,14 @@ - Administrator only. Explicitly updates the state of a specified share. - Use the policy.json file to grant permissions for this action to other roles. + + Administrator only. Explicitly updates the state of a specified + share. + + + Use the policy.json file to grant permissions for this + action to other roles. + @@ -485,8 +579,13 @@ - Administrator only. Force-deletes a specified share in any state. - Use the policy.json file to grant permissions for this action to other roles. + + Administrator only. Force-deletes a specified share in any state. + + + Use the policy.json file to grant permissions for this + action to other roles. + @@ -1076,7 +1175,7 @@ - + &addShareTypeAccessRequestParameter; @@ -1091,7 +1190,7 @@ - + &removeShareTypeAccessRequestParameter; @@ -1194,4 +1293,206 @@ + + + Lists services. + + + + + + + &getServicesResponseParameters; + + + + + + Enables a specified service. + + + + + + + &enableServiceRequestParameters; + + + + + + + + &enableServiceResponseParameters; + + + + + + Disables a specified service. + + + + + + + &disableServiceRequestParameters; + + + + + + + + &disableServiceResponseParameters; + + + + + + Lists all availability zones. + + + + + + + &getAvailabilityZonesResponseParameters; + + + + + + Configures Shared File Systems to manage a specified share. + + + + + + + &shareObjectParameter; + &manageShareRequestParameters; + + + + + + + + &shareObjectParameter; + &manageShareResponseParameters; + + + + + + Configures Shared File Systems to stop managing a specified share. + + + + + + Shows quotas for a specified tenant. + + If you specify the optional user_id query parameter, + you get the quotas for this user in the specified tenant. If you + omit this parameter, you get the quotas for the specified project. + + + + + + + + &getQuotaResponseParameters; + + + + + + Shows default quotas for a specified tenant. + + + + + + + &getQuotaResponseParameters; + + + + + + Updates quotas for a specified tenant. + + If you specify the optional user_id query parameter, + you update the quotas for this user in the specified tenant. If you + omit this parameter, you update the quotas for the specified project. + + + + + + + + &updateQuotaRequestParameters; + + + + + + + + &QuotaResponseParameters; + + + + + + + Deletes quotas for a specified tenant. + The quota will revert back to default. + + + If you specify the optional user_id query parameter, + you delete the quotas for this user in the specified tenant. If you + omit this parameter, you delete the quotas for the specified project. + + + + + + + Shows the quotas for a specified quota class. + + + + + + + &getQuotaClassQuotasResponseParameters; + + + + + + Updates the quotas for a specified for a quota class. + + + + + + + &updateQuotaClassQuotasRequestParameters; + + + + + + + + &QuotaResponseParameters; + + + diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-availability-zones-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-availability-zones-list-response.json new file mode 100644 index 000000000..7fba3291e --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-availability-zones-list-response.json @@ -0,0 +1,10 @@ +{ + "availability_zones": [ + { + "name": "nova", + "created_at": "2015-09-18T09:50:55.000000", + "updated_at": null, + "id": "388c983d-258e-4a0e-b1ba-10da37d766db" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-show-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-show-response.json new file mode 100644 index 000000000..6c786a573 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-show-response.json @@ -0,0 +1,10 @@ +{ + "quota_class_set": { + "gigabytes": 1000, + "shares": 50, + "snapshot_gigabytes": 1000, + "snapshots": 50, + "id": "abc", + "share_networks": 10 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-update-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-update-request.json new file mode 100644 index 000000000..28abe67f2 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-update-request.json @@ -0,0 +1,6 @@ +{ + "quota_class_set": { + "class_name": "abc", + "shares": 49 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-update-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-update-response.json new file mode 100644 index 000000000..c421ba612 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-class-quota-update-response.json @@ -0,0 +1,9 @@ +{ + "quota_class_set": { + "gigabytes": 1000, + "snapshot_gigabytes": 1000, + "snapshots": 50, + "shares": 49, + "share_networks": 10 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-show-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-show-response.json new file mode 100644 index 000000000..7f9f7bae3 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-show-response.json @@ -0,0 +1,10 @@ +{ + "quota_set": { + "gigabytes": 1000, + "shares": 50, + "snapshot_gigabytes": 1000, + "snapshots": 50, + "id": "16e1ab15c35a457e9c2b2aa189f544e1", + "share_networks": 10 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-update-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-update-request.json new file mode 100644 index 000000000..d557badb3 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-update-request.json @@ -0,0 +1,8 @@ +{ + "quota_set": { + "tenant_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "snapshot_gigabytes": 999, + "snapshots": 49, + "share_networks": 9 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-update-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-update-response.json new file mode 100644 index 000000000..bec39dfb6 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-quota-update-response.json @@ -0,0 +1,9 @@ +{ + "quota_set": { + "gigabytes": 1000, + "snapshot_gigabytes": 999, + "shares": 50, + "snapshots": 49, + "share_networks": 9 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-services-disable-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-disable-request.json new file mode 100644 index 000000000..2ef5907a7 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-disable-request.json @@ -0,0 +1,4 @@ +{ + "binary": "manila-share", + "host": "openstack@cmode" +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-services-disable-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-disable-response.json new file mode 100644 index 000000000..f2e2bd101 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-disable-response.json @@ -0,0 +1,5 @@ +{ + "disabled": true, + "binary": "manila-share", + "host": "openstack@cmode" +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-services-enable-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-enable-request.json new file mode 100644 index 000000000..2ef5907a7 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-enable-request.json @@ -0,0 +1,4 @@ +{ + "binary": "manila-share", + "host": "openstack@cmode" +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-services-enable-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-enable-response.json new file mode 100644 index 000000000..3d24a29f5 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-enable-response.json @@ -0,0 +1,5 @@ +{ + "disabled": false, + "binary": "manila-share", + "host": "openstack@cmode" +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-allow-access-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-grant-access-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-allow-access-request.json rename to api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-grant-access-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-allow-access-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-grant-access-response.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-allow-access-response.json rename to api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-grant-access-response.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-deny-access-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-revoke-access-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-deny-access-request.json rename to api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-revoke-access-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-manage-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-manage-request.json new file mode 100644 index 000000000..962c7e581 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-manage-request.json @@ -0,0 +1,14 @@ +{ + "share": { + "protocol": "nfs", + "name": "share_texas1", + "share_type": "d", + "driver_options": { + "opt1": "opt1", + "opt2": "opt2" + }, + "export_path": "10.254.0.5:/shares/share-42033c24-0261-424f-abda-4fef2f6dbfd5", + "service_host": "manila2@unmanage1#UNMANAGE1", + "description": "Lets manage share." + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-manage-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-manage-response.json new file mode 100644 index 000000000..c2718e705 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-manage-response.json @@ -0,0 +1,37 @@ +{ + "share": { + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/00137b40-ca06-4ae8-83a3-2c5989eebcce", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/00137b40-ca06-4ae8-83a3-2c5989eebcce", + "rel": "bookmark" + } + ], + "availability_zone": null, + "share_network_id": null, + "export_locations": [], + "share_server_id": null, + "snapshot_id": null, + "id": "00137b40-ca06-4ae8-83a3-2c5989eebcce", + "size": null, + "share_type": "14747856-08e5-494f-ab40-a64b9d20d8f7", + "share_type_name": "d", + "export_location": "10.254.0.5:/shares/share-42033c24-0261-424f-abda-4fef2f6dbfd5", + "consistency_group_id": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "metadata": {}, + "status": "manage_starting", + "description": "Lets manage share.", + "host": "manila2@unmanage1#UNMANAGE1", + "is_public": false, + "snapshot_support": true, + "name": "share_texas1", + "created_at": "2015-09-17T16:21:12.000000", + "share_proto": "NFS", + "volume_type": "d", + "source_cgsnapshot_member_id": null + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-add-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-grant-access-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-add-request.json rename to api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-grant-access-request.json diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-remove-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-revoke-access-request.json similarity index 100% rename from api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-remove-request.json rename to api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-revoke-access-request.json