From 0da6b9a5be38ed769e57d54782b0ec5742930bce Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 31 Jan 2014 20:26:50 +0100 Subject: [PATCH] Add xml:ids to resources MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add xml:ids to resources. This is a new requirement that has to do with the generation of PDFs from WADL files – without this, the paths are not unique across WADL files Remove files v1/src/samples/os-volume-1.wadl and v2/src/samples/os-volume-1.wadl which are not needed in the samples directory - instead of adding xml:ids to them. Change-Id: Idf0cd1aef4c7c65c2f09688a8163bb08d3dbf37f Related-Bug: #1275007 --- src/wadls/volume-api/src/os-volume-1.wadl | 3 +- v1/src/samples/os-volume-1.wadl | 430 ------------------ v2/src/samples/os-volume-1.wadl | 525 ---------------------- 3 files changed, 2 insertions(+), 956 deletions(-) delete mode 100644 v1/src/samples/os-volume-1.wadl delete mode 100644 v2/src/samples/os-volume-1.wadl diff --git a/src/wadls/volume-api/src/os-volume-1.wadl b/src/wadls/volume-api/src/os-volume-1.wadl index 3f1b138..c83220f 100644 --- a/src/wadls/volume-api/src/os-volume-1.wadl +++ b/src/wadls/volume-api/src/os-volume-1.wadl @@ -6,7 +6,8 @@ xmlns:xsdxt="http://docs.openstackcloud.com/xsd-ext/v1.0" xmlns:wadl="http://wadl.dev.java.net/2009/02"> - + - - - - - - - - - - - - - - - - - - - -

- The unique identifier of an existing Volume. -

- - - - - - - - - - - - - - -

- The unique identifier of an existing Volume Type. -

- - - - - - - - - - - - - - - - - -

- The unique identifier of an existing Snapshot. -

- - - - - - - - - - - - - - -

Creates the volume.

- - -

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

- - - -

- A partial representation of a volume used in the creation process. -

- - -

- The size (in GB) of the volume. -

- - -

- A description of the volume. -

- - -

- The name of the volume. -

- - -

- The optional snapshot from which to create a volume. -

- - -

- The type of volume to create, either SATA or SSD. If not defined, - then the default, SATA, is used. -

- - - - - - - - - - - - - - - - - - - - - - - - - -

- 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. -

- - - - - - -

View a list of volumes.

- - - - - - - - - - - - - - - - - -

View a list of detailed Volume entities.

- - - - - - - - - - - - - - - - - - - - -

View all information about a single Volume.

- - - - - - - - - - - - - - - - - - - - -

Delete a single Volume.

- - - - - - -

Request a list of Volume Types.

- - - - - - - - - - - -

- 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. -

- - - - - - -

Request a single Volume Type.

- - - - - - - - - - - - - - - - - - - -

Create a Snapshot.

- - -

- Creating a snapshot makes a point-in-time copy of the - volume. All writes to the volume should be flushed before - creating the snapshot, either by un-mounting any file systems on the - volume, or by detaching the volume before creating the snapshot. - 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. -

- - -

- A partial representation of a snapshot used in the creation process. -

- - - -

- The ID of the volume to snapshot. -

- - - -

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

- - - -

- Name of the snapshot. Default==None. -

- - - -

- Description of snapshot. Default==None. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- View a list of simple Snapshot entities. -

- - - - - - - - - - - - - - - - - -

- View a list of detailed Snapshot entities. -

- - - - - - - - - - - - - - - - - - -

- View all information about a single Snapshot. -

- - - - - - - - - - - - - - - - - -

Delete a single Snapshot.

- - - - - diff --git a/v2/src/samples/os-volume-1.wadl b/v2/src/samples/os-volume-1.wadl deleted file mode 100644 index 60a5814..0000000 --- a/v2/src/samples/os-volume-1.wadl +++ /dev/null @@ -1,525 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - -

- The unique identifier of an existing Volume. -

- - - - - - - - - - - - - - - -

- The unique identifier of an existing Volume Type. -

- - - - - - - - - - - - - - - - - -

- The unique identifier of an existing Snapshot. -

- - - - - - - - - - - - - - - -

Creates the volume.

- - - -

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

- - - -

- A partial representation of a volume used in the creation process. -

- - -

- The size (in GB) of the volume. -

- - -

- A description of the volume. -

- - -

- The name of the volume. -

- - -

- The optional snapshot from which to create a volume. -

- - -

- The type of volume to create, either SATA or SSD. If not defined, - then the default, SATA, is used. -

- - - - - - - - - - - - - - - - - - - - - - - - - -

- 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. -

- - - - - - -

View a list of volumes.

- - - - - - - - - - - - - - - - - -

View a list of detailed Volume entities.

- - - - - - - - - - - - - - - - - - - - -

View all information about a single Volume.

- - - - - - - - - - - - - - - - - - - -

Update a volume.

-

- The below example updates a volume's name to "vol-003" with a description "This is yet, another snapshot.". -

- - - -

- A description of the volume. -

- - -

- The name of the volume. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Delete a single Volume.

- - - - - - -

Request a list of Volume Types.

- - - - - - - - - - - -

- 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. -

- - - - - - -

Request a single Volume Type.

- - - - - - - - - - - - - - - - - - - -

Create a Snapshot.

- - -

- Creating a snapshot makes a point-in-time copy of the - volume. All writes to the volume should be flushed before - creating the snapshot, either by un-mounting any file systems on the - volume, or by detaching the volume before creating the snapshot. - 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. -

- - -

- A partial representation of a snapshot used in the creation process. -

- - - -

- The ID of the volume to snapshot. -

- - - -

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

- - - -

- Name of the snapshot. Default==None. -

- - - -

- Description of snapshot. Default==None. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- View a list of simple Snapshot entities. -

- - - - - - - - - - - - - - - - - -

- View a list of detailed Snapshot entities. -

- - - - - - - - - - - - - - - - - - -

- View all information about a single Snapshot. -

- - - - - - - - - - - - - - - - - -

Update a snapshot.

-

- The below example updates a snapshots's name to "snap-002" with a description "This is yet, another snapshot.". -

- - - -

- A description of the snapshot. -

- - -

- The name of the snapshot. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Delete a single Snapshot.

- - - - -