openstack-attic/volume-api
Code Issues Proposed changes

Clean up unneeded files and create parent pom.xml file

Browse Source 
Change-Id: I3dbaeb584ca461ab949d42d9a05449f559ff3891
author: diane fleming
This commit is contained in:
Diane Fleming 2014-05-14 12:09:08 -05:00
parent 613e62ac0e
commit 61af68a428
29 changed files with 439 additions and 1275 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
pom.xml Normal file
View File

@ -0,0 +1,48 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>v1</module>
<module>v2</module>
</modules>
<profiles>
<profile>
<id>Rackspace Research Repositories</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<build>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.15.0</version>
</plugin>
</plugins>
</build>
</project>

68
v1/pom.xml
View File

@ -1,31 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>org.openstack.docs</groupId>
<artifactId>openstack-block-storage-api-guide</artifactId>
<version>1.0.0-SNAPSHOT</version>
<artifactId>openstack-v1</artifactId>
<packaging>jar</packaging>
<name>OpenStack Block Storage Service Developer Guide v1.0</name>
<name>OpenStack Block Storage API v1 Reference</name>
<properties>
<!-- This is set by Jenkins according to the branch. -->
<release.path.name>local</release.path.name>
<comments.enabled>1</comments.enabled>
</properties>
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<build>
<sourceDirectory>src</sourceDirectory>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.15.0</version>
<!-- <version>1.15.0</version>-->
<!-- version is in ../pom.xml -->
<executions>
<execution>
<id>generate-webhelp</id>
@ -43,24 +44,23 @@
appendix toc,title
article/appendix nop
article toc,title
book title,figure,table,example,equation
chapter toc,title
book toc,title,figure,table,example,equation
chapter toc
section toc
part toc,title
preface toc,title
preface toc
qandadiv toc
qandaset toc
reference toc,title
set toc,title
</generateToc>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<!--<sectionAutolabel>0</sectionAutolabel>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>-->
<chapterAutolabel>1</chapterAutolabel>
<sectionAutolabel>0</sectionAutolabel>
<tocSectionDepth>1</tocSectionDepth>
<webhelpDirname>1.0</webhelpDirname>
<targetDirectory>${basedir}/target/docbkx/webhelp/api/openstack-block-storage</targetDirectory>
<includeDateInPdfFilename>0</includeDateInPdfFilename>
<pdfFilenameBase>openstack-blockstorage-devguide-1.0</pdfFilenameBase>
</configuration>
</execution>
<execution>
@ -81,7 +81,6 @@
</postProcess>
</configuration>
</execution>
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->
@ -94,29 +93,6 @@
<branding>openstack</branding>
</configuration>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>Rackspace Research Repositories</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
</project>

1150
v1/src/openstack-blockstorage-devguide.xml
View File

File diff suppressed because it is too large Load Diff

8
v1/src/samples/snapshot_create_request.json
View File

@ -1,8 +0,0 @@
{
"snapshot": {
"display_name": "snap-001",
"display_description": "Daily backup",
"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"force": true
}
}

11
v1/src/samples/snapshot_create_response.json
View File

@ -1,11 +0,0 @@
{
"snapshot": {
"created_at": "2013-02-19T00:24:54.179025",
"display_description": "Daily backup",
"display_name": "snap-001",
"id": "2d843196-eff1-4a0c-980e-10fee5df2bea",
"size": 10,
"status": "creating",
"volume_id": "da450d0c-0920-4785-80dd-b024515200ce"
}
}

22
v1/src/samples/snapshot_list_detail_response.json
View File

@ -1,22 +0,0 @@
{
"snapshots": [
{
"id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
"display_name": "snap-001",
"display_description": "Daily backup",
"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"status": "available",
"size": 10,
"created_at": "2012-02-29T03:50:07Z"
},
{
"id": "e479997c-650b-40a4-9dfe-77655818b0d2",
"display_name": "snap-002",
"display_description": "Weekly backup",
"volume_id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
"status": "available",
"size": 25,
"created_at": "2012-03-19T01:52:47Z"
}
]
}

22
v1/src/samples/snapshot_list_simple_response.json
View File

@ -1,22 +0,0 @@
{
"snapshots": [
{
"id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
"display_name": "snap-001",
"display_description": "Daily backup",
"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"status": "available",
"size": 10,
"created_at": "2012-02-29T03:50:07Z"
},
{
"id": "e479997c-650b-40a4-9dfe-77655818b0d2",
"display_name": "snap-002",
"display_description": "Weekly backup",
"volume_id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
"status": "available",
"size": 25,
"created_at": "2012-03-19T01:52:47Z"
}
]
}

