diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml index 18853b3b3..8a25a2445 100644 --- a/api-ref-guides/pom.xml +++ b/api-ref-guides/pom.xml @@ -204,6 +204,28 @@ api-ref-orchestration-v1 + + os-api-ref-share-v2 + + generate-pdf + + generate-sources + + bk-api-ref-share-v2.xml + api-ref-share-v2 + + + + os-api-ref-share-v1 + + generate-pdf + + generate-sources + + bk-api-ref-share-v1.xml + api-ref-share-v1 + + os-api-ref-telemetry-v2 diff --git a/api-ref-guides/src/bk-api-ref-share-v1.xml b/api-ref-guides/src/bk-api-ref-share-v1.xml new file mode 100644 index 000000000..d004e4118 --- /dev/null +++ b/api-ref-guides/src/bk-api-ref-share-v1.xml @@ -0,0 +1,36 @@ + + + + OpenStack Shared File Systems API v1 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2015 + OpenStack Foundation + + OpenStack Shared File Systems + + + + Copyright details are filled in by the + template. + + + + + diff --git a/api-ref-guides/src/bk-api-ref-share-v2.xml b/api-ref-guides/src/bk-api-ref-share-v2.xml new file mode 100644 index 000000000..6bf1b8464 --- /dev/null +++ b/api-ref-guides/src/bk-api-ref-share-v2.xml @@ -0,0 +1,36 @@ + + + + OpenStack Shared File Systems API v2 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2015 + OpenStack Foundation + + OpenStack Shared File Systems + + + + Copyright details are filled in by the + template. + + + + + diff --git a/api-ref-guides/src/bk-api-ref.xml b/api-ref-guides/src/bk-api-ref.xml index 428fa8135..95cf5e4b6 100644 --- a/api-ref-guides/src/bk-api-ref.xml +++ b/api-ref-guides/src/bk-api-ref.xml @@ -51,5 +51,7 @@ + + diff --git a/api-ref/pom.xml b/api-ref/pom.xml index 6bb387434..7356b28f4 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -245,6 +245,28 @@ bk-api-ref-orchestration-v1 + + os-api-ref-share-v2 + + generate-html + + generate-sources + + api-ref-share-v2.xml + bk-api-ref-share-v2 + + + + os-api-ref-share-v1 + + generate-html + + generate-sources + + api-ref-share-v1.xml + bk-api-ref-share-v1 + + os-api-ref-telemetry-v2 diff --git a/api-ref/src/docbkx/api-ref-share-v1.xml b/api-ref/src/docbkx/api-ref-share-v1.xml new file mode 100644 index 000000000..d71ae0a74 --- /dev/null +++ b/api-ref/src/docbkx/api-ref-share-v1.xml @@ -0,0 +1,23 @@ + + + + OpenStack Shared File Systems API v1 (CURRENT) + + 2015 + + + + + + + + + + diff --git a/api-ref/src/docbkx/api-ref-share-v2.xml b/api-ref/src/docbkx/api-ref-share-v2.xml new file mode 100644 index 000000000..2b1165d39 --- /dev/null +++ b/api-ref/src/docbkx/api-ref-share-v2.xml @@ -0,0 +1,23 @@ + + + + OpenStack Shared File Systems API v2.0 (CURRENT) + + 2015 + + + + + + + + + + diff --git a/api-ref/src/docbkx/ch_share-v1.xml b/api-ref/src/docbkx/ch_share-v1.xml new file mode 100644 index 000000000..c60cc44cd --- /dev/null +++ b/api-ref/src/docbkx/ch_share-v1.xml @@ -0,0 +1,27 @@ + + + %common_project; + ]> + + Shared File Systems API v1 (SUPPORTED) + + Provides coordinated access to shared or distributed file systems. + + + The Shared File Systems API v1 is functionally identical to the Shared File + Systems API v2.0. Subsequent API v2 micro-versions, such as v2.1, + differ from API v1.0. + + + Starting with the API v2.0, the API uses Compute-style micro-versions. + + diff --git a/api-ref/src/docbkx/ch_share-v2.xml b/api-ref/src/docbkx/ch_share-v2.xml new file mode 100644 index 000000000..7c86989cf --- /dev/null +++ b/api-ref/src/docbkx/ch_share-v2.xml @@ -0,0 +1,874 @@ + + + %common_project; + ]> + + Shared File Systems API v2 (CURRENT) + + Provides coordinated access to shared or distributed file systems. + + + The Shared File Systems API uses Compute-style micro-versions. Use the + HTTP X-Openstack-Manila-Api-Version request header to specify a + valid micro-version. For example, "X-Openstack-Manila-Api-Version: + 2.6". If you omit this header, the default micro-version is 2.0. + + + Other than the switch to the micro-versions approach, the Shared File + Systems API v2.0 is functionally identical to the Shared File + Systems API v1.0. + + + Subsequent API v2 micro-versions, such as v2.1, differ from API v1.0. + Look for notes that identify in which post-v2 micro-version a feature, + method, or parameter was introduced. + +
+ API versions + + Lists information for all Shared File Systems API versions. + + + + + + +
+
+ API extensions + + Lists available Shared File Systems API extensions. + + + + + + +
+
+ Limits + + Limits are the resource limitations that are allowed for each + tenant (project). An administrator can configure limits in + the manila.conf file. + + + Users can query their rate and absolute limits. The absolute + limits contain information about: + + + + Total maximum share memory, in GBs. + + + Number of share-networks. + + + Number of share-snapshots. + + + Number of shares. + + + Shares and total used memory, in GBs. + + + Snapshots and total used memory, in GBs. + + + + Rate limits control the frequency at which users can issue + specific API requests. Administrators use rate limiting to + configure limits on the type and number of API calls that can be + made in a specific time interval. For example, a rate limit can + control the number of &GET; requests that can be processed during + a one-minute period. + + + + + + +
+
+ Shares + + A share is a remote, mountable file system. You can mount a share + to and access a share from several hosts by several users at a + time. + + + You can create a share and associate it with a network, list shares, + and show information for, update, and delete a specified share. + + + To create a share, specify one of these supported protocols: + + + + + NFS. Network File System (NFS). + + + + + CIFS. Common Internet File System (CIFS). + + + + + GLUSTERFS. Gluster file system (GlusterFS). + + + + + HDFS. Hadoop Distributed File System (HDFS). + + + + + You can also create snapshots of shares. To create a snapshot, you + specify the ID of the share that you want to snapshot. + + + A share has one of these status values: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Share statuses
StatusDescription
+ creating + + The share is being created. +
+ deleting + + The share is being deleted. +
+ error + + An error occurred during share + creation. + +
+ error_deleting + + An error occurred during share + deletion. + +
+ available + + The share is ready to use. +
+ manage_starting + + Share manage started. +
+ manage_error + + Share manage failed. +
+ unmanage_starting + + Share unmanage started. +
+ unmanage_error + + Share cannot be unmanaged. +
+ unmanaged + + Share was unmanaged. +
+ extending + + + The extend, or increase, share size request was + issued successfully. + +
+ extending_error + + Extend share failed. +
+ shrinking + + Share is being shrunk. +
+ shrinking_error + + Failed to update quota on share shrinking. +
+ shrinking_possible_data_loss_error + + Shrink share failed due to possible data loss. +
+ + + + + + + + + + + + + + + +
+
+ Share metadata + + Shows, sets, updates, and unsets share metadata. + + + + + + + + + + + +
+
+ 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. + + + To grant or deny access to a share, specify one of these supported + share access levels: + + + + + rw. Read and write (RW) access. + + + + + ro. Read-only (RO) access. + + + + + You must also specify one of these supported authentication + methods: + + + + + ip. Authenticates an instance through its IP + address. A valid format is XX.XX.XX.XX or + XX.XX.XX.XX/XX. For example 0.0.0.0/0. + + + + + cert. Authenticates an instance through a TLS + certificate. Specify the TLS identity as the IDENTKEY. A + valid value is any string up to 64 characters long in the + common name (CN) of the certificate. The meaning of a + string depends on its interpretation. + + + + + user. Authenticates by a specified user or + group name. A valid value is an alphanumeric string that + can contain some special characters and is from 4 to 32 + characters long. + + + + + To verify that the access rules (ACL) were configured correctly + for a share, you list permissions for a share. + + + As administrator, you can reset the state of a share and + force-delete a specified share in any state. Use the + policy.json file to grant permissions for this + action to other roles. + + + You can set the state of a share to one of these supported states: + + + + available + + + error + + + creating + + + deleting + + + error_deleting + + + + + + + + + + + + + + +
+
+ Share snapshots + + Use the shared file service to make snapshots of shares. A share + snapshot is a point-in-time, read-only copy of the data that is + contained in a share. You can create, update, and delete share + snapshots. After you create a share snapshot, you can create a + share from it. + + + You can update a share snapshot to rename it, change its + description, or update its state to one of these supported states: + + + + available + + + error + + + creating + + + deleting + + + error_deleting + + + + As administrator, you can also reset the state of a snapshot and + force-delete a specified share snapshot in any state. + Use the policy.json file to grant permissions for + these actions to other roles. + + + + + + + + + + + + + + + + + + + +
+
+ Share networks + + A share network stores network information that share servers can + use where shares are hosted. You can associate a share with a + single share network. When you create a share, you can + optionally specify the ID of a share network through which + instances can access the share. + + + You can create, update, view, and delete a share network. + + + When you create a share network, you can specify only one type of network: + + + + Neutron network. Specify a network ID and subnet ID. + + + + Nova network. Specify a network ID. + + + + + For more information about supported plug-ins for share networks, see Manila + Network Plugins. + + + A share network has these attributes: + + + + + The IP block in Classless Inter-Domain Routing (CIDR) + notation from which to allocate the network. + + + + + The IP version of the network. + + + + + The network type, which is vlan, + vxlan, gre, + flat, or local. + + + + + If the network uses segmentation, a segmentation + identifier. For example, VLAN, VXLAN, and GRE networks use + segmentation. + + + + + + + + + + + + + + + + + + + + + +
+
+ Security services + + You can create, update, view, and delete a security service. A + security service stores configuration information for clients for + authentication and authorization (AuthN/AuthZ). For example, a + share server will be the client for an existing service such as + LDAP, Kerberos, or Microsoft Active Directory. + + + You can associate a share with from one to three security service + types: + + + + ldap. LDAP. + + + + + kerberos. Kerberos. + + + + + active_directory. Microsoft Active Directory. + + + + + You can configure a security service with these options: + + + + A DNS IP address. + + + An IP address or host name. + + + A domain. + + + A user or group name. + + + + The password for the user, if you specify a user name. + + + + + + + + + + + + + + + + +
+
+ Share servers + + A share server is created by multi-tenant back-end drivers where + shares are hosted. For example, with the generic + driver, shares are hosted on Compute VMs. With the + cluster_mode driver from NetApp, shares are hosted on + virtual storage servers, also known as Vservers or SVMs. + + + Administrators can perform read and delete actions for share + servers. An administrator can delete an active share server only + if it contains no dependent shares. + + + An administrator can use the policy.json file to + grant permissions for share server actions to other roles. + + + The status of a share server indicates its current state. After + you successfully set up a share server, its status is + active. If errors occur during set up such as when + server data is not valid, its status is error. + + + The possible share servers statuses are: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Share statuses
StatusDescription
+ active + + Share server was successfully set up. +
+ error + + The set up or deletion of the share server failed. + +
+ deleting + + The share server has no dependent shares and is being + deleted. +
+ creating + + The share server is being created on the back end with data + from the database. + +
+ + + + + + + + + + + + +
+
+ Share instances (since API v2.3) + + Administrators can list, show information for, explicitly + set the state of, and force-delete share instances. Use the + policy.json file to grant permissions for these + actions to other roles. + + + + + + + + + + + + + +
+
+ Share types + + A share type enables you to filter or choose back ends before you + create a share. A share type behaves in the same way as a Block + Storage volume type behaves. + + + You set a share type to private or public and manage the access to + the private share types. + + + When you issue a create a share type request, you can submit a + request body with either a share_type or + volume_type object. The use of the + volume_type object is deprecated but supported. It is + recommended that you use the share_type object when + you create a share type. + + + No matter which object type you include in the request, the API + creates both a volume_type object and a + share_type object. Both objects have the same ID. + When you issue a list share types request, the response shows both + share_types and volume_types objects. + + You can set share types as either public or private. By default + a share type is created as publicly accessible. Set + os-share-type-access:is_public to False + to make the share type private. + + + You can manage the access to the private share types for the + different projects. You can add access, remove access, and get + information about access for a specified private share type. + + + Administrators can create share types with these extra + specifications that are used to filter back ends: + + + + + driver_handles_share_servers. Required. + Defines the driver mode for share server, or storage, life cycle management. The + Shared File Systems service creates a share server for the export of shares. + + + Set to True when the share driver manages, or handles, + the share server life cycle. + + + Set to False when an administrator rather than a + share driver manages the storage life cycle. + + + + + snapshot_support. Filters back ends by + whether they do or do not support share snapshots. + + + Set to True to find back ends that support share snapshots. + + + Set to False to find back ends that do not support share + snapshots. + + + + + Administrators can also set additional extra specifications for a + share type for the following purposes: + + + + + Filter back ends. Specify these unqualified extra + specifications in this format: + extra_spec=value. For example, + netapp_raid_type=raid4. + + + + + Set data for the driver. Except for the special + capabilities prefix, you specify these + qualified extra specifications with its prefix followed by + a colon: vendor:extra_spec=value. For + example, netapp:thin_provisioned=true. + + + + + 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 + for the share type. For details, see Capabilities and Extra-Specs. + + + Each driver implementation determines which extra specification + keys it uses. For details, see the documentation for the driver. + + + An administrator can use the policy.json file to + grant permissions for share type creation with extra + specifications to other roles. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Back-end storage pools + + An administrator can list all back-end storage pools that are + known to the scheduler service. + + + + + + + + + +
+ diff --git a/api-ref/src/docbkx/itemizedlist-service-list.xml b/api-ref/src/docbkx/itemizedlist-service-list.xml index 2227440d1..c28556386 100644 --- a/api-ref/src/docbkx/itemizedlist-service-list.xml +++ b/api-ref/src/docbkx/itemizedlist-service-list.xml @@ -92,6 +92,14 @@ Orchestration API v1 (CURRENT) + + Shared File Systems API v2 (CURRENT) + + + Shared File Systems API v1 (SUPPORTED) + Telemetry API v2 (CURRENT) diff --git a/api-ref/src/wadls/share-api/src/v2/common.ent b/api-ref/src/wadls/share-api/src/v2/common.ent new file mode 100644 index 000000000..55a649b46 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/common.ent @@ -0,0 +1,3911 @@ + + + + + +'> + + +'> + + + + The name of the extension. For example, "Fox In Socks." + + + + + + + The extension description. + + + + + + + The alias for the extension. For example, "FOXNSOX," + "os-availability-zone," "os-extended-quotas," "os-share-unmanage," + or "os-used-limits." + + + + + + + The date and time stamp when the extension was last updated. For example, + "2011-01-22T13:25:27-06:00." + + +'> + + + + The total maximum number of share gigabytes that are allowed in a + project. You cannot request a share that exceeds the allowed gigabytes + quota. + + + + + + + The total maximum number of snapshot gigabytes that are allowed in a + project. + + + + + + + The total maximum number of shares that are allowed in a project. + + + + + + + The total maximum number of share snapshots that are allowed in a project. + + + + + + + The total maximum number of share-networks that are allowed in a project. + + + + + + + The total number of created shares in a project. + + + + + + + The total number of created share snapshots in a project. + + + + + + + The total number of created share-networks in a project. + + + + + + + The total number of gigabytes used in a project by shares. + + + + + + + The total number of gigabytes used in a project by snapshots. + + + + + + + A human-readable URI of a rate limit. + + + + + + + An API regular expression. For example, ^/shares for the + /shares API URI or .* for any URI. + + + + + + + The number of API requests that are allowed during a specified time + interval. Used in conjunction with the unit parameter, + expressed as value per unit. For example, 120 + requests are allowed per minute. + + + + + + + The HTTP method for the API request. For example, GET, + POST, DELETE, and so on. + + + + + + + The remaining number of allowed requests. + + + + + + + The time interval during which a specified number of API requests are + allowed. A valid value is SECOND, MINUTE, + HOUR, or DAY. Used in conjunction with the + value parameter, expressed as value per + unit. For example, 120 requests are allowed per minute. + + + + + + + The date and time stamp when next issues are available. For example, + 2015-11-01T00:00:00Z. + + +'> + + + + The ID of the snapshot from which to create the share. + + + +&isPublicParameter; +&shareMetadataResponseParameter; + + + + The ID of a share network where the share server exists or will be + created. If share_network_id is None and you + provide a snapshot_id, the share_network_id + value from the specified snapshot is used. + + + + + + + (Since API v2.4.) The ID of the available consistency group in + which the share will be created. + + + The specified consistency group must support the specified + share_type and share_network_id. For details, + see Consistency groups. + + + +&availabilityZoneParameter;'> + + + + The share ID. + + + + + + + The share status. A valid value is: + + + + + creating. The share is being created. + + + + + deleting. The share is being deleted. + + + + + error. An error occurred during share + creation. + + + + + error_deleting. An error occurred during share + deletion. + + + + + available. The share is ready to use. + + + + + manage_starting. Share manage started. + + + + + manage_error. Share manage failed. + + + + + unmanage_starting. Share unmanage started. + + + + + unmanage_error. Share cannot be unmanaged. + + + + + unmanaged. Share was unmanaged. + + + + + extending. The extend, or increase, share size + request was issued successfully. + + + + + extending_error. Extend share failed. + + + + + shrinking. Share is being shrunk. + + + + + shrinking_error. Failed to update quota on share shrinking. + + + + + shrinking_possible_data_loss_error. Shrink share + failed due to possible data loss. + + + + + + + + + The ID of the project in which the share was created. + + + +&fileSystemProtocolParameter; + + + + The share size, in GBs. + + + +&shareNameParameter; +&shareDescriptionParameter; +&shareDisplayNameParameter; +&shareDisplayDescriptionParameter; + + + + (Since API v2.6.) The share type ID. + + + + + + + (Since API v2.6.) The share type name. + + + Minor versions support only the share_type parameter + where the share type name is expected. + + + +&volumeTypeParameter; + + + + The ID of the snapshot from which to create the share. + + + +&isPublicParameter; +&shareMetadataResponseParameter; + + + + The share network ID. + + + +&availabilityZoneRequiredParameter; + + + + The export location. + + + + + + + A list of export locations. For example, when a share server has more + than one network interface, it can have multiple export locations. + + + + + + + The share host name. + + + +&taskStateParameter; +&shareServerIdParameter; +&consistencyGroupIdParameter; +&snapshotSupportParameter; +&sourceCgsnapshotMemberIdParameter; + + + + The date and time stamp when the share was created. + + +'> + + + + (Admin only). Defines whether to list shares for all tenants. + Set to 1 to list shares for all tenants. Set to + 0 to list shares only for the current tenant. + + + + + + + The share name. + + + + + + + Filters by a specified share status. A valid value is + creating, error, available, + deleting, error_deleting, + manage_starting, manage_error, + unmanage_starting, unmanage_error, + unmanaged, extending, + extending_error, shrinking, + shrinking_error, or + shrinking_possible_data_loss_error. + + + + + + + The ID of the share server. + + + + + + + One or more metadata key-value pairs, as a dictionary of strings. + + + + + + + The extra specifications specified as a set of one or more key-value + pairs. In each pair, the key is the name of the extra specification + and the value is the share type that was used to create the share. + + + + + + + (Since API v2.6.) The ID of the share type. + + + + + + + The maximum number of shares to return. + + + + + + + The offset to define start point of share listing. + + + + + + + The key to sort a list of shares. A valid value is id, + status, size, host, + share_proto, export_location, + availability_zone, user_id, + project_id, created_at, + updated_at, display_name, + name, share_type_id, share_type, + share_network_id, share_network, + snapshot_id, or snapshot. + + + + + + + The direction to sort a list of shares. A valid value + is asc, or desc. + + + + + + + The snapshot ID, that was used for the share. + + + + + + + The share host name. + + + + + + + The share network ID. + + + + + + + The ID of the project in which the share was created. + Useful with all_tenants parameter. + + + + + + + The level of visibility for the share. Set to true + to list only public shares. Set to false to list only + private shares. + + + + + + + (Since API v2.4.) The ID of a consistency group in which the share was + created. + + +'> + + + + The share ID. + + + +&shareNameParameter;'> + + + + The share ID. + + + + + + + The share status, which is creating, + error, available, deleting, + error_deleting, manage_starting, + manage_error, unmanage_starting, + unmanage_error, unmanaged, + extending, extending_error, + shrinking, shrinking_error, or + shrinking_possible_data_loss_error. + + + + + + + The share size, in GBs. + + + + + + + The ID of the project in which the share was created. + + + +&shareNameParameter; +&shareDescriptionParameter; + + + + (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. + + + +&availabilityZoneRequiredParameter; + + + + The date and time stamp when the share was created. + + + + + + + The export location. + + + + + + + A list of export locations. For example, when a share server has more + than one network interface, it can have multiple export locations. + + + + + + + The share network ID. + + + +&fileSystemProtocolParameter; + + + + The share host name. + + + +&volumeTypeParameter; + + + + The snapshot ID. + + + +&taskStateParameter; +&shareServerIdParameter; +&consistencyGroupIdParameter; +&snapshotSupportParameter; +&sourceCgsnapshotMemberIdParameter; +&isPublicParameter; +&shareMetadataResponseParameter;'> + + + + The share name. If you specify this parameter, the share name is + updated. + + + + + + + The share description. If you specify this parameter, the share + description is updated. + + + +&isPublicParameter;'> + + + + (Since API v2.4.) The ID of a consistency group in which the share + was created. You can omit this parameter if the share was created without + a consistency group. + + +'> + + + + One or more metadata key-value pairs, as a dictionary of strings. + + +'> + + + + One or more metadata key-value pairs, as a dictionary of strings. For + example, "project": "my_test", "aim": "testing". The share + server does not respect case-sensitive key names. For example, + "key": "v1" and "KEY": "V1" are equivalent. If + you specify both key-value pairs, the server sets and returns only the + "KEY": "V1" key-value pair. + + +'> + + + + The access level to the share. + + + To grant or deny access to a share, you specify one of the following + share access levels: + + + + + rw. Read and write (RW) access. + + + + + ro. Read-only (RO) access. + + + + + + + + + The access rule type. + + + A valid value for the share access rule type is one of the following + values: + + + + + ip. Authenticates an instance through its IP + address. A valid format is XX.XX.XX.XX or + XX.XX.XX.XX/XX. For example 0.0.0.0/0. + + + + + cert. Authenticates an instance through a TLS + certificate. Specify the TLS identity as the IDENTKEY. A valid value is any + string up to 64 characters long in the common name (CN) of the certificate. + The meaning of a string depends on its interpretation. + + + + + user. Authenticates by a specified user or + group name. A valid value is an alphanumeric string that can contain + some special characters and is from 4 to 32 characters long. + + + + + + + + + The value that defines the access. The back end grants or denies the + access to it. + + + A valid value is one of these values: + + + + + ip. Authenticates an instance through its IP address. + A valid format is XX.XX.XX.XX or XX.XX.XX.XX/XX. For + example 0.0.0.0/0. + + + + + cert. Authenticates an instance through a TLS + certificate. Specify the TLS identity as the IDENTKEY. A valid value is any + string up to 64 characters long in the common name (CN) of the certificate. + The meaning of a string depends on its interpretation. + + + + + user. Authenticates by a specified user or + group name. A valid value is an alphanumeric string that can contain + some special characters and is from 4 to 32 characters long. + + + + +'> + + + + The access rule ID. + + + + + + + The ID of the share to which you are granted or denied access. + + + + + + + The date and time stamp when the access rule was created. + + + + + + + The date and time stamp when the access rule was updated. + + + If the access rule was never updated, this value is null. + + + + + + + The rule access type. + + + + + + + The access that the back end grants or denies. + + + A valid value for the share access rule type is one of these values: + + + + + ip. Authenticates an instance through its IP address. + A valid format is XX.XX.XX.XX or XX.XX.XX.XX/XX. For + example 0.0.0.0/0. + + + + + cert. Authenticates an instance through a TLS + certificate. Specify the TLS identity as the IDENTKEY. A valid value is any + string up to 64 characters long in the common name (CN) of the certificate. + The meaning of a string depends on its interpretation. + + + + + user. Authenticates by a specified user or + group name. A valid value is an alphanumeric string that can contain + some special characters and is from 4 to 32 characters long. + + + + + + + + + The share access level. + + +'> + + + + The ID of the access rule to which access is granted. + + +'> + + + + The object of the access rule. To list access rules, set this value to + null. + + +'> + + + + The share access level. A valid value is either: + + + + + rw. Read and write (RW) access. + + + + + ro. Read-only (RO) access. + + + + + + + + + The access rule state. A valid value is active or + error. + + + + + + + The access rule ID. + + + + + + + The access type of an access rule. + + + + + + + The access that the back end grants or denies. + + + A valid value for the share access rule type is one of these values: + + + + + ip. Authenticates an instance through its IP address. + A valid format is XX.XX.XX.XX or XX.XX.XX.XX/XX. For + example 0.0.0.0/0. + + + + + cert. Authenticates an instance through a TLS + certificate. Specify the TLS identity as the IDENTKEY. A valid value is any + string up to 64 characters long in the common name (CN) of the certificate. + The meaning of a string depends on its interpretation. + + + + + user. Authenticates by a specified user or + group name. A valid value is an alphanumeric string that can contain + some special characters and is from 4 to 32 characters long. + + + + +'> + + + + The share status, which is creating, error, + available, deleting, or + error_deleting. + + +'> + + + + To force-delete a share, set this value to null. + The force-delete action, unlike the delete action, ignores the share status. + + +'> + + + + The ID of the share from which to create a snapshot. + + + + + + + Indicates whether snapshot creation is enabled when a share is busy. + + + Set to true to force snapshot creation when the share is busy. + + + Set to false to deny snapshot creation when + the share is busy. Default is false. + + + + + + + The snapshot name. + + + + + + + The snapshot name. + + + The Shared File Systems API supports the use of both name and + display_name attributes, which are inherited attributes + from the Block Storage API. + + + + + + + The snapshot description. + + + +&shareDisplayDescriptionParameter;'> + + + + The snapshot ID. + + + + + + + The ID of the source share that was used for a snapshot. + + + + + + + The snapshot status, which is available, + error, creating, deleting, or + error_deleting. + + + + + + + The snapshot name. + + + + + + + The snapshot description. + + + + + + + The date and time stamp when the snapshot was created. + + + + + + + The file system protocol of a share snapshot. A valid value is + NFS, CIFS, GlusterFS, or + HDFS. + + + + + + + The share snapshot size, in GBs. + + + + + + + The snapshot size, in GBs. + + +'> + + + + The snapshot ID. + + + + + + + The snapshot name. + + +'> + + + + The snapshot ID. + + + + + + + The snapshot status, which is available, + error, creating, deleting, or + error_deleting. + + + + + + + The ID of the source share that was used for a snapshot. + + + + + + + The snapshot name. + + + + + + + The snapshot description. + + + + + + + The date and time stamp when the snapshot was created. + + + + + + + The file system protocol of a share snapshot. A valid value is + NFS, CIFS, GlusterFS, or + HDFS. + + + + + + + The size of a source share, in GBs. + + + + + + + The snapshot size, in GBs. + + +'> + + + + The snapshot name. If you specify this attribute, + the snapshot name is updated. + + + + + + + The snapshot description. If you specify this attribute, + the snapshot description is updated. + + +'> + + + + The snapshot status, which is available, + error, creating, deleting, or + error_deleting. + + +'> + + + + To force-delete a snapshot, set this value to null. The + force-delete action, unlike the delete action, ignores the snapshot status. + + +'> + + + + The ID of the neutron network to set up for share servers. You can set + up either a neutron network and subnet or a nova network. + + + + + + + The ID of the neutron subnet to set up for share servers. This subnet + must be part of the specified neutron network. You can set up either a + neutron network and subnet or a nova network. + + + + + + + The ID of the nova network to set up for share servers. You can set up + either a neutron network and subnet or a nova network. + + + + + + + The share network name. + + + + + + + The share network description. + + +'> + + + + The share network ID. + + + + + + + The ID of the project in which the share network was created. + + + + + + + The neutron network ID. + + + + + + + The neutron subnet ID. + + + + + + + The nova network ID. + + + + + + + The network type. A valid value is VLAN, + VXLAN, GRE, flat, or + local. This parameter is automatically set to a value + determined by the network provider. + + + + + + + The segmentation ID. This parameter is automatically set to a value + determined by the network provider. + + + For VLAN, this value is an integer from 1 to 4094. + + + For VXLAN, this value is an integer from 1 to 16777215. + + + For GRE, this value is an integer from 1 to 4294967295. + + + + + + + The IP block from which to allocate the network, in CIDR notation. For + example, 172.16.0.0/24 or 2001:DB8::/64. + This parameter is automatically set to a value determined by the network + provider. + + + + + + + The IP version of the network. A valid value is 4 or + 6. This parameter is automatically set to a value determined + by the network provider. + + + + + + + The share network name. + + + + + + + The share network description. + + + + + + + The date and time stamp when the share network was created. + + + + + + + The date and time stamp when the share network was updated. + + +'> + + + + The share network ID. + + + + + + + The share network name. + + +'> + + + + The share network ID. + + + + + + + The ID of the project in which the share network was created. + + + + + + + The neutron network ID. + + + + + + + The neutron subnet ID. + + + + + + + The nova network ID. + + + + + + + The network type. A valid value is VLAN, + VXLAN, GRE, flat, or + local. + + + + + + + The segmentation ID. + + + + + + + The CIDR. + + + + + + + The IP version of the network. A valid value is 4 or + 6. + + + + + + + The share network name. + + + + + + + The share network description. + + + + + + + The date and time stamp when the share network was created. + + + + + + + The date and time stamp when the share network was updated. + + +'> + + + + The share network name. + + + + + + + The share network description. + + +'> + + + + The ID of the security service to add to the specified + share network. For details, see the security service section. + + +'> + + + + The ID of the security service to remove from the specified + share network. For details, see the security service section. + + +'> + + + + The security service type. A valid value is + ldap, kerberos, or + active_directory. + + + + + + + The security service name. + + + + + + + The security service description. + + + + + + + The DNS IP address that is used inside the tenant network. + + + + + + + The security service user or group name that is used by the tenant. + + + + + + + The user password, if you specify a user. + + + + + + + The security service domain. + + + + + + + The security service host name or IP address. + + +'> + + + + The security service status. + + + + + + + The security service ID. + + + + + + The ID of the project in which the security service was created. + + + + + + + The security service type. A valid value is + ldap, kerberos, or + active_directory. + + + + + + + The security service name. + + + + + + + The security service description. + + + + + + + The DNS IP address that is used inside the tenant network. + + + + + + + The security service user or group name that is used by the tenant. + + + + + + + The user password, if you specify a user. + + + + + + + The security service domain. + + + + + + + The security service host name or IP address. + + + + + + + The date and time stamp when the security service was created. + + + + + + + The date and time stamp when the security service was updated. + + +'> + + + + The security service status. + + + + + + + The security service type. A valid value is + ldap, kerberos, or + active_directory. + + + + + + + The security service ID. + + + + + + + The security service name. + + +'> + + + + The security service status. + + + + + + + The security service ID. + + + + + + + The ID of the project in which the security service was created. + + + + + + + The security service type. A valid value is + ldap, kerberos, or + active_directory. + + + + + + + The security service name. + + + + + + + The security service description. + + + + + + + The DNS IP address that is used inside the tenant network. + + + + + + + The security service user or group name that is used by the tenant. + + + + + + + The user password, if you specify a user. + + + + + + + The security service domain. + + + + + + + The security service host name or IP address. + + + + + + + The date and time stamp when the security service was created. + + + + + + + The date and time stamp when the security service was updated. + + +'> + + + + The security service type. A valid value is + ldap, kerberos, or + active_directory. + + + + + + + The security service name. If you specify this value, the name is updated. + + + + + + + The security service description. If you specify this value, the + description is updated. + + + + + + + The DNS IP address that is used inside the tenant network. + + + + + + + The security service user or group name that is used by the tenant. + + + + + + + The user password, if you specify a user. + + + + + + + The security service domain. + + + + + + + The security service host name or IP address. + + +'> + + + + The share server ID. + + + + + + + The project ID. + + + + + + + The share server status, which is active, + error, creating , or deleting. + + + + + + + The ID of a share network that is associated with the share server. + + + + + + + The name of a share network that is associated with the share server. + + + + + + + The share server host name or IP address. + + + + + + + The date and time stamp when the share server was updated. + + +'> + + + + The share server ID. + + + + + + + The project ID. + + + + + + + The share server status, which is is active, + error, creating, or + deleting. + + + + + + + The back-end details for a server. Each back end can store any key-value + information that it requires. For example, the generic back-end driver + might store the router ID. + + + + + + + The ID of a share network that is associated with the share server. + + + + + + + The name of a share network that is associated with the share server. + + + + + + + The share server host name or IP address. + + + + + + + The date and time stamp when the share server was created. + + + + + + + The date and time stamp when the share server was updated. + + +'> + + + + The back-end details for a server. Each back end can store any key-value + information that it requires. For example, the generic back-end driver + might store the router ID. + + +'> + + + + The service ID. + + + + + + + The service status, which is enabled + or disabled. + + + + + + + The service binary. Default is the base name of the executable. + + + + + + + The availability zone. + + + + + + + The host name. + + + + + + + The current state of the service. A valid value is up or + down. + + + + + + + The date and time stamp when the service was updated. + + +'> + + + + Extra specifications for the share type. + + + + + + + An extra specification that defines the driver mode for share server, or + storage, life cycle management. The Shared File Systems service creates + a share server for the export of shares. + + + Set to true when the share driver manages, or + handles, the share server life cycle. + + + Set to false when an administrator rather than a + share driver manages the storage life cycle. + + + + + + + An extra specification that filters back ends by whether they do or do + not support share snapshots. + + + Set to true to show back ends that support share snapshots. + + + Set to false to show back ends that do not support share + snapshots. + + Default is true. + + + + + + + Indicates whether a share type is publicly accessible. Default is + true, or publicly accessible. + + + + + + + The share type name. + + +'> + + + + The share type ID. + + + + + + + The required extra specifications for the share type. + + + + + + + The extra specifications for the share type. + + + + + + + An extra specification that defines the driver mode for share server, or + storage, life cycle management. The Shared File Systems service creates + a share server for the export of shares. + + + This value is true when the share driver manages, or + handles, the share server life cycle. + + + This value is false when an administrator rather than a + share driver manages the storage life cycle. + + + + + + + An extra specification that filters back ends by whether they do or do + not support share snapshots. + + + + + + + Indicates whether a share type is publicly accessible. Default is + true, or publicly accessible. + + + + + + + The share type name. + + +'> + + + + The extra specifications for the share type. + + + + + + + An extra specification that defines the driver mode for share server, or + storage, life cycle management. The Shared File Systems service creates + a share server for the export of shares. + + + This value is true when the share driver manages, or + handles, the share server life cycle. + + + This value is false when an administrator rather than a + share driver manages the storage life cycle. + + + + + + + An extra specification that filters back ends by whether they do or do + not support share snapshots. + + +'> + + + + The ID of the project to which access to the share type will be granted. + + +'> + + + + The ID of the project for which access to the share type will be denied. + + +'> + + + + The ID of the share type to which you granted access. + + + + + + + The ID of the project for which access to the share type is granted. + + +'> + + + + Extra specifications for the share type. + + +'> + + + + The share name. + + +'> + + + + The share description. + + +'> + + + + The share name. + + + The Shared File Systems API supports the use of both name + and display_name attributes, which are inherited attributes + from the Block Storage API. + + +'> + + + + The share description. + + + The Shared File Systems API supports the use of both description + and display_description parameters, which are inherited attributes + from the Block Storage API. + + +'> + + + + The Shared File Systems protocol. A valid value is NFS, + CIFS, GlusterFS, or HDFS. + + +'> + + + + The share size, in GBs. The requested share size cannot be greater than + the allowed GB quota. To view the allowed quota, issue a get limits + request. + + +'> + + + + The share type name. If you omit this parameter, the default share type is + used. To view the default share type set by the administrator, issue a + list default share types request. You cannot specify both the + share_type and volume_type parameters. + + +'> + + + + The volume type. The use of the volume_type object is + deprecated but supported. It is recommended that you use the + share_type object when you create a share type. When you + issue a create a share type request, you can submit a request body with + either a share_type or volume_type object. No + matter which object type you include in the request, the API creates + both a volume_type object and a share_type + object. Both objects have the same ID. When you issue a list share types + request, the response shows both share_types and + volume_types objects. + + +'> + + + + (Since API v2.1.) The availability zone. + + +'> + + + + The availability zone. + + +'> + + + + The level of visibility for the share. Defines whether other tenants can or + cannot see the share. + + +'> + + + + The share instance status. A valid value is available, + error, creating, deleting, + and error_deleting. + + + + + + + The ID of the share from which the share instance was created. + + + +&availabilityZoneRequiredParameter; + + + + The date and time stamp when the share instance was created. + + + + + + + The share instance export location. + + + + + + + A list of share instance export locations. + + + + + + + The share network ID. + + + + + + + The ID of the share server. + + + + + + + The share instance host name. + + + + + + + The share instance ID. + + +'> + + + + The share instance status. A valid value is available, + error, creating, deleting, + and error_deleting. + + +'> + + + + To force-delete a share instance, set this value to null. + The force-delete action, unlike the delete action, ignores the share + instance status. + + +'> + + + + The ID of the share server. + + +'> + + + + (Since API v2.4.) The ID of a consistency group in which the share was created. + + +'> + + + + (Since API v2.2.) An extra specification that filters back ends by + whether they do or do not support share snapshots. + + +'> + + + + (Since API v2.4.) If the share was created with + consistency_group_id attribute, the snapshot member ID. + + + The corresponding consistency group must be created from a snapshot with + the current share as a member. + + + Consistency groups and snapshots are the part of the Shared File Systems + experimental API. For details, see + Consistency groups and Consistency + group snapshots. + + +'> + + + + (Since API v2.5.) For the share migration, the migration task state. + + + A valid value is null, migration_starting, + migration_error, migration_success, + migration_completing, or migrating. The + task_state is null unless the share is + migrated from one back-end to another. For details, + see os-migrate_share extension request. + + +'> + + + + The name of the back end. + + + + + + + The host name for the back end. + + + + + + + The pool name for the back end. + + + + + + + The name of the back end in this format: host@backend#POOL. + + + host. The host name for the back end. + POOL. The pool name for the back end. + backend. The name of the back end. + + +'> + + + + The capabilities for the storage back end. + + + + + + + The quality of service (QoS) support. + + + + + + + (Since API v2.4.) The consistency group support. + + + A valid value is: + + + + + pool or host. Consistency groups are + supported. Specifies the level of consistency groups support. + + + + + false. Consistency groups are not supported. + + + + + + + + + The date and time stamp when the API request was issued. + + + + + + + The name of the share back end. + + + + + + + The mapping between servers and pools. + + + + + + + An extra specification that defines the driver mode for share server, or + storage, life cycle management. The Shared File Systems service creates + a share server for the export of shares. + + + This value is true when the share driver manages, or + handles, the share server life cycle. + + + This value is false when an administrator rather than a + share driver manages the storage life cycle. + + + + + + + The driver version. + + + + + + + The total capacity for the back end, in GBs. + A valid value is a string, such as unknown, or an integer. + + + + + + + The amount of free capacity for the back end, in GBs. + A valid value is a string, such as unknown, or an integer. + + + + + + + The percentage of the total capacity that is reserved for the internal + use by the back end. + + + + + + + The pools for the back end. This value is either null or a string value + that indicates the capabilities for each pool. For example, pool_name, + total_capacity_gb, QoS_support, and so on. + + + + + + + The name of the vendor for the back end. + + + + + + + The specification that filters back ends by whether they do or do + not support share snapshots. + + + + + + + The storage protocol for the back end. For example, NFS_CIFS, + glusterfs, HDFS, and so on. + + +'> + + + + New size of the share, in GBs. + + +'> + + + + New size of the share, in GBs. + + +'> + + + + 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 value is false. + + +'> 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 new file mode 100644 index 000000000..94110c826 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/os-share-v2.wadl @@ -0,0 +1,1210 @@ + + + + %common; + + %common_project; +]> + + + + + + The HTTP header to specify a valid Shared File Systems API + micro-version. For example, + "X-Openstack-Manila-Api-Version: 2.6". + If you omit this header, the default micro-version is 2.0. + + + + + + + + + The tenant ID in a multi-tenancy cloud. + + + + + + + + + + + + + + + + + + + + + + + + + + The ID of an existing share. + + + + + + + + + + + + + + + + + + + + + + + The metadata key. + + + + + + + + + + + + + + + + + The ID of an existing snapshot. + + + + + + + + + + + + + + + + + + + + + The ID of an existing share network. + + + + + + + + + + + + + + + + + + + + + The ID of an existing security service. + + + + + + + + + + + + + The ID of an existing share server. + + + + + + + + + + + + + + + + + + The ID of an existing share type. + + + + + + + + + + The extra specification key. + + + + + + + + + + + + + + + + + + + + The ID of an existing share instance. + + + + + + + + + + + + + + + + Lists all Shared File Systems API versions. + + + + + + + + + + + + Creates a share. + + + + + + + &createShareRequestParameters; + + + + + + + + &createShareResponseParameters; + + + + + + Lists shares. + + + + &getSharesRequestParameters; + + + + + + + + &getSharesResponseParameters; + + + + + + Lists shares with details. + + + + &getSharesRequestParameters; + + + + + + + + &getSharesDetailsResponseParameters; + + + + + + Shows information about a specified share. + + + + + + + &getSharesDetailsResponseParameters; + + + + + + Updates a specified share. + You can update these attributes: + + + + display_name, which also changes the + name of the share. + + + + + display_description, which also changes the + description of the share. + + + + + is_public. Changes the level of visibility. + + + + If you try to update other attributes, they retain their + previous values. + + + + + + + &updateShareRequestParameters; + + + + + + + + &getSharesDetailsResponseParameters; + + + + + + Deletes a specified share. + + + + &deleteShareRequestParameter; + + + + + + + Shows the metadata for a specified share. + + + + + + + &shareMetadataResponseParameter; + + + + + + Updates the metadata for a specified share. + + + + + + + &shareMetadataRequestParameter; + + + + + + + + &shareMetadataResponseParameter; + + + + + + Sets the metadata on a specified share. + + + + + + + &shareMetadataRequestParameter; + + + + + + + + &shareMetadataResponseParameter; + + + + + + Unsets the metadata on a specified share. + To unset a metadata key value, specify only the key name in + the URI. + + + + + + Grants access to a specified share. + + + + + + + &allowAccessRequestParameters; + + + + + + + + &allowAccessResponseParameters; + + + + + + Denies access to a specified share. + + + + + + + &denyAccessRequestParameters; + + + + + + + Lists access rules for a specified share. + + + + + + + &listAccessRulesRequestParameters; + + + + + + + + &listAccessRulesResponseParameters; + + + + + + Administrator only. Explicitly updates the state of a specified share. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &resetShareStateRequestParameter; + + + + + + + Administrator only. Force-deletes a specified share in any state. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &force-deleteShareRequestParameter; + + + + + + + Increases the size of a specified share. + + + + + + + &extendShareRequestParameters; + + + + + + + Shrinks the size of a specified share. + + + + + + + &shrinkShareRequestParameters; + + + + + + + + Migrates a specified share from one back end to another. (Since API v2.5.) + + You can migrate a specified share from one back end to another but + both back ends must set the + driver_handles_share_servers parameter to + False. 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 manila.conf file. + + + + + + + + &migrateShareRequestParameters; + + + + + + + Creates a snapshot from a specified share. + + + + + + + &share-createSnapshotRequestParameters; + + + + + + + + &share-createSnapshotResponseParameters; + + + + + + Lists all share snapshots. + + + + + + + &share-getSnapshotsResponseParameters; + + + + + + Lists all share snapshots with details. + + + + + + + &share-getSnapshotResponseParameters; + + + + + + Shows information for a specified share snapshot. + + + + + + + &share-getSnapshotResponseParameters; + + + + + + Updates a specified share snapshot. + You can update these attributes: + + + + display_name, which also changes the + name + of the share snapshot. + + + + + display_description, which also changes the + description of the share snapshot. + + + + + is_public. Changes the level of visibility. + + + + If you try to update other attributes, they retain their + previous values. + + + + + + + &updateSnapshotRequestParameters; + + + + + + + + &share-getSnapshotResponseParameters; + + + + + + Deletes a specified share snapshot. + + + + + + Administrator only. Explicitly updates the state of a specified share snapshot. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &resetSnapshotStateRequestParameter; + + + + + + + Administrator only. Force-deletes a specified share snapshot in any state. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &forceshare-deleteSnapshotRequestParameter; + + + + + + + Creates a share network. + + + + + + + &createShareNetworkRequestParameters; + + + + + + + + &createShareNetworkResponseParameters; + + + + + + Lists all share networks. + + + + + + + &getShareNetworksResponseParameters; + + + + + + Lists all share networks with details. + + + + + + + &getShareNetworksDetailsResponseParameters; + + + + + + Shows information for a specified share network. + + + + + + + &getShareNetworksDetailsResponseParameters; + + + + + + Updates a specified share network. + + Note that if specified share network is used by any share server, + you can update only the name and + description attributes. + + + + + + + + &updateShareNetworkRequestParameters; + + + + + + + + &getShareNetworksDetailsResponseParameters; + + + + + + Deletes a specified share network. + + + + + + Add security service to a specified share network. + + + + + + + &addSecurityServiceRequestParameters; + + + + + + + + &getShareNetworksDetailsResponseParameters; + + + + + + Remove security service from a specified share network. + + + + + + + &removeSecurityServiceRequestParameters; + + + + + + + + &getShareNetworksDetailsResponseParameters; + + + + + + Creates a security service. + + + + + + + &createSecurityServiceRequestParameters; + + + + + + + + &createSecurityServiceResponseParameters; + + + + + + Lists all security services. + + + + + + + &getSecurityServicesResponseParameters; + + + + + + Lists all security services with details. + + + + + + + &getSecurityServicesDetailsResponseParameters; + + + + + + Shows information for a specified security service. + + + + + + + &getSecurityServicesDetailsResponseParameters; + + + + + + Updates a specified security service. + + If the security service is in active state, you + can update only the name and description + attributes. A security service in active state is + attached to a share network with an associated share server. + + + + + + + + &updateSecurityServiceRequestParameters; + + + + + + + + &getSecurityServicesDetailsResponseParameters; + + + + + + Deletes a specified security service. + + + + + + Lists all share servers. + + + + + + + &getShareServersResponseParameters; + + + + + + Shows information for a specified share server. + + + + + + + &getShareServerResponseParameters; + + + + + + Shows the details for a specified share server. + + + + + + + &getShareServerDetailsResponseParameters; + + + + + + Gets share limits. + + + + + + + &getLimitsResponseParameters; + + + + + + Lists extensions. + + + + + + + &getExtensionsResponseParameters; + + + + + + Creates a share type. + + + + + + + &share-createShareTypeRequestParameters; + + + + + + + + &share-createShareTypeResponseParameters; + + + + + + Lists all share types. + + + + + + + &share-createShareTypeResponseParameters; + + + + + + Lists default share types. + + + + + + + &share-createShareTypeResponseParameters; + + + + + + Deletes a specified share type. + + + + + + Sets an extra specification of the share type. + + It is up to each driver implementation what extra specification + keys to use. For details, see + Capabilities and Extra-Specs and documentation for a + specified driver. + + + + + + + + &setExtraSpecShareTypeRequestParameter; + + + + + + + + &setExtraSpecShareTypeRequestParameter; + + + + + + Lists the extra specifications for the specified share type. + + + + + + + &getExtraSpecsShareTypeResponseParameters; + + + + + + Unsets an extra specification of the share type. + + + + + + Adds share type access for a specified project. + You can add access to private share types only. + + + + + + + &addShareTypeAccessRequestParameter; + + + + + + + Removes share type access from a specified project. + You can remove access from private share types only. + + + + + + + &removeShareTypeAccessRequestParameter; + + + + + + + Shows access information for a specified share type. + You can view access information for private share types only. + + + + + + + &listShareTypeAccessResponseParameter; + + + + + + Lists all share instances. + + + + + + + &getShareInstancesResponseParameters; + + + + + + Shows information about a specified share instance. + + + + + + + &getShareInstancesResponseParameters; + + + + + + Administrator only. Explicitly updates the state of a specified share instance. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &resetShareInstanceStateRequestParameter; + + + + + + + Administrator only. Force-deletes a specified share instance. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &force-deleteShareInstanceRequestParameter; + + + + + + + Lists all back-end storage pools. + + + + + + + &getPoolsResponseParameters; + + + + + + Lists all storage pools for the specified back end, with details. + + + + + + + &getPoolsDetailsResponseParameters; + + + + 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/samples/manila-cg-snapshot-create-request.json new file mode 100644 index 000000000..699649c68 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-create-request.json @@ -0,0 +1,7 @@ +{ + "cgsnapshot": { + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "name": "snapshot_cg1", + "description": "Snapshot of cg1" + } +} 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/samples/manila-cg-snapshot-create-response.json new file mode 100644 index 000000000..b8550db2a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-create-response.json @@ -0,0 +1,21 @@ +{ + "cgsnapshot": { + "status": "creating", + "name": "snapshot_cg1", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "rel": "bookmark" + } + ], + "created_at": "2015-09-16T17:34:06.031997", + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "description": "Snapshot of cg1" + } +} 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/samples/manila-cg-snapshot-force-delete-request.json new file mode 100644 index 000000000..6bf59688a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-force-delete-request.json @@ -0,0 +1,3 @@ +{ + "os-force_delete": null +} 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/samples/manila-cg-snapshot-list-detailed-response.json new file mode 100644 index 000000000..8df69f883 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-detailed-response.json @@ -0,0 +1,42 @@ +{ + "cgsnapshots": [ + { + "status": "available", + "name": "snapshot_CG2", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "rel": "bookmark" + } + ], + "created_at": "2015-09-16T17:37:40.000000", + "consistency_group_id": "2d5c2600-ae67-4dff-b13c-a1c20b335e8e", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "description": "Snapshot of CG2" + }, + { + "status": "available", + "name": "snapshot_cg1", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "rel": "bookmark" + } + ], + "created_at": "2015-09-16T17:34:15.000000", + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "description": "Snapshot of cg1" + } + ] +} 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/samples/manila-cg-snapshot-list-members-response.json new file mode 100644 index 000000000..a4c1cd82e --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-members-response.json @@ -0,0 +1,24 @@ +{ + "cgsnapshot_members": [ + { + "share_type_id": "be27425c-f807-4500-a056-d00721db45cf", + "share_id": "609e4924-f062-45e0-928d-7b739348c4d6", + "created_at": "2015-09-16T17:34:15.000000", + "cgsnapshot_id": "b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "share_protocol": "NFS", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "84098fde-40ec-4c96-a908-bc532c52b3af", + "size": 1 + }, + { + "share_type_id": "be27425c-f807-4500-a056-d00721db45cf", + "share_id": "c4a2ced4-2c9f-4ae1-adaa-6171833e64df", + "created_at": "2015-09-16T17:34:15.000000", + "cgsnapshot_id": "b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "share_protocol": "NFS", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "db492d38-dd3a-4d6b-a3b6-e65377990892", + "size": 1 + } + ] +} 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/samples/manila-cg-snapshot-list-response.json new file mode 100644 index 000000000..8b55384ec --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-list-response.json @@ -0,0 +1,32 @@ +{ + "cgsnapshots": [ + { + "id": "7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "rel": "bookmark" + } + ], + "name": "snapshot_CG2" + }, + { + "id": "b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "rel": "bookmark" + } + ], + "name": "snapshot_cg1" + } + ] +} 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/samples/manila-cg-snapshot-reset-state-request.json new file mode 100644 index 000000000..965e9a4e5 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-reset-state-request.json @@ -0,0 +1,5 @@ +{ + "os-reset_status": { + "status": "error" + } +} 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/samples/manila-cg-snapshot-show-response.json new file mode 100644 index 000000000..f73a8caa2 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-show-response.json @@ -0,0 +1,21 @@ +{ + "cgsnapshot": { + "status": "available", + "name": "snapshot_cg1", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "rel": "bookmark" + } + ], + "created_at": "2015-09-16T17:34:15.000000", + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "b44c894d-4bec-47aa-b389-cc8c6f0044a5", + "description": "Snapshot of cg1" + } +} 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/samples/manila-cg-snapshot-update-request.json new file mode 100644 index 000000000..4dc647993 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-update-request.json @@ -0,0 +1,5 @@ +{ + "cgsnapshot": { + "description": "Changed description: there is a snapshot of CG2" + } +} 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/samples/manila-cg-snapshot-update-response.json new file mode 100644 index 000000000..853a7c417 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-cg-snapshot-update-response.json @@ -0,0 +1,21 @@ +{ + "cgsnapshot": { + "status": "available", + "name": "snapshot_CG2", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/cgsnapshot/7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "rel": "bookmark" + } + ], + "created_at": "2015-09-16T17:37:40.000000", + "consistency_group_id": "2d5c2600-ae67-4dff-b13c-a1c20b335e8e", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "7e5c3ca7-d54b-438d-9a9c-c65ece6bc6c6", + "description": "Changed description: there is a snapshot of CG2" + } +} 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/samples/manila-consistency-group-create-request.json new file mode 100644 index 000000000..9f9084b27 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-create-request.json @@ -0,0 +1,10 @@ +{ + "consistency_group": { + "share_types": [ + "d2ad4f9d-cae3-4660-b0b6-58c06b385203" + ], + "name": "my-cg1", + "share_network_id": "d8ae6799-2567-4a89-aafb-fa4424350d2b", + "description": "my first consistency group" + } +} 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/samples/manila-consistency-group-create-response.json new file mode 100644 index 000000000..17d7e7c94 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-create-response.json @@ -0,0 +1,26 @@ +{ + "consistency_group": { + "status": "creating", + "description": "my first consistency group", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/6f519a48-3183-46cf-a32f-41815f813986", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/6f519a48-3183-46cf-a32f-41815f813986", + "rel": "bookmark" + } + ], + "source_cgsnapshot_id": null, + "created_at": "2015-09-16T09:28:52.880949", + "share_network_id": "d8ae6799-2567-4a89-aafb-fa4424350d2b", + "host": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "share_types": [ + "d2ad4f9d-cae3-4660-b0b6-58c06b385203" + ], + "id": "6f519a48-3183-46cf-a32f-41815f813986", + "name": "my-cg1" + } +} 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/samples/manila-consistency-group-force-delete-request.json new file mode 100644 index 000000000..6bf59688a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-force-delete-request.json @@ -0,0 +1,3 @@ +{ + "os-force_delete": null +} 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/samples/manila-consistency-group-list-detailed-response.json new file mode 100644 index 000000000..cdf8ac76c --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-list-detailed-response.json @@ -0,0 +1,52 @@ +{ + "consistency_groups": [ + { + "status": "available", + "description": "my first consistency group", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/6f519a48-3183-46cf-a32f-41815f813986", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/6f519a48-3183-46cf-a32f-41815f813986", + "rel": "bookmark" + } + ], + "source_cgsnapshot_id": null, + "created_at": "2015-09-16T09:28:52.000000", + "share_network_id": "d8ae6799-2567-4a89-aafb-fa4424350d2b", + "host": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "share_types": [ + "d2ad4f9d-cae3-4660-b0b6-58c06b385203" + ], + "id": "6f519a48-3183-46cf-a32f-41815f813986", + "name": "my-cg1" + }, + { + "status": "error", + "description": "Edited description", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/aed36625-a6d7-4681-ba59-c7ba3d18c148", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/aed36625-a6d7-4681-ba59-c7ba3d18c148", + "rel": "bookmark" + } + ], + "source_cgsnapshot_id": null, + "created_at": "2015-09-16T09:31:15.000000", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "host": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "share_types": [ + "be27425c-f807-4500-a056-d00721db45cf" + ], + "id": "aed36625-a6d7-4681-ba59-c7ba3d18c148", + "name": "my-cg2" + } + ] +} 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/samples/manila-consistency-group-list-response.json new file mode 100644 index 000000000..494c2035d --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-list-response.json @@ -0,0 +1,32 @@ +{ + "consistency_groups": [ + { + "id": "6f519a48-3183-46cf-a32f-41815f813986", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/6f519a48-3183-46cf-a32f-41815f813986", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/6f519a48-3183-46cf-a32f-41815f813986", + "rel": "bookmark" + } + ], + "name": "my-cg1" + }, + { + "id": "aed36625-a6d7-4681-ba59-c7ba3d18c148", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/aed36625-a6d7-4681-ba59-c7ba3d18c148", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/aed36625-a6d7-4681-ba59-c7ba3d18c148", + "rel": "bookmark" + } + ], + "name": "my-cg2" + } + ] +} 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/samples/manila-consistency-group-reset-state-request.json new file mode 100644 index 000000000..b18b65a68 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-reset-state-request.json @@ -0,0 +1,5 @@ +{ + "os-reset_status": { + "status": "available" + } +} 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/samples/manila-consistency-group-show-response.json new file mode 100644 index 000000000..4b1150dc6 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-show-response.json @@ -0,0 +1,27 @@ +{ + "consistency_group": { + "status": "available", + "description": "My first CG.", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/9397c191-8427-4661-a2e8-b23820dc01d4", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/9397c191-8427-4661-a2e8-b23820dc01d4", + "rel": "bookmark" + } + ], + "source_cgsnapshot_id": null, + "created_at": "2015-09-16T16:50:31.000000", + "share_network_id": "f9b2e754-ac01-4466-86e1-5c569424754e", + "share_server_id": null, + "host": "manila2@generic1#GENERIC1", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "share_types": [ + "be27425c-f807-4500-a056-d00721db45cf" + ], + "id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "name": "cg1" + } +} 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/samples/manila-consistency-group-update-request.json new file mode 100644 index 000000000..7a23f305a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-update-request.json @@ -0,0 +1,5 @@ +{ + "consistency_group": { + "description": "Edited description" + } +} 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/samples/manila-consistency-group-update-response.json new file mode 100644 index 000000000..931112776 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-consistency-group-update-response.json @@ -0,0 +1,26 @@ +{ + "consistency_group": { + "status": "error", + "description": "Edited description", + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/aed36625-a6d7-4681-ba59-c7ba3d18c148", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/consistency_groups/aed36625-a6d7-4681-ba59-c7ba3d18c148", + "rel": "bookmark" + } + ], + "source_cgsnapshot_id": null, + "created_at": "2015-09-16T09:31:15.000000", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "host": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "share_types": [ + "be27425c-f807-4500-a056-d00721db45cf" + ], + "id": "aed36625-a6d7-4681-ba59-c7ba3d18c148", + "name": "my-cg2" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-extensions-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-extensions-list-response.json new file mode 100644 index 000000000..ff88d90c8 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-extensions-list-response.json @@ -0,0 +1,102 @@ +{ + "extensions": [ + { + "alias": "os-extended-quotas", + "updated": "2013-06-09T00:00:00+00:00", + "name": "ExtendedQuotas", + "links": [], + "description": "Extend quotas. Adds ability for admins to delete quota and optionally force the update Quota command." + }, + { + "alias": "os-quota-sets", + "updated": "2011-08-08T00:00:00+00:00", + "name": "Quotas", + "links": [], + "description": "Quotas management support." + }, + { + "alias": "os-quota-class-sets", + "updated": "2012-03-12T00:00:00+00:00", + "name": "QuotaClasses", + "links": [], + "description": "Quota classes management support." + }, + { + "alias": "os-share-unmanage", + "updated": "2015-02-17T00:00:00+00:00", + "name": "ShareUnmanage", + "links": [], + "description": "Enable share unmanage operation." + }, + { + "alias": "os-types-manage", + "updated": "2011-08-24T00:00:00+00:00", + "name": "TypesManage", + "links": [], + "description": "Types manage support." + }, + { + "alias": "share-actions", + "updated": "2012-08-14T00:00:00+00:00", + "name": "ShareActions", + "links": [], + "description": "Enable share actions." + }, + { + "alias": "os-availability-zone", + "updated": "2015-07-28T00:00:00+00:00", + "name": "AvailabilityZones", + "links": [], + "description": "Describe Availability Zones." + }, + { + "alias": "os-user-quotas", + "updated": "2013-07-18T00:00:00+00:00", + "name": "UserQuotas", + "links": [], + "description": "Project user quota support." + }, + { + "alias": "os-share-type-access", + "updated": "2015-03-02T00:00:00Z", + "name": "ShareTypeAccess", + "links": [], + "description": "share type access support." + }, + { + "alias": "os-types-extra-specs", + "updated": "2011-08-24T00:00:00+00:00", + "name": "TypesExtraSpecs", + "links": [], + "description": "Type extra specs support." + }, + { + "alias": "os-admin-actions", + "updated": "2015-08-03T00:00:00+00:00", + "name": "AdminActions", + "links": [], + "description": "Enable admin actions." + }, + { + "alias": "os-used-limits", + "updated": "2014-03-27T00:00:00+00:00", + "name": "UsedLimits", + "links": [], + "description": "Provide data on limited resources that are being used." + }, + { + "alias": "os-services", + "updated": "2012-10-28T00:00:00-00:00", + "name": "Services", + "links": [], + "description": "Services support." + }, + { + "alias": "os-share-manage", + "updated": "2015-02-17T00:00:00+00:00", + "name": "ShareManage", + "links": [], + "description": "Allows existing share to be 'managed' by Manila." + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-limits-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-limits-response.json new file mode 100644 index 000000000..d9b0619b4 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-limits-response.json @@ -0,0 +1,17 @@ +{ + "limits": { + "rate": [], + "absolute": { + "totalShareNetworksUsed": 0, + "maxTotalShareGigabytes": 1000, + "maxTotalShareNetworks": 10, + "totalSharesUsed": 0, + "totalShareGigabytesUsed": 0, + "totalShareSnapshotsUsed": 0, + "maxTotalShares": 50, + "totalSnapshotGigabytesUsed": 0, + "maxTotalSnapshotGigabytes": 1000, + "maxTotalShareSnapshots": 50 + } + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-list-pools-detailed-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-list-pools-detailed-response.json new file mode 100644 index 000000000..3f8e6fb3f --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-list-pools-detailed-response.json @@ -0,0 +1,29 @@ +{ + "pools": [ + { + "pool": "LONDON", + "host": "nosb-devstack", + "name": "nosb-devstack@london#LONDON", + "capabilities": { + "QoS_support": false, + "consistency_group_support": "pool", + "timestamp": "2015-09-21T08:58:56.190856", + "share_backend_name": "LONDON", + "server_pools_mapping": { + "1320689d-80f4-49f6-8a70-0e2c1ed8ad90": [], + "3a4caac5-0880-4629-a334-6cdda88a0c0e": [] + }, + "driver_handles_share_servers": true, + "driver_version": "1.0", + "total_capacity_gb": "unknown", + "reserved_percentage": 0, + "pools": null, + "vendor_name": "Open Source", + "snapshot_support": true, + "free_capacity_gb": "unknown", + "storage_protocol": "NFS_CIFS" + }, + "backend": "london" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-list-pools-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-list-pools-response.json new file mode 100644 index 000000000..d04fea233 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-list-pools-response.json @@ -0,0 +1,22 @@ +{ + "pools": [ + { + "host": "manila2", + "name": "manila2@generic1#GENERIC1", + "pool": "GENERIC1", + "backend": "generic1" + }, + { + "host": "manila2", + "name": "manila2@unmanage1#UNMANAGE1", + "pool": "UNMANAGE1", + "backend": "unmanage1" + }, + { + "host": "manila2", + "name": "manila2@ams_backend#AMS_BACKEND", + "pool": "AMS_BACKEND", + "backend": "ams_backend" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-create-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-create-request.json new file mode 100644 index 000000000..a12779af8 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-create-request.json @@ -0,0 +1,10 @@ +{ + "security_service": { + "description": "Creating my first Security Service", + "dns_ip": "10.0.0.0/24", + "user": "demo", + "password": "***", + "type": "kerberos", + "name": "SecServ1" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-create-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-create-response.json new file mode 100644 index 000000000..e6c9f2197 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-create-response.json @@ -0,0 +1,17 @@ +{ + "security_service": { + "status": "new", + "domain": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "SecServ1", + "created_at": "2015-09-07T12:19:10.695211", + "updated_at": null, + "server": null, + "dns_ip": "10.0.0.0/24", + "user": "demo", + "password": "supersecret", + "type": "kerberos", + "id": "3c829734-0679-4c17-9637-801da48c0d5f", + "description": "Creating my first Security Service" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-detailed-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-detailed-response.json new file mode 100644 index 000000000..a593bea0f --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-detailed-response.json @@ -0,0 +1,36 @@ +{ + "security_services": [ + { + "status": "new", + "domain": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "SecServ1", + "created_at": "2015-09-07T12:19:10.000000", + "description": "Creating my first Security Service", + "updated_at": null, + "server": null, + "dns_ip": "10.0.0.0/24", + "user": "demo", + "password": "supersecret", + "type": "kerberos", + "id": "3c829734-0679-4c17-9637-801da48c0d5f", + "share_networks": [] + }, + { + "status": "new", + "domain": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "SecServ2", + "created_at": "2015-09-07T12:25:03.000000", + "description": "Creating my second Security Service", + "updated_at": null, + "server": null, + "dns_ip": "10.0.0.0/24", + "user": null, + "password": null, + "type": "ldap", + "id": "5a1d3a12-34a7-4087-8983-50e9ed03509a", + "share_networks": [] + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-for-share-network-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-for-share-network-response.json new file mode 100644 index 000000000..8abfabd80 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-for-share-network-response.json @@ -0,0 +1,40 @@ +{ + "security_services": [ + { + "status": "new", + "domain": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "SecServ1", + "created_at": "2015-09-07T12:19:10.000000", + "description": "Creating my first Security Service", + "updated_at": null, + "server": null, + "dns_ip": "10.0.0.0/24", + "user": "demo", + "password": "supersecret", + "type": "kerberos", + "id": "3c829734-0679-4c17-9637-801da48c0d5f", + "share_networks": [ + "d8ae6799-2567-4a89-aafb-fa4424350d2b" + ] + }, + { + "status": "new", + "domain": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "SecServ2", + "created_at": "2015-09-07T12:25:03.000000", + "description": "Creating my second Security Service", + "updated_at": null, + "server": null, + "dns_ip": "10.0.0.0/24", + "user": null, + "password": null, + "type": "ldap", + "id": "5a1d3a12-34a7-4087-8983-50e9ed03509a", + "share_networks": [ + "d8ae6799-2567-4a89-aafb-fa4424350d2b" + ] + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-response.json new file mode 100644 index 000000000..9dfedf106 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-list-response.json @@ -0,0 +1,16 @@ +{ + "security_services": [ + { + "status": "new", + "type": "kerberos", + "id": "3c829734-0679-4c17-9637-801da48c0d5f", + "name": "SecServ1" + }, + { + "status": "new", + "type": "ldap", + "id": "5a1d3a12-34a7-4087-8983-50e9ed03509a", + "name": "SecServ2" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-show-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-show-response.json new file mode 100644 index 000000000..6391b0d75 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-show-response.json @@ -0,0 +1,17 @@ +{ + "security_service": { + "status": "new", + "domain": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "SecServ1", + "created_at": "2015-09-07T12:19:10.000000", + "updated_at": null, + "server": null, + "dns_ip": "10.0.0.0/24", + "user": "demo", + "password": "supersecret", + "type": "kerberos", + "id": "3c829734-0679-4c17-9637-801da48c0d5f", + "description": "Creating my first Security Service" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-update-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-update-request.json new file mode 100644 index 000000000..4bf480308 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-update-request.json @@ -0,0 +1,8 @@ +{ + "security_service": { + "domain": "my_domain", + "password": "***", + "user": "new_user", + "description": "Adding a description" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-update-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-update-response.json new file mode 100644 index 000000000..7647800e9 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-security-service-update-response.json @@ -0,0 +1,17 @@ +{ + "security_service": { + "status": "new", + "domain": "my_domain", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "SecServ1", + "created_at": "2015-09-07T12:19:10.000000", + "updated_at": "2015-09-07T12:47:21.858737", + "server": null, + "dns_ip": "10.0.0.0/24", + "user": "new_user", + "password": "pass", + "type": "kerberos", + "id": "3c829734-0679-4c17-9637-801da48c0d5f", + "description": "Adding a description" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-services-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-list-response.json new file mode 100644 index 000000000..7ebb3e1fb --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-list-response.json @@ -0,0 +1,22 @@ +{ + "services": [ + { + "status": "enabled", + "binary": "manila-share", + "zone": "nova", + "host": "manila2@generic1", + "updated_at": "2015-09-07T13:03:57.000000", + "state": "up", + "id": 1 + }, + { + "status": "enabled", + "binary": "manila-scheduler", + "zone": "nova", + "host": "manila2", + "updated_at": "2015-09-07T13:03:57.000000", + "state": "up", + "id": 2 + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-services-list-with-filters-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-list-with-filters-response.json new file mode 100644 index 000000000..ae25d76ad --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-services-list-with-filters-response.json @@ -0,0 +1,13 @@ +{ + "services": [ + { + "status": "enabled", + "binary": "manila-share", + "zone": "nova", + "host": "manila2@generic1", + "updated_at": "2015-09-07T13:14:27.000000", + "state": "up", + "id": 1 + } + ] +} 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-allow-access-request.json new file mode 100644 index 000000000..3407acdea --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-allow-access-request.json @@ -0,0 +1,7 @@ +{ + "os-allow_access": { + "access_level": "rw", + "access_type": "ip", + "access_to": "0.0.0.0/0" + } +} 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-allow-access-response.json new file mode 100644 index 000000000..823ee6612 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-allow-access-response.json @@ -0,0 +1,11 @@ +{ + "access": { + "share_id": "406ea93b-32e9-4907-a117-148b3945749f", + "created_at": "2015-09-07T09:14:48.000000", + "updated_at": null, + "access_type": "ip", + "access_to": "0.0.0.0/0", + "access_level": "rw", + "id": "a25b2df3-90bd-4add-afa6-5f0dbbd50452" + } +} 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-deny-access-request.json new file mode 100644 index 000000000..8a4346194 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-deny-access-request.json @@ -0,0 +1,5 @@ +{ + "os-deny_access": { + "access_id": "a25b2df3-90bd-4add-afa6-5f0dbbd50452" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-extend-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-extend-request.json new file mode 100644 index 000000000..171f6127e --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-extend-request.json @@ -0,0 +1,5 @@ +{ + "os-extend": { + "new_size": 2 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-force-delete-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-force-delete-request.json new file mode 100644 index 000000000..6bf59688a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-force-delete-request.json @@ -0,0 +1,3 @@ +{ + "os-force_delete": null +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-list-access-rules-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-list-access-rules-request.json new file mode 100644 index 000000000..808654ae4 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-list-access-rules-request.json @@ -0,0 +1,3 @@ +{ + "os-access_list": null +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-list-access-rules-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-list-access-rules-response.json new file mode 100644 index 000000000..af015fc3c --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-list-access-rules-response.json @@ -0,0 +1,18 @@ +{ + "access_list": [ + { + "access_level": "rw", + "state": "error", + "id": "507bf114-36f2-4f56-8cf4-857985ca87c1", + "access_type": "cert", + "access_to": "example.com" + }, + { + "access_level": "rw", + "state": "active", + "id": "a25b2df3-90bd-4add-afa6-5f0dbbd50452", + "access_type": "ip", + "access_to": "0.0.0.0/0" + } + ] +} 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/samples/manila-share-actions-mirate-request.json new file mode 100644 index 000000000..6a096302e --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-mirate-request.json @@ -0,0 +1,6 @@ +{ + "os-migrate_share": { + "force_host_copy": false, + "host": "manila2@ams_backend#AMS_BACKEND" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-reset-state-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-reset-state-request.json new file mode 100644 index 000000000..965e9a4e5 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-reset-state-request.json @@ -0,0 +1,5 @@ +{ + "os-reset_status": { + "status": "error" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-shrink-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-shrink-request.json new file mode 100644 index 000000000..5d7f49f68 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-actions-shrink-request.json @@ -0,0 +1,5 @@ +{ + "os-shrink": { + "new_size": 1 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-create-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-create-request.json new file mode 100644 index 000000000..c1f55ffbc --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-create-request.json @@ -0,0 +1,17 @@ +{ + "share": { + "description": "My custom share London", + "share_type": null, + "share_proto": "nfs", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "name": "share_London", + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "snapshot_id": null, + "is_public": true, + "size": 1, + "metadata": { + "project": "my_app", + "aim": "doc" + } + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-create-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-create-response.json new file mode 100644 index 000000000..6f6ac2304 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-create-response.json @@ -0,0 +1,41 @@ +{ + "share": { + "status": null, + "share_server_id": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "share_London", + "share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7", + "share_type_name": "default", + "availability_zone": null, + "created_at": "2015-09-18T10:25:24.533287", + "export_location": null, + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", + "rel": "bookmark" + } + ], + "share_network_id": null, + "export_locations": [], + "share_proto": "NFS", + "host": null, + "task_state": null, + "snapshot_support": true, + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "source_cgsnapshot_member_id": null, + "volume_type": "default", + "snapshot_id": null, + "is_public": true, + "metadata": { + "project": "my_app", + "aim": "doc" + }, + "id": "011d21e2-fbc3-4e4a-9993-9ea223f73264", + "size": 1, + "description": "My custom share London" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-actions-force-delete-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-actions-force-delete-request.json new file mode 100644 index 000000000..6bf59688a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-actions-force-delete-request.json @@ -0,0 +1,3 @@ +{ + "os-force_delete": null +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-actions-reset-state-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-actions-reset-state-request.json new file mode 100644 index 000000000..b18b65a68 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-actions-reset-state-request.json @@ -0,0 +1,5 @@ +{ + "os-reset_status": { + "status": "available" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-list-response.json new file mode 100644 index 000000000..f03abb5d8 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-instance-list-response.json @@ -0,0 +1,32 @@ +{ + "share_instances": [ + { + "status": "error", + "share_id": "406ea93b-32e9-4907-a117-148b3945749f", + "availability_zone": "nova", + "created_at": "2015-09-07T08:41:20.000000", + "export_location": "10.254.0.3:/shares/share-081f7030-c54f-42f5-98ee-93a37393e0f2", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "export_locations": [ + "10.254.0.3:/shares/share-081f7030-c54f-42f5-98ee-93a37393e0f2" + ], + "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73", + "host": "manila2@generic1#GENERIC1", + "id": "081f7030-c54f-42f5-98ee-93a37393e0f2" + }, + { + "status": "available", + "share_id": "d94a8548-2079-4be0-b21c-0a887acd31ca", + "availability_zone": "nova", + "created_at": "2015-09-07T08:51:34.000000", + "export_location": "10.254.0.3:/shares/share-75559a8b-c90c-42a7-bda2-edbe86acfb7b", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "export_locations": [ + "10.254.0.3:/shares/share-75559a8b-c90c-42a7-bda2-edbe86acfb7b" + ], + "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73", + "host": "manila2@generic1#GENERIC1", + "id": "75559a8b-c90c-42a7-bda2-edbe86acfb7b" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-list-detailed-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-list-detailed-response.json new file mode 100644 index 000000000..a508563d2 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-list-detailed-response.json @@ -0,0 +1,78 @@ +{ + "shares": [ + { + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/f45cc5b2-d1bb-4a3e-ba5b-5c4125613adc", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/f45cc5b2-d1bb-4a3e-ba5b-5c4125613adc", + "rel": "bookmark" + } + ], + "availability_zone": "nova", + "share_network_id": "f9b2e754-ac01-4466-86e1-5c569424754e", + "export_locations": [], + "share_server_id": "87d8943a-f5da-47a4-b2f2-ddfa6794aa82", + "snapshot_id": null, + "id": "f45cc5b2-d1bb-4a3e-ba5b-5c4125613adc", + "size": 1, + "share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7", + "share_type_name": "default", + "export_location": null, + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "metadata": {}, + "status": "error", + "description": "There is a share description.", + "host": "manila2@generic1#GENERIC1", + "task_state": null, + "is_public": true, + "snapshot_support": true, + "name": "my_share4", + "created_at": "2015-09-16T18:19:50.000000", + "share_proto": "NFS", + "volume_type": "default", + "source_cgsnapshot_member_id": null + }, + { + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/c4a2ced4-2c9f-4ae1-adaa-6171833e64df", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/c4a2ced4-2c9f-4ae1-adaa-6171833e64df", + "rel": "bookmark" + } + ], + "availability_zone": "nova", + "share_network_id": "f9b2e754-ac01-4466-86e1-5c569424754e", + "export_locations": [ + "10.254.0.5:/shares/share-50ad5e7b-f6f1-4b78-a651-0812cef2bb67" + ], + "share_server_id": "87d8943a-f5da-47a4-b2f2-ddfa6794aa82", + "snapshot_id": null, + "id": "c4a2ced4-2c9f-4ae1-adaa-6171833e64df", + "size": 1, + "share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7", + "share_type_name": "default", + "export_location": "10.254.0.5:/shares/share-50ad5e7b-f6f1-4b78-a651-0812cef2bb67", + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "metadata": {}, + "status": "available", + "description": "Changed description.", + "host": "manila2@generic1#GENERIC1", + "task_state": null, + "is_public": true, + "snapshot_support": true, + "name": "my_share4", + "created_at": "2015-09-16T17:26:28.000000", + "share_proto": "NFS", + "volume_type": "default", + "source_cgsnapshot_member_id": null + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-list-response.json new file mode 100644 index 000000000..3e148d524 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-list-response.json @@ -0,0 +1,32 @@ +{ + "shares": [ + { + "id": "d94a8548-2079-4be0-b21c-0a887acd31ca", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/shares/d94a8548-2079-4be0-b21c-0a887acd31ca", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/d94a8548-2079-4be0-b21c-0a887acd31ca", + "rel": "bookmark" + } + ], + "name": "My_share" + }, + { + "id": "406ea93b-32e9-4907-a117-148b3945749f", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/shares/406ea93b-32e9-4907-a117-148b3945749f", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/406ea93b-32e9-4907-a117-148b3945749f", + "rel": "bookmark" + } + ], + "name": "Share1" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-add-security-service-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-add-security-service-request.json new file mode 100644 index 000000000..927c581eb --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-add-security-service-request.json @@ -0,0 +1,5 @@ +{ + "add_security_service": { + "security_service_id": "3c829734-0679-4c17-9637-801da48c0d5f" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-add-security-service-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-add-security-service-response.json new file mode 100644 index 000000000..32c13657a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-add-security-service-response.json @@ -0,0 +1,17 @@ +{ + "share_network": { + "name": "net2", + "segmentation_id": null, + "created_at": "2015-09-07T12:31:12.000000", + "neutron_subnet_id": null, + "updated_at": null, + "id": "d8ae6799-2567-4a89-aafb-fa4424350d2b", + "neutron_net_id": null, + "ip_version": null, + "nova_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109", + "cidr": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "network_type": null, + "description": null + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-create-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-create-request.json new file mode 100644 index 000000000..3f4ac2e4d --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-create-request.json @@ -0,0 +1,8 @@ +{ + "share_network": { + "neutron_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109", + "neutron_subnet_id": "53482b62-2c84-4a53-b6ab-30d9d9800d06", + "name": "my_network", + "description": "This is my share network" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-create-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-create-response.json new file mode 100644 index 000000000..81bdabcf5 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-create-response.json @@ -0,0 +1,17 @@ +{ + "share_network": { + "name": "my_network", + "segmentation_id": null, + "created_at": "2015-09-07T14:37:00.583656", + "neutron_subnet_id": "53482b62-2c84-4a53-b6ab-30d9d9800d06", + "updated_at": null, + "id": "77eb3421-4549-4789-ac39-0d5185d68c29", + "neutron_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109", + "ip_version": null, + "nova_net_id": null, + "cidr": null, + "project_id": "e10a683c20da41248cfd5e1ab3d88c62", + "network_type": null, + "description": "This is my share network" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-list-detailed-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-list-detailed-response.json new file mode 100644 index 000000000..a36cebe89 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-list-detailed-response.json @@ -0,0 +1,49 @@ +{ + "share_networks": [ + { + "name": "net_my1", + "segmentation_id": null, + "created_at": "2015-09-04T14:57:13.000000", + "neutron_subnet_id": "53482b62-2c84-4a53-b6ab-30d9d9800d06", + "updated_at": null, + "id": "32763294-e3d4-456a-998d-60047677c2fb", + "neutron_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109", + "ip_version": null, + "nova_net_id": null, + "cidr": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "network_type": null, + "description": "descr" + }, + { + "name": "net_my", + "segmentation_id": null, + "created_at": "2015-09-04T14:54:25.000000", + "neutron_subnet_id": "53482b62-2c84-4a53-b6ab-30d9d9800d06", + "updated_at": null, + "id": "713df749-aac0-4a54-af52-10f6c991e80c", + "neutron_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109", + "ip_version": null, + "nova_net_id": null, + "cidr": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "network_type": null, + "description": "desecr" + }, + { + "name": null, + "segmentation_id": null, + "created_at": "2015-09-04T14:51:41.000000", + "neutron_subnet_id": null, + "updated_at": null, + "id": "fa158a3d-6d9f-4187-9ca5-abbb82646eb2", + "neutron_net_id": null, + "ip_version": null, + "nova_net_id": null, + "cidr": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "network_type": null, + "description": null + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-list-response.json new file mode 100644 index 000000000..dc3ba346c --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-list-response.json @@ -0,0 +1,16 @@ +{ + "share_networks": [ + { + "id": "32763294-e3d4-456a-998d-60047677c2fb", + "name": "net_my1" + }, + { + "id": "713df749-aac0-4a54-af52-10f6c991e80c", + "name": "net_my" + }, + { + "id": "fa158a3d-6d9f-4187-9ca5-abbb82646eb2", + "name": null + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-remove-security-service-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-remove-security-service-request.json new file mode 100644 index 000000000..221831015 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-remove-security-service-request.json @@ -0,0 +1,5 @@ +{ + "remove_security_service": { + "security_service_id": "3c829734-0679-4c17-9637-801da48c0d5f" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-remove-security-service-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-remove-security-service-response.json new file mode 100644 index 000000000..32c13657a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-remove-security-service-response.json @@ -0,0 +1,17 @@ +{ + "share_network": { + "name": "net2", + "segmentation_id": null, + "created_at": "2015-09-07T12:31:12.000000", + "neutron_subnet_id": null, + "updated_at": null, + "id": "d8ae6799-2567-4a89-aafb-fa4424350d2b", + "neutron_net_id": null, + "ip_version": null, + "nova_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109", + "cidr": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "network_type": null, + "description": null + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-show-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-show-response.json new file mode 100644 index 000000000..5a94c78f7 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-show-response.json @@ -0,0 +1,17 @@ +{ + "share_network": { + "name": "net_my1", + "segmentation_id": null, + "created_at": "2015-09-04T14:56:45.000000", + "neutron_subnet_id": "53482b62-2c84-4a53-b6ab-30d9d9800d06", + "updated_at": null, + "id": "7f950b52-6141-4a08-bbb5-bb7ffa3ea5fd", + "neutron_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109", + "ip_version": null, + "nova_net_id": null, + "cidr": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "network_type": null, + "description": "descr" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-update-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-update-request.json new file mode 100644 index 000000000..a2b932f72 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-update-request.json @@ -0,0 +1,5 @@ +{ + "share_network": { + "description": "i'm adding a description" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-update-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-update-response.json new file mode 100644 index 000000000..c606f62d8 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-network-update-response.json @@ -0,0 +1,17 @@ +{ + "share_network": { + "name": "net_my", + "segmentation_id": null, + "created_at": "2015-09-04T14:54:25.000000", + "neutron_subnet_id": "53482b62-2c84-4a53-b6ab-30d9d9800d06", + "updated_at": "2015-09-07T08:02:53.512184", + "id": "713df749-aac0-4a54-af52-10f6c991e80c", + "neutron_net_id": "998b42ee-2cee-4d36-8b95-67b5ca1f2109", + "ip_version": "4", + "nova_net_id": null, + "cidr": null, + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "network_type": null, + "description": "i'm adding a description" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-list-response.json new file mode 100644 index 000000000..4f4edbaf5 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-list-response.json @@ -0,0 +1,13 @@ +{ + "share_servers": [ + { + "status": "active", + "updated_at": "2015-09-07T08:52:15.000000", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "host": "manila2@generic1", + "share_network_name": "net_my", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-show-detailes-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-show-detailes-response.json new file mode 100644 index 000000000..d4cc68f51 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-show-detailes-response.json @@ -0,0 +1,12 @@ +{ + "details": { + "username": "manila", + "router_id": "4b62ce91-56c5-45c1-b0ef-8cbbe5dd34f4", + "pk_path": "/opt/stack/.ssh/id_rsa", + "subnet_id": "16e99ad6-5191-461c-9f34-ac84a39c3adb", + "ip": "10.254.0.3", + "instance_id": "75f2f282-af65-49ba-a7b1-525705b1bf1a", + "public_address": "10.254.0.3", + "service_port_id": "8ff21760-961e-4b83-a032-03fd559bb1d3" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-show-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-show-response.json new file mode 100644 index 000000000..4081089ff --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-server-show-response.json @@ -0,0 +1,22 @@ +{ + "share_server": { + "status": "active", + "backend_details": { + "username": "manila", + "router_id": "4b62ce91-56c5-45c1-b0ef-8cbbe5dd34f4", + "pk_path": "/opt/stack/.ssh/id_rsa", + "subnet_id": "16e99ad6-5191-461c-9f34-ac84a39c3adb", + "ip": "10.254.0.3", + "instance_id": "75f2f282-af65-49ba-a7b1-525705b1bf1a", + "public_address": "10.254.0.3", + "service_port_id": "8ff21760-961e-4b83-a032-03fd559bb1d3" + }, + "created_at": "2015-09-07T08:37:19.000000", + "updated_at": "2015-09-07T08:52:15.000000", + "share_network_name": "net_my", + "host": "manila2@generic1", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-set-metadata-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-set-metadata-request.json new file mode 100644 index 000000000..282342e6d --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-set-metadata-request.json @@ -0,0 +1,5 @@ +{ + "metadata": { + "key1": "value1" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-set-metadata-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-set-metadata-response.json new file mode 100644 index 000000000..5bdb58d3b --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-set-metadata-response.json @@ -0,0 +1,9 @@ +{ + "metadata": { + "aim": "changed_doc", + "project": "my_app", + "key1": "value1", + "new_metadata_key": "new_information", + "key": "value" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-instance-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-instance-response.json new file mode 100644 index 000000000..b186a5544 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-instance-response.json @@ -0,0 +1,16 @@ +{ + "share_instance": { + "status": "available", + "share_id": "d94a8548-2079-4be0-b21c-0a887acd31ca", + "availability_zone": "nova", + "created_at": "2015-09-07T08:51:34.000000", + "export_location": "10.254.0.3:/shares/share-75559a8b-c90c-42a7-bda2-edbe86acfb7b", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "export_locations": [ + "10.254.0.3:/shares/share-75559a8b-c90c-42a7-bda2-edbe86acfb7b" + ], + "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73", + "host": "manila2@generic1#GENERIC1", + "id": "75559a8b-c90c-42a7-bda2-edbe86acfb7b" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-metadata-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-metadata-response.json new file mode 100644 index 000000000..f9793457d --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-metadata-response.json @@ -0,0 +1,6 @@ +{ + "metadata": { + "project": "my_app", + "aim": "doc" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-response.json new file mode 100644 index 000000000..e61219061 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-show-response.json @@ -0,0 +1,41 @@ +{ + "share": { + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", + "rel": "bookmark" + } + ], + "availability_zone": "nova", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "export_locations": [], + "share_server_id": "e268f4aa-d571-43dd-9ab3-f49ad06ffaef", + "snapshot_id": null, + "id": "011d21e2-fbc3-4e4a-9993-9ea223f73264", + "size": 1, + "share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7", + "share_type_name": "default", + "export_location": null, + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "metadata": { + "project": "my_app", + "aim": "doc" + }, + "status": "available", + "description": "My custom share London", + "host": "manila2@generic1#GENERIC1", + "task_state": null, + "is_public": true, + "snapshot_support": true, + "name": "share_London", + "created_at": "2015-09-18T10:25:24.000000", + "share_proto": "NFS", + "volume_type": "default", + "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-access-add-request.json new file mode 100644 index 000000000..952cf4963 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-add-request.json @@ -0,0 +1,5 @@ +{ + "addProjectAccess": { + "project": "e1284adea3ee4d2482af5ed214f3ad90" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-list-response.json new file mode 100644 index 000000000..d4e5bf42c --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-list-response.json @@ -0,0 +1,12 @@ +{ + "share_type_access": [ + { + "share_type_id": "1732f284-401d-41d9-a494-425451e8b4b8", + "project_id": "818a3f48dcd644909b3fa2e45a399a27" + }, + { + "share_type_id": "1732f284-401d-41d9-a494-425451e8b4b8", + "project_id": "e1284adea3ee4d2482af5ed214f3ad90" + } + ] +} 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-access-remove-request.json new file mode 100644 index 000000000..bdc492dd4 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-access-remove-request.json @@ -0,0 +1,5 @@ +{ + "removeProjectAccess": { + "project": "818a3f48dcd644909b3fa2e45a399a27" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-create-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-create-request.json new file mode 100644 index 000000000..de6af3a61 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-create-request.json @@ -0,0 +1,10 @@ +{ + "volume_type": { + "os-share-type-access:is_public": true, + "extra_specs": { + "driver_handles_share_servers": true, + "snapshot_support": true + }, + "name": "my_new_volume_type" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-create-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-create-response.json new file mode 100644 index 000000000..12e091104 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-create-response.json @@ -0,0 +1,26 @@ +{ + "volume_type": { + "os-share-type-access:is_public": true, + "required_extra_specs": { + "driver_handles_share_servers": true + }, + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "True" + }, + "name": "my_new_volume_type", + "id": "1d600d02-26a7-4b23-af3d-7d51860fe858" + }, + "share_type": { + "os-share-type-access:is_public": true, + "required_extra_specs": { + "driver_handles_share_servers": true + }, + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "True" + }, + "name": "my_new_volume_type", + "id": "1d600d02-26a7-4b23-af3d-7d51860fe858" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-default-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-default-response.json new file mode 100644 index 000000000..bd3060ead --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-default-response.json @@ -0,0 +1,20 @@ +{ + "volume_type": { + "required_extra_specs": null, + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "True" + }, + "name": "default", + "id": "be27425c-f807-4500-a056-d00721db45cf" + }, + "share_type": { + "required_extra_specs": null, + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "True" + }, + "name": "default", + "id": "be27425c-f807-4500-a056-d00721db45cf" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-extra-specs-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-extra-specs-response.json new file mode 100644 index 000000000..9752fe43e --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-extra-specs-response.json @@ -0,0 +1,6 @@ +{ + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "True" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-response.json new file mode 100644 index 000000000..412e893da --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-list-response.json @@ -0,0 +1,54 @@ +{ + "volume_types": [ + { + "os-share-type-access:is_public": true, + "required_extra_specs": { + "driver_handles_share_servers": "True" + }, + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "True" + }, + "name": "default", + "id": "be27425c-f807-4500-a056-d00721db45cf" + }, + { + "os-share-type-access:is_public": true, + "required_extra_specs": { + "driver_handles_share_servers": "false" + }, + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "false" + }, + "name": "d", + "id": "f015bebe-c38b-4c49-8832-00143b10253b" + } + ], + "share_types": [ + { + "os-share-type-access:is_public": true, + "required_extra_specs": { + "driver_handles_share_servers": "True" + }, + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "True" + }, + "name": "default", + "id": "be27425c-f807-4500-a056-d00721db45cf" + }, + { + "os-share-type-access:is_public": true, + "required_extra_specs": { + "driver_handles_share_servers": "false" + }, + "extra_specs": { + "snapshot_support": "True", + "driver_handles_share_servers": "false" + }, + "name": "d", + "id": "f015bebe-c38b-4c49-8832-00143b10253b" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-set-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-set-request.json new file mode 100644 index 000000000..0c3330e03 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-set-request.json @@ -0,0 +1,5 @@ +{ + "extra_specs": { + "my_key": "my_value" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-set-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-set-response.json new file mode 100644 index 000000000..0c3330e03 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-type-set-response.json @@ -0,0 +1,5 @@ +{ + "extra_specs": { + "my_key": "my_value" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-metadata-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-metadata-request.json new file mode 100644 index 000000000..d4559547f --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-metadata-request.json @@ -0,0 +1,7 @@ +{ + "metadata": { + "aim": "changed_doc", + "project": "my_app", + "new_metadata_key": "new_information" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-metadata-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-metadata-response.json new file mode 100644 index 000000000..d4559547f --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-metadata-response.json @@ -0,0 +1,7 @@ +{ + "metadata": { + "aim": "changed_doc", + "project": "my_app", + "new_metadata_key": "new_information" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-request.json new file mode 100644 index 000000000..37fcf6a27 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-request.json @@ -0,0 +1,6 @@ +{ + "share": { + "is_public": true, + "display_description": "Changing the share description." + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-response.json new file mode 100644 index 000000000..d7e1a7781 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-share-update-response.json @@ -0,0 +1,41 @@ +{ + "share": { + "links": [ + { + "href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", + "rel": "bookmark" + } + ], + "availability_zone": "nova", + "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "export_locations": [], + "share_server_id": "e268f4aa-d571-43dd-9ab3-f49ad06ffaef", + "snapshot_id": null, + "id": "011d21e2-fbc3-4e4a-9993-9ea223f73264", + "size": 1, + "share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7", + "share_type_name": "default", + "export_location": null, + "consistency_group_id": "9397c191-8427-4661-a2e8-b23820dc01d4", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "metadata": { + "project": "my_app", + "aim": "doc" + }, + "status": "error", + "description": "Changing the share description.", + "host": "manila2@generic1#GENERIC1", + "task_state": null, + "is_public": true, + "snapshot_support": true, + "name": "share_London", + "created_at": "2015-09-18T10:25:24.000000", + "share_proto": "NFS", + "volume_type": "default", + "source_cgsnapshot_member_id": null + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-actions-force-delete-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-actions-force-delete-request.json new file mode 100644 index 000000000..6bf59688a --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-actions-force-delete-request.json @@ -0,0 +1,3 @@ +{ + "os-force_delete": null +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-actions-reset-state-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-actions-reset-state-request.json new file mode 100644 index 000000000..965e9a4e5 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-actions-reset-state-request.json @@ -0,0 +1,5 @@ +{ + "os-reset_status": { + "status": "error" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-create-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-create-request.json new file mode 100644 index 000000000..0540431cd --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-create-request.json @@ -0,0 +1,8 @@ +{ + "snapshot": { + "share_id": "406ea93b-32e9-4907-a117-148b3945749f", + "force": "True", + "name": "snapshot_share1", + "description": "Here is a snapshot of share Share1" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-create-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-create-response.json new file mode 100644 index 000000000..1723e3e23 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-create-response.json @@ -0,0 +1,23 @@ +{ + "snapshot": { + "status": "creating", + "share_id": "406ea93b-32e9-4907-a117-148b3945749f", + "name": "snapshot_share1", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "bookmark" + } + ], + "created_at": "2015-09-07T11:50:39.756808", + "description": "Here is a snapshot of share Share1", + "share_proto": "NFS", + "share_size": 1, + "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb", + "size": 1 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-list-detailed-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-list-detailed-response.json new file mode 100644 index 000000000..b1360c0f5 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-list-detailed-response.json @@ -0,0 +1,46 @@ +{ + "snapshots": [ + { + "status": "creating", + "share_id": "d94a8548-2079-4be0-b21c-0a887acd31ca", + "name": "snapshot_My_share", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/086a1aa6-c425-4ecd-9612-391a3b1b9375", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/086a1aa6-c425-4ecd-9612-391a3b1b9375", + "rel": "bookmark" + } + ], + "created_at": "2015-09-07T11:55:09.000000", + "description": "Here is a snapshot of share My_share", + "share_proto": "NFS", + "share_size": 1, + "id": "086a1aa6-c425-4ecd-9612-391a3b1b9375", + "size": 1 + }, + { + "status": "available", + "share_id": "406ea93b-32e9-4907-a117-148b3945749f", + "name": "snapshot_share1", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "bookmark" + } + ], + "created_at": "2015-09-07T11:50:39.000000", + "description": "Here is a snapshot of share Share1", + "share_proto": "NFS", + "share_size": 1, + "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb", + "size": 1 + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-list-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-list-response.json new file mode 100644 index 000000000..c8a0e1856 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-list-response.json @@ -0,0 +1,32 @@ +{ + "snapshots": [ + { + "id": "086a1aa6-c425-4ecd-9612-391a3b1b9375", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/086a1aa6-c425-4ecd-9612-391a3b1b9375", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/086a1aa6-c425-4ecd-9612-391a3b1b9375", + "rel": "bookmark" + } + ], + "name": "snapshot_My_share" + }, + { + "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "bookmark" + } + ], + "name": "snapshot_share1" + } + ] +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-show-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-show-response.json new file mode 100644 index 000000000..d5d9f92a1 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-show-response.json @@ -0,0 +1,23 @@ +{ + "snapshot": { + "status": "available", + "share_id": "406ea93b-32e9-4907-a117-148b3945749f", + "name": "snapshot_share1", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "bookmark" + } + ], + "created_at": "2015-09-07T11:50:39.000000", + "description": "Here is a snapshot of share Share1", + "share_proto": "NFS", + "share_size": 1, + "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb", + "size": 1 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-update-request.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-update-request.json new file mode 100644 index 000000000..261549cbc --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-update-request.json @@ -0,0 +1,6 @@ +{ + "snapshot": { + "display_name": "snapshot_Share1", + "display_description": "I am changing a description also. Here is a snapshot of share Share1" + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-update-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-update-response.json new file mode 100644 index 000000000..a888c9ccc --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-snapshot-update-response.json @@ -0,0 +1,23 @@ +{ + "snapshot": { + "status": "available", + "share_id": "406ea93b-32e9-4907-a117-148b3945749f", + "name": "snapshot_Share1", + "links": [ + { + "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "self" + }, + { + "href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", + "rel": "bookmark" + } + ], + "created_at": "2015-09-07T11:50:39.000000", + "description": "I am changing a description also. Here is a snapshot of share Share1", + "share_proto": "NFS", + "share_size": 1, + "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb", + "size": 1 + } +} diff --git a/api-ref/src/wadls/share-api/src/v2/samples/manila-versions-response.json b/api-ref/src/wadls/share-api/src/v2/samples/manila-versions-response.json new file mode 100644 index 000000000..b3d8055e8 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/samples/manila-versions-response.json @@ -0,0 +1,52 @@ +{ + "versions": [ + { + "status": "SUPPORTED", + "updated": "2015-08-27T11:33:21Z", + "links": [ + { + "href": "http://docs.openstack.org/", + "type": "text/html", + "rel": "describedby" + }, + { + "href": "http://172.18.198.54:8786/v1/", + "rel": "self" + } + ], + "min_version": "", + "version": "", + "media-types": [ + { + "base": "application/json", + "type": "application/vnd.openstack.share+json;version=1" + } + ], + "id": "v1.0" + }, + { + "status": "CURRENT", + "updated": "2015-08-27T11:33:21Z", + "links": [ + { + "href": "http://docs.openstack.org/", + "type": "text/html", + "rel": "describedby" + }, + { + "href": "http://172.18.198.54:8786/v2/", + "rel": "self" + } + ], + "min_version": "2.0", + "version": "2.6", + "media-types": [ + { + "base": "application/json", + "type": "application/vnd.openstack.share+json;version=1" + } + ], + "id": "v2.0" + } + ] +}