diff --git a/src/wadls/volume-api/src/os-volume-1.wadl b/src/wadls/volume-api/src/os-volume-1.wadl index 92dee10..91abd2b 100644 --- a/src/wadls/volume-api/src/os-volume-1.wadl +++ b/src/wadls/volume-api/src/os-volume-1.wadl @@ -18,12 +18,12 @@ --> - + - @@ -33,13 +33,13 @@ The unique identifier of an existing Volume.

- + - + - + @@ -56,12 +56,12 @@ - + - @@ -85,17 +85,17 @@

Creates the volume.

- - + + +-->

The below example creates a SATA volume called "vol-001" that has a size of 30 GB.

@@ -118,16 +118,16 @@

- The name of the volume. + The name of the volume.

- +

- Key and value metadata pairs defined by the admin. + Key and value metadata pairs defined by the admin.

- +

The optional snapshot from which to create a volume. @@ -139,12 +139,12 @@ then the default, SATA, is used.

- + - + - + @@ -164,14 +164,12 @@

- Note that you use the os-volume_attachments API call - (/servers/{server_id}/os-volume_attachments) to attach - the new volume to your Server (with - the specified {server_id}). + Note that you use the os-volume_attachments API call + (/servers/{server_id}/os-volume_attachments) to attach + the new volume to your Server (with + the specified {server_id}).

- - @@ -203,9 +201,9 @@ - + - + @@ -259,9 +257,9 @@

- Note that two storage types are currently supported: SATA - and SSD. SATA is the standard performance storage option - and SSD is the high performance option. + Note that two storage types are currently supported: SATA + and SSD. SATA is the standard performance storage option + and SSD is the high performance option.

@@ -272,7 +270,7 @@

Request a single Volume Type.

- + @@ -288,11 +286,11 @@ -

Create a Snapshot.

 - +

Creating a snapshot makes a point-in-time copy of the volume. All writes to the volume should be flushed before @@ -301,7 +299,7 @@ Snapshots are incremental, so each time you create a new snapshot, you are appending the incremental changes for the new snapshot to the previous one. The previous snapshot is still available. Note that you can - create a new volume from the snapshot if desired. + create a new volume from the snapshot if desired.

@@ -318,11 +316,11 @@

- [True/False] Indicate whether to snapshot, even if the volume is attached. + [True/False] Indicate whether to snapshot, even if the volume is attached. Default==False.

- +

Name of the snapshot. Default==None. @@ -335,8 +333,7 @@

- - + @@ -363,7 +360,7 @@ -

View a list of simple Snapshot entities. @@ -384,7 +381,7 @@ -

View a list of detailed Snapshot entities. @@ -406,7 +403,7 @@ -

View all information about a single Snapshot. @@ -427,7 +424,7 @@ -

Delete a single Snapshot.

 diff --git a/v1/src/openstack-blockstorage-devguide.xml b/v1/src/openstack-blockstorage-devguide.xml index 51db6f9..258a612 100644 --- a/v1/src/openstack-blockstorage-devguide.xml +++ b/v1/src/openstack-blockstorage-devguide.xml @@ -55,7 +55,7 @@ format="SVG" scale="60"/> This document is intended for software developers interested in developing applications - using the &PRODNAME; Application Programming Interface (API). + using the &PRODNAME; Application Programming Interface (API). @@ -101,7 +101,7 @@ format="SVG" scale="60"/> Intended Audience This Guide is intended to assist software developers who want to develop applications using the &APIv1;. It assumes the reader has a general understanding of storage and is - familiar with: + familiar with: ReSTful web services @@ -120,10 +120,10 @@ format="SVG" scale="60"/>