11
v1/src/samples/snapshot_show_response.json
View File

@ -1,11 +0,0 @@
{
"snapshot": {
"id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
"display_name": "snap-001",
"display_description": "Daily backup",
"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"status": "creating",
"size": 30,
"created_at": "2012-02-29T03:50:07Z"
}
}

6
v1/src/samples/snapshot_update_request.json
View File

@ -1,6 +0,0 @@
{
"snapshot":{
"display_name":"snap-002",
"display_description":"This is yet, another snapshot."
}
}

11
v1/src/samples/snapshot_update_response.json
View File

@ -1,11 +0,0 @@
{
"snapshot": {
"created_at": "2013-02-20T08:11:34.000000",
"display_description": "This is yet, another snapshot",
"display_name": "vol-002",
"id": "4b502fcb-1f26-45f8-9fe5-3b9a0a52eaf2",
"size": 1,
"status": "available",
"volume_id": "2402b902-0b7a-458c-9c07-7435a826f794"
}
}

10
v1/src/samples/volume_create_request.json
View File

@ -1,10 +0,0 @@
{
"volume": {
"display_name": "vol-001",
"display_description": "Another volume.",
"size": 30,
"volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata": {"contents": "junk"},
"availability_zone": "us-east1"
}
}

19
v1/src/samples/volume_create_response.json
View File

@ -1,19 +0,0 @@
{
"volume": {
"attachments": [],
"availability_zone": "us-east1",
"bootable": "false",
"created_at": "2013-02-20T07:36:44.893964",
"display_description": "Another volume.",
"display_name": "vol-001",
"id": "2402b902-0b7a-458c-9c07-7435a826f794",
"metadata": {
"contents": "junk"
},
"size": 30,
"snapshot_id": null,
"source_volid": null,
"status": "creating",
"volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164"
}
}

38
v1/src/samples/volume_list_detail_response.json
View File

@ -1,38 +0,0 @@
{
"volumes": [
{
"attachments": [],
"availability_zone": "us-east1",
"bootable": "false",
"created_at": "2013-02-18T23:47:37.000000",
"display_description": "yet another volume",
"display_name": "vol-002",
"id": "dfd9dd41-1353-450a-b5ac-a6037ee43cd8",
"metadata": {
"contents": "some more junk"
},
"size": 30,
"snapshot_id": null,
"source_volid": null,
"status": "available",
"volume_type": "SATA"
},
{
"attachments": [],
"availability_zone": "us-east1",
"bootable": "false",
"created_at": "2013-02-18T23:44:47.000000",
"display_description": "another volume",
"display_name": "vol-001",
"id": "da450d0c-0920-4785-80dd-b024515200ce",
"metadata": {
"contents": "junk"
},
"size": 10,
"snapshot_id": null,
"source_volid": null,
"status": "available",
"volume_type": "SATA"
}
]
}

38
v1/src/samples/volume_list_simple_response.json
View File

@ -1,38 +0,0 @@
{
"volumes": [
{
"attachments": [],
"availability_zone": "us-east1",
"bootable": "false",
"created_at": "2013-02-18T23:47:37.000000",
"display_description": "yet another volume",
"display_name": "vol-002",
"id": "dfd9dd41-1353-450a-b5ac-a6037ee43cd8",
"metadata": {
"contents": "some more junk"
},
"size": 30,
"snapshot_id": null,
"source_volid": null,
"status": "available",
"volume_type": "SATA"
},
{
"attachments": [],
"availability_zone": "us-east1",
"bootable": "false",
"created_at": "2013-02-18T23:44:47.000000",
"display_description": "another volume",
"display_name": "vol-001",
"id": "da450d0c-0920-4785-80dd-b024515200ce",
"metadata": {
"contents": "junk"
},
"size": 10,
"snapshot_id": null,
"source_volid": null,
"status": "available",
"volume_type": "SATA"
}
]
}

21
v1/src/samples/volume_show_response.json
View File

@ -1,21 +0,0 @@
{
"volume": {
"attachments": [],
"availability_zone": "nova",
"bootable": "false",
"created_at": "2013-02-20T07:36:44.000000",
"display_description": "another volume foo",
"display_name": "vol-002",
"id": "2402b902-0b7a-458c-9c07-7435a826f794",
"metadata": {
"content": "junk"
},
"os-vol-host-attr:host": "precise64",
"os-vol-tenant-attr:tenant_id": "dee102070e654627a1f96acc5dcad496",
"size": 1,
"snapshot_id": null,
"source_volid": null,
"status": "available",
"volume_type": "None"
}
}

14
v1/src/samples/volume_type_list_response.json
View File

@ -1,14 +0,0 @@
{
"volume_types": [
{
"extra_specs": {},
"id": "6685584b-1eac-4da6-b5c3-555430cf68ff",
"name": "SSD"
},
{
"extra_specs": {},
"id": "8eb69a46-df97-4e41-9586-9a40a7533803",
"name": "SATA"
}
]
}

9
v1/src/samples/volume_type_show_response.json
View File

@ -1,9 +0,0 @@
{
"volume_type":{
"id":"6685584b-1eac-4da6-b5c3-555430cf68ff",
"name":"SSD",
"extra_specs":{
}
}
}

9
v1/src/samples/volume_update_request.json
View File

@ -1,9 +0,0 @@
{
"volume":{
"display_name":"vol-002",
"display_description":"This is yet, another volume.",
"metadata":{
"contents":"junk"
}
}
}

19
v1/src/samples/volume_update_response.json
View File

@ -1,19 +0,0 @@
{
"volume": {
"attachments": [],
"availability_zone": "nova",
"bootable": "false",
"created_at": "2013-02-20T07:36:44.000000",
"display_description": "This is yet, another volume.",
"display_name": "vol-002",
"id": "2402b902-0b7a-458c-9c07-7435a826f794",
"metadata": {
"tier": "1"
},
"size": 1,
"snapshot_id": null,
"source_volid": null,
"status": "available",
"volume_type": "None"
}
}

58
v2/pom.xml
View File

@ -1,31 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>org.openstack.docs</groupId>
<artifactId>openstack-block-storage-api-guide</artifactId>
<version>2.0.0</version>
<artifactId>openstack-v2</artifactId>
<packaging>jar</packaging>
<name>OpenStack Block Storage Service API Guide v2</name>
<name>OpenStack Block Storage API v2 and Extensions Reference</name>
<properties>
<!-- This is set by Jenkins according to the branch. -->
<release.path.name>local</release.path.name>
<comments.enabled>1</comments.enabled>
</properties>
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<build>
<sourceDirectory>src</sourceDirectory>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.15.0</version>
<!-- <version>1.15.0</version>-->
<!-- version is in ../pom.xml -->
<executions>
<execution>
<id>generate-webhelp</id>
@ -56,15 +57,10 @@
<chapterAutolabel>1</chapterAutolabel>
<sectionAutolabel>0</sectionAutolabel>
<tocSectionDepth>1</tocSectionDepth>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<!--<sectionAutolabel>0</sectionAutolabel>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>-->
<webhelpDirname>2.0</webhelpDirname>
<targetDirectory>${basedir}/target/docbkx/webhelp/api/openstack-block-storage</targetDirectory>
<includeDateInPdfFilename>0</includeDateInPdfFilename>
<pdfFilenameBase>openstack-blockstorage-devguide-2.0</pdfFilenameBase>
</configuration>
</execution>
<execution>
@ -85,7 +81,6 @@
</postProcess>
</configuration>
</execution>
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->
@ -98,29 +93,6 @@
<branding>openstack</branding>
</configuration>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>Rackspace Research Repositories</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
</project>

12
v2/src/openstack-blockstorage-devguide.xml
View File

@ -1,10 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
@ -14,19 +9,12 @@
<!ENTITY API 'Block Storage API v2.0'>
<!ENTITY VERSION 'v2'>
<!ENTITY PRODABBV "">
<!-- changing authentication endpoints; define entities for US & UK rather than maintaining in text -->
<!ENTITY ENDPOINT-US "https://auth.api.openstackcloud.com/v2.0/">
<!ENTITY ENDPOINT-UK "https://lon.identity.api.openstackcloud.com/v1.1/">
<!ENTITY CHECK '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
<imageobject>
<imagedata fileref="img/Check_mark_23x20_02.svg"
format="SVG" scale="60"/>
</imageobject>
</inlinemediaobject>'>
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
<imageobject>
<imagedata fileref="img/Arrow_east.svg"