Additional Resources You can download the most current versions of the API-related documents from docs.openstack.org/api/. + xlink:href="http://docs.openstack.org/api/">docs.openstack.org/api/. This API uses standard HTTP 1.1 response codes as documented at: www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. + >www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
volumes to their OpenStack Compute servers. The two primary use cases are (1) to allow customers to scale their storage independently from their compute resources, and (2) to allow customers to utilize high performance storage to serve database or I/O-intensive - applications. + applications. Interactions with Block Storage occur programmatically via the Block Storage API as - described in this Developer Guide. + described in this Developer Guide. Highlights of &PRODNAME; include: Mount a drive to a Compute server to scale storage without paying for more compute @@ -163,11 +163,11 @@ format="SVG" scale="60"/>
Glossary - To use the Block Storage API effectively, you should understand several key concepts: + To use the Block Storage API effectively, you should understand several key concepts:
Volume A volume is a detachable block storage device. You can think of it as a USB hard - drive. It can only be attached to one instance at a time. + drive. It can only be attached to one instance at a time.
Snapshot @@ -177,10 +177,10 @@ format="SVG" scale="60"/> Volume Type The volume type is the type of a block storage volume. You may define whatever types work best for you, such as SATA, SCSCI, SSD, etc. These can be customized or defined by - the OpenStack admin. - You may also define extra_specs associated with your volume types. For instance, you + the OpenStack admin. + You may also define extra_specs associated with your volume types. For instance, you could have a VolumeType=SATA, with extra_specs (RPM=10000, RAID-Level=5) . Extra_specs are - defined and customized by the admin. + defined and customized by the admin.
Instance @@ -215,20 +215,20 @@ format="SVG" scale="60"/> General API Information -
Authentication - You can use cURL to try the + You can use cURL to try the authentication process in two steps: get a token; send the token to a service. Get an authentication token by providing your username and either your API key or @@ -238,11 +238,11 @@ format="SVG" scale="60"/> curl -X POST https://auth.api.openstackcloud.com/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}}' -H 'Content-type: application/json' - Successful authentication returns a token which you can use as evidence that your + Successful authentication returns a token which you can use as evidence that your identity has already been authenticated. To use the token, pass it to other services - as an X-Auth-Token header. - Authentication also returns a service catalog, listing the endpoints you can use - for Cloud services. + as an X-Auth-Token header. + Authentication also returns a service catalog, listing the endpoints you can use + for Cloud services. Use the authentication token to send a GET to a service you would like to use. @@ -251,12 +251,12 @@ format="SVG" scale="60"/> Authentication tokens are typically valid for 24 hours. Applications should be designed - to re-authenticate after receiving a 401 (Unauthorized) response from a service endpoint. + to re-authenticate after receiving a 401 (Unauthorized) response from a service endpoint. If you are programmatically parsing an authentication response, please be aware that service names are stable for the life of the particular service and can be used as keys. You should also be aware that a user's service catalog can include multiple uniquely-named - services which perform similar functions. + services which perform similar functions.
@@ -270,7 +270,7 @@ format="SVG" scale="60"/> default. If conflicting formats are specified using both an Accept header and a query extension, the query extension takes precedence. Some operations support an Atom representation that can be used to - efficiently determine when the state of services has changed. + efficiently determine when the state of services has changed. @@ -333,21 +333,21 @@ format="SVG" scale="60"/>
Limits - All accounts, by default, have a preconfigured set of thresholds (or limits) to manage + All accounts, by default, have a preconfigured set of thresholds (or limits) to manage capacity and prevent abuse of the system. The system recognizes two kinds of limits: rate limits and absolute limits. Rate limits are thresholds that are reset after a certain amount of time passes. Absolute limits are - fixed. + fixed.
Rate Limits - Rate limits are specified in terms of both a human-readable wild-card URI and a + Rate limits are specified in terms of both a human-readable wild-card URI and a machine-processable regular expression. The regular expression boundary matcher '^' takes effect after the root URI path. For example, the regular expression ^/v1.0/instances would match the bolded portion of the following URI: https://dfw.blockstorage.api.openstackcloud.com/v1.0/instances. + >/v1.0/instances. The following table specifies the default rate limits for all API operations for all - &GET;, &POST;, &PUT;, and &DELETE; calls for volumes: + &GET;, &POST;, &PUT;, and &DELETE; calls for volumes:
Response Formats
@@ -391,12 +391,12 @@ format="SVG" scale="60"/>
Default Rate Limits
- Rate limits are applied in order relative to the verb, going from least to most + Rate limits are applied in order relative to the verb, going from least to most specific. For example, although the threshold for &POST; to /v1.0/* is 10 per minute, one - cannot &POST; to /v1.0/* more than 50 times within a single day. - If you exceed the thresholds established for your account, a 413 (Rate + cannot &POST; to /v1.0/* more than 50 times within a single day. + If you exceed the thresholds established for your account, a 413 (Rate Control) HTTP response will be returned with a Retry-After - header to notify the client when it can attempt to try again. + header to notify the client when it can attempt to try again.
Absolute Limits @@ -416,7 +416,7 @@ format="SVG" scale="60"/> Block Storage - Maximum amount of block storage (in gigabytes) + Maximum amount of block storage (in gigabytes) 1 TB @@ -425,8 +425,8 @@ format="SVG" scale="60"/>
Date/Time Format - The Block Storage Service uses an ISO-8601 compliant date format for the display and - consumption of date/time values. + The Block Storage Service uses an ISO-8601 compliant date format for the display and + consumption of date/time values. DB Service Date/Time Format yyyy-MM-dd'T'HH:mm:ss.SSSZ @@ -485,9 +485,9 @@ format="SVG" scale="60"/>
Faults - When an error occurs, the Block Storage Service returns a fault object containing an + When an error occurs, the Block Storage Service returns a fault object containing an HTTP error response code that denotes the type of error. In the body of the response, the - system will return additional information about the fault. + system will return additional information about the fault. The following table lists possible fault types with their associated error codes and descriptions. @@ -562,7 +562,7 @@ format="SVG" scale="60"/> - The following two instanceFault examples show errors when the server has + The following two instanceFault examples show errors when the server has erred or cannot perform the requested operation: Example instanceFault Response: XML @@ -578,14 +578,14 @@ format="SVG" scale="60"/> - The error code (code) is returned in the body of the response for + The error code (code) is returned in the body of the response for convenience. The message element returns a human-readable message that is appropriate for display to the end user. The details element is optional and may contain information that is useful for tracking down an error, such as a stack trace. The details element may or may not be appropriate for display to an end user, depending on the role and experience of the end user. The fault's root element (for example, instanceFault) may change depending - on the type of error. + on the type of error. The following two badRequest examples show errors when the volume size is invalid: @@ -602,7 +602,7 @@ format="SVG" scale="60"/> - The next two examples show itemNotFound errors: + The next two examples show itemNotFound errors: Example itemNotFound Fault: XML @@ -749,7 +749,7 @@ Accept: application/json &GET; /volumes Lists a summary of all volumes defined in Cinder that are accessible to the tenant - who submits the request. + who submits the request. @@ -788,7 +788,7 @@ Accept: application/json &GET; /volumes/details List detailed information of all volumes defined in Cinder that are accessible to - the tenant who submits the request. + the tenant who submits the request. @@ -824,7 +824,7 @@ Accept: application/json &GET; /volumes/volume-id - Lists detailed information for the specified volume ID. + Lists detailed information for the specified volume ID. @@ -1000,7 +1000,7 @@ The response body will be empty with status code 202. &GET; /snapshots Lists a summary of all snapshots defined in Cinder that are accessible to the - tenant who submits the request. + tenant who submits the request. @@ -1038,7 +1038,7 @@ Accept: application/json &GET; /snapshots/details List detailed information of all snapshots defined in Cinder that are accessible - to the tenant who submits the request. + to the tenant who submits the request. @@ -1074,7 +1074,7 @@ Accept: application/json &GET; /snapshots/snapshot-id - Lists detailed information for the specified snapshot ID. + Lists detailed information for the specified snapshot ID. diff --git a/v1/src/samples/os-volume-1.wadl b/v1/src/samples/os-volume-1.wadl index 6e4b362..029e275 100644 --- a/v1/src/samples/os-volume-1.wadl +++ b/v1/src/samples/os-volume-1.wadl @@ -18,12 +18,12 @@ --> - + - @@ -33,13 +33,13 @@ The unique identifier of an existing Volume.

- + - + - + @@ -61,7 +61,7 @@ - @@ -85,17 +85,16 @@

Creates the volume.

- - + +-->

The below example creates a SATA volume called "vol-001" that has a size of 30 GB.

@@ -118,7 +117,7 @@

- The name of the volume. + The name of the volume.

@@ -132,12 +131,12 @@ then the default, SATA, is used.

- + - + - + @@ -157,19 +156,16 @@

- Note that you use the os-volume_attachments API call - (/servers/{server_id}/os-volume_attachments) to attach - the new volume to your Next Generation Compute Server (with - the specified {server_id}). - Refer to the Next Generation Compute Servers Developer Guide - at docs.rackspace.com for details - of the call. Once the volume is attached, the new volume will appear - as another device on the Next Generation Compute Server. It can - then be partitioned, formatted, and mounted for use on the system. + Note that you use the os-volume_attachments API call + (/servers/{server_id}/os-volume_attachments) to attach + the new volume to your Next Generation Compute Server (with + the specified {server_id}). + Refer to the Next Generation Compute Servers Developer Guide + at docs.rackspace.com for details + of the call. Once the volume is attached, the new volume will appear + as another device on the Next Generation Compute Server. It can + then be partitioned, formatted, and mounted for use on the system.

- - - @@ -201,9 +197,9 @@ - + - + @@ -257,9 +253,9 @@

- Note that two storage types are currently supported: SATA - and SSD. SATA is the standard performance storage option - and SSD is the high performance option. + Note that two storage types are currently supported: SATA + and SSD. SATA is the standard performance storage option + and SSD is the high performance option.

@@ -270,7 +266,7 @@

Request a single Volume Type.

- + @@ -286,11 +282,11 @@ -

Create a Snapshot.

 - +

Creating a snapshot makes a point-in-time copy of the volume. All writes to the volume should be flushed before @@ -299,7 +295,7 @@ Snapshots are incremental, so each time you create a new snapshot, you are appending the incremental changes for the new snapshot to the previous one. The previous snapshot is still available. Note that you can - create a new volume from the snapshot if desired. + create a new volume from the snapshot if desired.

@@ -316,11 +312,11 @@

- [True/False] Indicate whether to snapshot, even if the volume is attached. + [True/False] Indicate whether to snapshot, even if the volume is attached. Default==False.

- +

Name of the snapshot. Default==None. @@ -333,8 +329,7 @@

- - + @@ -361,7 +356,7 @@ -

View a list of simple Snapshot entities. @@ -382,7 +377,7 @@ -

View a list of detailed Snapshot entities. @@ -404,7 +399,7 @@ -

View all information about a single Snapshot. @@ -425,7 +420,7 @@ -

Delete a single Snapshot.

 diff --git a/v2/src/openstack-blockstorage-devguide.xml b/v2/src/openstack-blockstorage-devguide.xml index bb28920..c5867a1 100644 --- a/v2/src/openstack-blockstorage-devguide.xml +++ b/v2/src/openstack-blockstorage-devguide.xml @@ -145,7 +145,7 @@ format="SVG" scale="60"/> Intended Audience This guide assists software developers who develop applications by using the &API;. It assumes the reader has a - general understanding of storage and is familiar with: + general understanding of storage and is familiar with: ReSTful web services @@ -165,7 +165,7 @@ format="SVG" scale="60"/> Additional Resources You can download the latest API-related documents from docs.openstack.org/api/. + >docs.openstack.org/api/. This API uses standard HTTP 1.1 response codes as documented at: You interact with Block Storage programmatically through the - Block Storage API as described in this guide. + Block Storage API as described in this guide. @@ -217,8 +217,8 @@ format="SVG" scale="60"/>
Glossary - To use the Block Storage API effectively, you should - understand several key concepts: + To use the Block Storage API effectively, you should + understand several key concepts: Volume @@ -231,13 +231,13 @@ format="SVG" scale="60"/> A type of a block storage volume. You can define whatever types work best for you, such as SATA, SCSCI, SSD, etc. These can be customized or defined by the - OpenStack admin. + OpenStack admin. You can also define extra_specs associated with your volume types. For instance, you could have a VolumeType=SATA, with extra_specs (RPM=10000, RAID-Level=5) . Extra_specs are defined and customized by - the admin. + the admin. Snapshot @@ -295,11 +295,11 @@ format="SVG" scale="60"/> The Block Storage API is implemented using a ReSTful web service interface. Like other OpenStack projects, Block Storage shares a common token-based authentication system that allows - access between products and services. + access between products and services. All requests to authenticate against and operate the service are performed using SSL over HTTP (HTTPS) on TCP port - 443. + 443.
@@ -319,28 +319,28 @@ format="SVG" scale="60"/> Successful authentication returns a token which you can use as evidence that your identity has already been authenticated. To use the token, pass it to other - services as an X-Auth-Token header. + services as an X-Auth-Token header. Authentication also returns a service catalog, listing the endpoints you can use for Cloud services. Use the authentication token to send a GET to a - service you would like to use. + service you would like to use. Authentication tokens are typically valid for 24 hours. Applications should be designed to re-authenticate after receiving a 401 (Unauthorized) response from a service - endpoint. + endpoint. If you programmatically parse an authentication response, be aware that service names are stable for the life of the particular service and can be used as keys. You should also be aware that a user's service catalog can include multiple uniquely-named services that perform - similar functions. + similar functions.
@@ -359,7 +359,7 @@ format="SVG" scale="60"/> extension takes precedence. Some operations support an Atom representation that can be used to efficiently determine when - the state of services has changed. + the state of services has changed. @@ -427,20 +427,20 @@ X-Compute-Request-Id: req-8e0295cd-a283-46e4-96da-cae05cbfd1c7 rate limits and absolute limits. Rate limits are thresholds that are reset after a certain amount of time passes. Absolute limits - are fixed. + are fixed.
Rate Limits - Rate limits are specified in terms of both a + Rate limits are specified in terms of both a human-readable wild-card URI and a machine-processable regular expression. The regular expression boundary matcher '^' takes effect after the root URI path. For example, the regular expression ^/v1.0/instances would match the bolded portion of the following URI: https://dfw.blockstorage.api.openstackcloud.com/v1.0/instances. + role="bold">/v1.0/instances. The following table specifies the default rate limits for all API operations for all &GET;, &POST;, &PUT;, and - &DELETE; calls for volumes: + &DELETE; calls for volumes:
Response Formats
@@ -484,15 +484,15 @@ X-Compute-Request-Id: req-8e0295cd-a283-46e4-96da-cae05cbfd1c7
Default Rate Limits
- Rate limits are applied in order relative to the verb, + Rate limits are applied in order relative to the verb, going from least to most specific. For example, although the threshold for &POST; to /v1.0/* is 10 per minute, one cannot - &POST; to /v1.0/* more than 50 times within a single day. - If you exceed the thresholds established for your + &POST; to /v1.0/* more than 50 times within a single day. + If you exceed the thresholds established for your account, a 413 (Rate Control) HTTP response will be returned with a Retry-After header to notify the client when it can attempt to try - again. + again.
Absolute Limits @@ -512,7 +512,7 @@ X-Compute-Request-Id: req-8e0295cd-a283-46e4-96da-cae05cbfd1c7 Block Storage - Maximum amount of block storage (in GBs) + Maximum amount of block storage (in GBs) 1 TB @@ -522,7 +522,7 @@ X-Compute-Request-Id: req-8e0295cd-a283-46e4-96da-cae05cbfd1c7
Date/Time Format The Block Storage Service uses an ISO-8601 compliant date - format for the display and consumption of date/time values. + format for the display and consumption of date/time values. DB Service Date/Time Format yyyy-MM-dd'T'HH:mm:ss.SSSZ @@ -582,10 +582,10 @@ X-Compute-Request-Id: req-8e0295cd-a283-46e4-96da-cae05cbfd1c7
Faults - When an error occurs, the Block Storage Service returns a + When an error occurs, the Block Storage Service returns a fault object containing an HTTP error response code that denotes the type of error. In the body of the response, the - system will return additional information about the fault. + system will return additional information about the fault. The following table lists possible fault types with their associated error codes and descriptions. @@ -693,7 +693,7 @@ X-Compute-Request-Id: req-8e0295cd-a283-46e4-96da-cae05cbfd1c7 experience of the end user. The fault's root element (for example, instanceFault) may change depending on the type - of error. + of error. The following two badRequest examples show errors when the volume size is invalid: @@ -709,7 +709,7 @@ X-Compute-Request-Id: req-8e0295cd-a283-46e4-96da-cae05cbfd1c7 - The next two examples show itemNotFound + The next two examples show itemNotFound errors: Example itemNotFound Fault: XML @@ -871,7 +871,7 @@ Accept: application/json &GET; /volumes Lists volumes defined in Block Storage that the - tenant who submits the request can access. + tenant who submits the request can access. @@ -940,7 +940,7 @@ Accept: application/json &GET; /volumes/volume-id Lists detailed information for the specified volume - ID. + ID. @@ -1104,7 +1104,7 @@ Accept: application/json &GET; /snapshots Lists snapshots defined in Block Storage that the - tenant who submits the request can access. + tenant who submits the request can access. @@ -1139,7 +1139,7 @@ Accept: application/json /snapshots/details Lists detailed information for snapshots defined in Block Storage that the tenant who submits the request - can access. + can access. @@ -1173,7 +1173,7 @@ Accept: application/json &GET; /snapshots/snapshot-id Lists detailed information for a specified snapshot - ID. + ID. @@ -1328,7 +1328,7 @@ Accept: application/json
Extensions The Block Storage API is extensible. Extensions are - add-ons to the API that enable new features. + add-ons to the API that enable new features.
Backups A backup is a full copy of a volume stored in an @@ -1338,7 +1338,7 @@ Accept: application/json the same volume that the backup was originally taken from, or to a new volume. Backup and restore operations can only be carried out on volumes which are in an unattached and - available state. + available state. When making an API call to create, list, or delete backup(s), the following status values are possible: @@ -1470,7 +1470,7 @@ Accept: application/json &GET; /backups Lists backups defined in Block Storage that the - tenant who submits the request can access. + tenant who submits the request can access. @@ -1505,7 +1505,7 @@ Accept: application/json /backups/details Lists detailed information for backups defined in Block Storage that the tenant who submits the - request can access. + request can access. @@ -1539,7 +1539,7 @@ Accept: application/json &GET; /backups/backup-id Lists detailed information for a specified backup - ID. + ID. diff --git a/v2/src/samples/volume_list_simple_response.xml b/v2/src/samples/volume_list_simple_response.xml index 8d579f8..88bcabf 100644 --- a/v2/src/samples/volume_list_simple_response.xml +++ b/v2/src/samples/volume_list_simple_response.xml @@ -1,6 +1,6 @@ -