6
v2/src/samples/snapshot_create_request.xml
View File

@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<snapshot xmlns="http://docs.openstack.org/openstack-block-storage/2.0/content"
name="snap-001"
description="Daily backup"
volume_id="5aa119a8-d25b-45a7-8d1b-88e127885635"
force="true" />

11
v2/src/samples/snapshot_create_response.xml
View File

@ -1,11 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<snapshot
status="creating"
description="Daily backup"
created_at="2013-02-25T03:56:53.081642"
volume_id="5aa119a8-d25b-45a7-8d1b-88e127885635"
size="1"
id="ffa9bc5e-1172-4021-acaf-cdcd78a9584d"
name="snap-001">
<metadata/>
</snapshot>

28
v2/src/samples/snapshot_list_detail_response.xml
View File

@ -1,28 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<snapshots
xmlns:os-extended-snapshot-attributes="http://docs.openstack.org/openstack-block-storage/2.0/content/Extended_Snapshot_Attributes.html">
<snapshot
status="available"
description="Daily backup"
created_at="2013-02-25 07:30:12"
volume_id="5aa119a8-d25b-45a7-8d1b-88e127885635"
size="30"
id="43f20e0e-2c2c-4770-9d4e-c3d769ae5470"
name="snap-001"
os-extended-snapshot-attributes:project_id="0c2eba2c5af04d3f9e9d0d410b371fde"
os-extended-snapshot-attributes:progress="100%">
<metadata/>
</snapshot>
<snapshot
status="available"
description="Weekly backup"
created_at="2013-02-25 07:20:38"
volume_id="806092e3-7551-4fff-a005-49016f4943b1"
size="1"
id="e820db06-58b5-439d-bac6-c01faa3f6499"
name="snap-002"
os-extended-snapshot-attributes:project_id="0c2eba2c5af04d3f9e9d0d410b371fde"
os-extended-snapshot-attributes:progress="100%">
<metadata/>
</snapshot>
</snapshots>

23
v2/src/samples/snapshot_list_simple_response.xml
View File

@ -1,23 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<snapshots>
<snapshot
status="available"
description="Very important"
created_at="2013-02-25 04:13:17"
volume_id="5aa119a8-d25b-45a7-8d1b-88e127885635"
size="1"
id="2bb856e1-b3d8-4432-a858-09e4ce939389"
name="snap-001">
<metadata/>
</snapshot>
<snapshot
status="available"
description="Weekly backup"
created_at="2013-02-25 07:20:38"
volume_id="806092e3-7551-4fff-a005-49016f4943b1"
size="1"
id="e820db06-58b5-439d-bac6-c01faa3f6499"
name="snap-002">
<metadata/>
</snapshot>
</snapshots>

4
v2/src/samples/snapshot_update_request.xml
View File

@ -1,4 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<snapshot xmlns="http://docs.openstack.org/openstack-block-storage/2.0/content"
name="snap-002"
description="This is yet, another snapshot."/>

14
v2/src/samples/snapshot_update_response.xml
View File

@ -1,14 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<snapshot
xmlns:os-extended-snapshot-attributes="http://docs.openstack.org/openstack-block-storage/2.0/content/Extended_Snapshot_Attributes.html"
status="available"
description="This is yet, another snapshot"
created_at="2013-02-20T08:11:34.000000"
volume_id="2402b902-0b7a-458c-9c07-7435a826f794"
size="1"
id="4b502fcb-1f26-45f8-9fe5-3b9a0a52eaf2"
name="vol-002"
os-extended-snapshot-attributes:project_id="0c2eba2c5af04d3f9e9d0d410b371fde"
os-extended-snapshot-attributes:progress="100%">
<metadata/>
</snapshot>

11
v2/src/samples/volume_create_request.xml
View File

@ -1,11 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<volume xmlns="http://docs.openstack.org/openstack-block-storage/2.0/content"
name="vol-001"
description="Another volume."
size="30"
volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
availability_zone="us-east-1">
<metadata>
<meta key="contents">junk</meta>
</metadata>
</volume>

9
v2/src/samples/volume_create_response.xml
View File

@ -1,9 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<volume
xmlns:atom="http://www.w3.org/2005/Atom"
xmlns="http://docs.openstack.org/api/openstack-block-storage/2.0/content"
name="vol-001"
id="6996b558-d633-4635-8116-adf14009fcc3">
<attachments/>
<metadata/>
</volume>