From 35dcf50e0eb64146ae7956b6015be41afbb96825 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Fri, 25 Apr 2014 14:07:12 -0500 Subject: [PATCH] Update API site to show status of each API Add statuses, such as EXPERIMENTAL, STABLE, and CURRENT Closes-Bug: #1283620 Change-Id: I117146b16fc9ba456827255e33d0915f6c0d17bd author: diane fleming --- api-ref-guides/pom.xml | 64 ++++++++++------ ...age.xml => bk-api-ref-blockstorage-v1.xml} | 5 +- .../src/bk-api-ref-blockstorage-v2.xml | 51 +++++++++++++ ...abases.xml => bk-api-ref-databases-v1.xml} | 0 ...-ref-image.xml => bk-api-ref-image-v1.xml} | 3 +- api-ref-guides/src/bk-api-ref-image-v2.xml | 36 +++++++++ ...rking.xml => bk-api-ref-networking-v2.xml} | 0 ...ge.xml => bk-api-ref-objectstorage-v1.xml} | 0 ...on.xml => bk-api-ref-orchestration-v1.xml} | 0 ...emetry.xml => bk-api-ref-telemetry-v2.xml} | 0 api-ref/pom.xml | 75 ++++++++++++------- ...torage.xml => api-ref-blockstorage-v1.xml} | 5 +- .../src/docbkx/api-ref-blockstorage-v2.xml | 23 ++++++ api-ref/src/docbkx/api-ref-compute-v2-ext.xml | 2 +- api-ref/src/docbkx/api-ref-compute-v2.xml | 4 +- ...databases.xml => api-ref-databases-v1.xml} | 2 +- api-ref/src/docbkx/api-ref-identity-v2.xml | 2 +- api-ref/src/docbkx/api-ref-identity-v3.xml | 2 +- ...api-ref-image.xml => api-ref-image-v1.xml} | 5 +- api-ref/src/docbkx/api-ref-image-v2.xml | 23 ++++++ ...tworking.xml => api-ref-networking-v2.xml} | 4 +- ...orage.xml => api-ref-objectstorage-v1.xml} | 2 +- ...ation.xml => api-ref-orchestration-v1.xml} | 2 +- ...telemetry.xml => api-ref-telemetry-v2.xml} | 2 +- api-ref/src/docbkx/api-ref.xml | 2 +- api-ref/src/docbkx/ch_blockstorage-api-v1.xml | 2 +- api-ref/src/docbkx/ch_blockstorage-api-v2.xml | 2 +- api-ref/src/docbkx/ch_compute-v2-ext.xml | 6 +- api-ref/src/docbkx/ch_compute-v2.xml | 2 +- api-ref/src/docbkx/ch_databases-v1.xml | 2 +- api-ref/src/docbkx/ch_identity-admin-v2.xml | 2 +- api-ref/src/docbkx/ch_identity-v2-ext.xml | 2 +- api-ref/src/docbkx/ch_identity-v2.xml | 2 +- api-ref/src/docbkx/ch_identity-v3-ext.xml | 2 +- api-ref/src/docbkx/ch_identity-v3.xml | 2 +- api-ref/src/docbkx/ch_images-v1.xml | 2 +- api-ref/src/docbkx/ch_images-v2.xml | 2 +- api-ref/src/docbkx/ch_netconn-ext-v2.xml | 2 +- api-ref/src/docbkx/ch_netconn-v2.xml | 2 +- api-ref/src/docbkx/ch_objectstorage-v1.xml | 2 +- api-ref/src/docbkx/ch_orchestration-v1.xml | 2 +- api-ref/src/docbkx/ch_telemetry-v2.xml | 2 +- .../src/docbkx/itemizedlist-service-list.xml | 44 ++++++----- api-ref/src/docbkx/preface.xml | 60 ++++++++++++++- 44 files changed, 345 insertions(+), 111 deletions(-) rename api-ref-guides/src/{bk-api-ref-blockstorage.xml => bk-api-ref-blockstorage-v1.xml} (92%) create mode 100644 api-ref-guides/src/bk-api-ref-blockstorage-v2.xml rename api-ref-guides/src/{bk-api-ref-databases.xml => bk-api-ref-databases-v1.xml} (100%) rename api-ref-guides/src/{bk-api-ref-image.xml => bk-api-ref-image-v1.xml} (89%) create mode 100644 api-ref-guides/src/bk-api-ref-image-v2.xml rename api-ref-guides/src/{bk-api-ref-networking.xml => bk-api-ref-networking-v2.xml} (100%) rename api-ref-guides/src/{bk-api-ref-objectstorage.xml => bk-api-ref-objectstorage-v1.xml} (100%) rename api-ref-guides/src/{bk-api-ref-orchestration.xml => bk-api-ref-orchestration-v1.xml} (100%) rename api-ref-guides/src/{bk-api-ref-telemetry.xml => bk-api-ref-telemetry-v2.xml} (100%) rename api-ref/src/docbkx/{api-ref-blockstorage.xml => api-ref-blockstorage-v1.xml} (83%) create mode 100644 api-ref/src/docbkx/api-ref-blockstorage-v2.xml rename api-ref/src/docbkx/{api-ref-databases.xml => api-ref-databases-v1.xml} (92%) rename api-ref/src/docbkx/{api-ref-image.xml => api-ref-image-v1.xml} (83%) create mode 100644 api-ref/src/docbkx/api-ref-image-v2.xml rename api-ref/src/docbkx/{api-ref-networking.xml => api-ref-networking-v2.xml} (86%) rename api-ref/src/docbkx/{api-ref-objectstorage.xml => api-ref-objectstorage-v1.xml} (92%) rename api-ref/src/docbkx/{api-ref-orchestration.xml => api-ref-orchestration-v1.xml} (92%) rename api-ref/src/docbkx/{api-ref-telemetry.xml => api-ref-telemetry-v2.xml} (92%) diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml index 9d0ec6046..b458fdbd6 100644 --- a/api-ref-guides/pom.xml +++ b/api-ref-guides/pom.xml @@ -39,14 +39,25 @@ - os-api-ref-blockstorage + os-api-ref-blockstorage-v2 generate-pdf generate-sources - bk-api-ref-blockstorage.xml - api-ref-blockstorage + bk-api-ref-blockstorage-v2.xml + api-ref-blockstorage-v2 + + + + os-api-ref-blockstorage-v1 + + generate-pdf + + generate-sources + + bk-api-ref-blockstorage-v1.xml + api-ref-blockstorage-v1 @@ -83,14 +94,14 @@ - os-api-ref-databases + os-api-ref-databases-v1 generate-pdf generate-sources - bk-api-ref-databases.xml - api-ref-databases + bk-api-ref-databases-v1.xml + api-ref-databases-v1 @@ -116,58 +127,69 @@ - os-api-ref-image + os-api-ref-image-v2 generate-pdf generate-sources - bk-api-ref-image.xml - api-ref-image + bk-api-ref-image-v2.xml + api-ref-image-v2 - os-api-ref-networking + os-api-ref-image-v1 generate-pdf generate-sources - bk-api-ref-networking.xml - api-ref-networking + bk-api-ref-image-v1.xml + api-ref-image-v1 - os-api-ref-objectstorage + os-api-ref-networking-v2 generate-pdf generate-sources - bk-api-ref-objectstorage.xml - api-ref-objectstorage + bk-api-ref-networking-v2.xml + api-ref-networking-v2 - os-api-ref-orchestration + os-api-ref-objectstorage-v1 generate-pdf generate-sources - bk-api-ref-orchestration.xml - api-ref-orchestration + bk-api-ref-objectstorage-v1.xml + api-ref-objectstorage-v1 - os-api-ref-telemetry + os-api-ref-orchestration-v1 generate-pdf generate-sources - bk-api-ref-telemetry.xml - api-ref-telemetry + bk-api-ref-orchestration-v1.xml + api-ref-orchestration-v1 + + + + os-api-ref-telemetry-v2 + + generate-pdf + + generate-sources + + bk-api-ref-telemetry-v2.xml + api-ref-telemetry-v2 diff --git a/api-ref-guides/src/bk-api-ref-blockstorage.xml b/api-ref-guides/src/bk-api-ref-blockstorage-v1.xml similarity index 92% rename from api-ref-guides/src/bk-api-ref-blockstorage.xml rename to api-ref-guides/src/bk-api-ref-blockstorage-v1.xml index 52a5c3e79..0dc586818 100644 --- a/api-ref-guides/src/bk-api-ref-blockstorage.xml +++ b/api-ref-guides/src/bk-api-ref-blockstorage-v1.xml @@ -21,7 +21,7 @@ version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-blockstorage-pdf"> - OpenStack Block Storage API v2 and v1 Reference + OpenStack Block Storage API v1 Reference API Reference @@ -45,8 +45,7 @@ - + diff --git a/api-ref-guides/src/bk-api-ref-blockstorage-v2.xml b/api-ref-guides/src/bk-api-ref-blockstorage-v2.xml new file mode 100644 index 000000000..826fc008f --- /dev/null +++ b/api-ref-guides/src/bk-api-ref-blockstorage-v2.xml @@ -0,0 +1,51 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + + OpenStack Block Storage API v2 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2014 + OpenStack Foundation + + OpenStack Block Storage + + + + Copyright details are filled in by the + template. + + + + + + diff --git a/api-ref-guides/src/bk-api-ref-databases.xml b/api-ref-guides/src/bk-api-ref-databases-v1.xml similarity index 100% rename from api-ref-guides/src/bk-api-ref-databases.xml rename to api-ref-guides/src/bk-api-ref-databases-v1.xml diff --git a/api-ref-guides/src/bk-api-ref-image.xml b/api-ref-guides/src/bk-api-ref-image-v1.xml similarity index 89% rename from api-ref-guides/src/bk-api-ref-image.xml rename to api-ref-guides/src/bk-api-ref-image-v1.xml index 9244a94e9..6e0b426fc 100644 --- a/api-ref-guides/src/bk-api-ref-image.xml +++ b/api-ref-guides/src/bk-api-ref-image-v1.xml @@ -8,7 +8,7 @@ version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-image-pdf"> - OpenStack Image Service API v2 and v1 Reference + OpenStack Image Service API v1 Reference API Reference @@ -32,6 +32,5 @@ - diff --git a/api-ref-guides/src/bk-api-ref-image-v2.xml b/api-ref-guides/src/bk-api-ref-image-v2.xml new file mode 100644 index 000000000..ec2414011 --- /dev/null +++ b/api-ref-guides/src/bk-api-ref-image-v2.xml @@ -0,0 +1,36 @@ + + + + OpenStack Image Service API v2 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2014 + OpenStack Foundation + + OpenStack Image Service + + + + Copyright details are filled in by the + template. + + + + + diff --git a/api-ref-guides/src/bk-api-ref-networking.xml b/api-ref-guides/src/bk-api-ref-networking-v2.xml similarity index 100% rename from api-ref-guides/src/bk-api-ref-networking.xml rename to api-ref-guides/src/bk-api-ref-networking-v2.xml diff --git a/api-ref-guides/src/bk-api-ref-objectstorage.xml b/api-ref-guides/src/bk-api-ref-objectstorage-v1.xml similarity index 100% rename from api-ref-guides/src/bk-api-ref-objectstorage.xml rename to api-ref-guides/src/bk-api-ref-objectstorage-v1.xml diff --git a/api-ref-guides/src/bk-api-ref-orchestration.xml b/api-ref-guides/src/bk-api-ref-orchestration-v1.xml similarity index 100% rename from api-ref-guides/src/bk-api-ref-orchestration.xml rename to api-ref-guides/src/bk-api-ref-orchestration-v1.xml diff --git a/api-ref-guides/src/bk-api-ref-telemetry.xml b/api-ref-guides/src/bk-api-ref-telemetry-v2.xml similarity index 100% rename from api-ref-guides/src/bk-api-ref-telemetry.xml rename to api-ref-guides/src/bk-api-ref-telemetry-v2.xml diff --git a/api-ref/pom.xml b/api-ref/pom.xml index 2d376f09c..7c0819c4b 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -65,8 +65,7 @@ generate-sources - - api-ref-compute-v2.xml + api-ref-compute-v2.xml bk-api-ref-compute-v2 @@ -88,89 +87,107 @@ generate-sources - - api-ref-compute-v3.xml + api-ref-compute-v3.xml bk-api-ref-compute-v3 - os-api-ref-databases + os-api-ref-databases-v1 generate-html generate-sources - - api-ref-databases.xml - bk-api-ref-databases + api-ref-databases-v1.xml + bk-api-ref-databases-v1 - os-api-ref-image + os-api-ref-image-v2 generate-html generate-sources - api-ref-image.xml - bk-api-ref-image + api-ref-image-v2.xml + bk-api-ref-image-v2 - os-api-ref-networking + os-api-ref-image-v1 generate-html generate-sources - - api-ref-networking.xml - bk-api-ref-networking + api-ref-image-v1.xml + bk-api-ref-image-v1 - os-api-ref-objectstorage + os-api-ref-networking-v2 generate-html generate-sources - api-ref-objectstorage.xml - bk-api-ref-objectstorage + api-ref-networking-v2.xml + bk-api-ref-networking-v2 - os-api-ref-blockstorage + os-api-ref-objectstorage-v1 generate-html generate-sources - - api-ref-blockstorage.xml - bk-api-ref-blockstorage + api-ref-objectstorage-v1.xml + bk-api-ref-objectstorage-v1 - os-api-ref-orchestration + os-api-ref-blockstorage-v2 generate-html generate-sources - api-ref-orchestration.xml - bk-api-ref-orchestration + api-ref-blockstorage-v2.xml + bk-api-ref-blockstorage-v2 - os-api-ref-telemetry + os-api-ref-blockstorage-v1 generate-html generate-sources - api-ref-telemetry.xml - bk-api-ref-telemetry + api-ref-blockstorage-v1.xml + bk-api-ref-blockstorage-v1 + + + + os-api-ref-orchestration-v1 + + generate-html + + generate-sources + + api-ref-orchestration-v1.xml + bk-api-ref-orchestration-v1 + + + + os-api-ref-telemetry-v2 + + generate-html + + generate-sources + + api-ref-telemetry-v2.xml + bk-api-ref-telemetry-v2 @@ -186,7 +203,7 @@ section toc,title part toc,title qandadiv toc - qandaset to + qandaset toc reference toc,title set toc,title true diff --git a/api-ref/src/docbkx/api-ref-blockstorage.xml b/api-ref/src/docbkx/api-ref-blockstorage-v1.xml similarity index 83% rename from api-ref/src/docbkx/api-ref-blockstorage.xml rename to api-ref/src/docbkx/api-ref-blockstorage-v1.xml index 52412eed9..a2376e5d3 100644 --- a/api-ref/src/docbkx/api-ref-blockstorage.xml +++ b/api-ref/src/docbkx/api-ref-blockstorage-v1.xml @@ -6,9 +6,9 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-blockstorage"> + xml:id="api.openstack.org-blockstorage" status="CURRENT"> - OpenStack Block Storage API + OpenStack Block Storage API v1 2010-2014 @@ -19,6 +19,5 @@ - diff --git a/api-ref/src/docbkx/api-ref-blockstorage-v2.xml b/api-ref/src/docbkx/api-ref-blockstorage-v2.xml new file mode 100644 index 000000000..42a3d5b46 --- /dev/null +++ b/api-ref/src/docbkx/api-ref-blockstorage-v2.xml @@ -0,0 +1,23 @@ + + + + OpenStack Block Storage API v2 + + 2010-2014 + + + + + + + + + + diff --git a/api-ref/src/docbkx/api-ref-compute-v2-ext.xml b/api-ref/src/docbkx/api-ref-compute-v2-ext.xml index d9d28d63e..1e94e4738 100644 --- a/api-ref/src/docbkx/api-ref-compute-v2-ext.xml +++ b/api-ref/src/docbkx/api-ref-compute-v2-ext.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-compute-v2-ext"> + xml:id="api.openstack.org-compute-v2-ext" status="CURRENT"> OpenStack Compute API v2 extensions diff --git a/api-ref/src/docbkx/api-ref-compute-v2.xml b/api-ref/src/docbkx/api-ref-compute-v2.xml index 9d38f8cf4..abf8edfd2 100644 --- a/api-ref/src/docbkx/api-ref-compute-v2.xml +++ b/api-ref/src/docbkx/api-ref-compute-v2.xml @@ -6,9 +6,9 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-compute-v2"> + xml:id="api.openstack.org-compute-v2" status="CURRENT"> - OpenStack Compute API v2 + OpenStack Compute API v2 (CURRENT) 2010-2014 diff --git a/api-ref/src/docbkx/api-ref-databases.xml b/api-ref/src/docbkx/api-ref-databases-v1.xml similarity index 92% rename from api-ref/src/docbkx/api-ref-databases.xml rename to api-ref/src/docbkx/api-ref-databases-v1.xml index 87146b854..054675550 100644 --- a/api-ref/src/docbkx/api-ref-databases.xml +++ b/api-ref/src/docbkx/api-ref-databases-v1.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-databases"> + xml:id="api.openstack.org-databases" status="CURRENT"> OpenStack Database Service API v1.0 diff --git a/api-ref/src/docbkx/api-ref-identity-v2.xml b/api-ref/src/docbkx/api-ref-identity-v2.xml index 62667a9cd..90d20f0cf 100644 --- a/api-ref/src/docbkx/api-ref-identity-v2.xml +++ b/api-ref/src/docbkx/api-ref-identity-v2.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-identity-v2"> + xml:id="api.openstack.org-identity-v2" status="STABLE"> OpenStack Identity API v2 and extensions diff --git a/api-ref/src/docbkx/api-ref-identity-v3.xml b/api-ref/src/docbkx/api-ref-identity-v3.xml index 31953ea41..addef97b1 100644 --- a/api-ref/src/docbkx/api-ref-identity-v3.xml +++ b/api-ref/src/docbkx/api-ref-identity-v3.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-identity-v3"> + xml:id="api.openstack.org-identity-v3" status="STABLE"> OpenStack Identity API v3 and extensions diff --git a/api-ref/src/docbkx/api-ref-image.xml b/api-ref/src/docbkx/api-ref-image-v1.xml similarity index 83% rename from api-ref/src/docbkx/api-ref-image.xml rename to api-ref/src/docbkx/api-ref-image-v1.xml index 3a95843b7..c01436908 100644 --- a/api-ref/src/docbkx/api-ref-image.xml +++ b/api-ref/src/docbkx/api-ref-image-v1.xml @@ -6,9 +6,9 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-image"> + xml:id="api.openstack.org-image" status="SUPPORTED"> - OpenStack Image Service API v2 and v1 + OpenStack Image Service API v1 2010-2014 @@ -19,6 +19,5 @@ - diff --git a/api-ref/src/docbkx/api-ref-image-v2.xml b/api-ref/src/docbkx/api-ref-image-v2.xml new file mode 100644 index 000000000..5148e55a7 --- /dev/null +++ b/api-ref/src/docbkx/api-ref-image-v2.xml @@ -0,0 +1,23 @@ + + + + OpenStack Image Service API v2 + + 2010-2014 + + + + + + + + + + diff --git a/api-ref/src/docbkx/api-ref-networking.xml b/api-ref/src/docbkx/api-ref-networking-v2.xml similarity index 86% rename from api-ref/src/docbkx/api-ref-networking.xml rename to api-ref/src/docbkx/api-ref-networking-v2.xml index 9446578f6..fedfdad06 100644 --- a/api-ref/src/docbkx/api-ref-networking.xml +++ b/api-ref/src/docbkx/api-ref-networking-v2.xml @@ -6,9 +6,9 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-networking"> + xml:id="api.openstack.org-networking" status="CURRENT"> - OpenStack Networking (neutron) API v2.0 and extensions + OpenStack Networking API v2.0 2010-2014 diff --git a/api-ref/src/docbkx/api-ref-objectstorage.xml b/api-ref/src/docbkx/api-ref-objectstorage-v1.xml similarity index 92% rename from api-ref/src/docbkx/api-ref-objectstorage.xml rename to api-ref/src/docbkx/api-ref-objectstorage-v1.xml index 55588ffc2..fccd4a041 100644 --- a/api-ref/src/docbkx/api-ref-objectstorage.xml +++ b/api-ref/src/docbkx/api-ref-objectstorage-v1.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-objectstorage"> + xml:id="api.openstack.org-objectstorage" status="SUPPORTED"> OpenStack Object Storage API v1 diff --git a/api-ref/src/docbkx/api-ref-orchestration.xml b/api-ref/src/docbkx/api-ref-orchestration-v1.xml similarity index 92% rename from api-ref/src/docbkx/api-ref-orchestration.xml rename to api-ref/src/docbkx/api-ref-orchestration-v1.xml index f6927d98a..e71053169 100644 --- a/api-ref/src/docbkx/api-ref-orchestration.xml +++ b/api-ref/src/docbkx/api-ref-orchestration-v1.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-orchestration"> + xml:id="api.openstack.org-orchestration" status="CURRENT"> OpenStack Orchestration API v1 diff --git a/api-ref/src/docbkx/api-ref-telemetry.xml b/api-ref/src/docbkx/api-ref-telemetry-v2.xml similarity index 92% rename from api-ref/src/docbkx/api-ref-telemetry.xml rename to api-ref/src/docbkx/api-ref-telemetry-v2.xml index 0645e4f89..3d52e51ce 100644 --- a/api-ref/src/docbkx/api-ref-telemetry.xml +++ b/api-ref/src/docbkx/api-ref-telemetry-v2.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-telemetry"> + xml:id="api.openstack.org-telemetry" status="CURRENT"> OpenStack Telemetry API v2 diff --git a/api-ref/src/docbkx/api-ref.xml b/api-ref/src/docbkx/api-ref.xml index 6daa400dc..b9f2beeaf 100644 --- a/api-ref/src/docbkx/api-ref.xml +++ b/api-ref/src/docbkx/api-ref.xml @@ -20,4 +20,4 @@ xml:id="api.openstack.org"> - + \ No newline at end of file diff --git a/api-ref/src/docbkx/ch_blockstorage-api-v1.xml b/api-ref/src/docbkx/ch_blockstorage-api-v1.xml index 3364164fd..c8717005b 100644 --- a/api-ref/src/docbkx/ch_blockstorage-api-v1.xml +++ b/api-ref/src/docbkx/ch_blockstorage-api-v1.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="blockstorage-v1" role="api-reference"> - Block Storage API v1 + Block Storage API v1 (CURRENT) Manage volumes and snapshots for use with the Block Storage API, also known as cinder services.
diff --git a/api-ref/src/docbkx/ch_blockstorage-api-v2.xml b/api-ref/src/docbkx/ch_blockstorage-api-v2.xml index 4796a5129..d6bd7d318 100644 --- a/api-ref/src/docbkx/ch_blockstorage-api-v2.xml +++ b/api-ref/src/docbkx/ch_blockstorage-api-v2.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2" role="api-reference"> - Block Storage API v2 + Block Storage API v2 (CURRENT) Manage volumes and snapshots for use with the Block Storage API, also known as cinder services.
diff --git a/api-ref/src/docbkx/ch_compute-v2-ext.xml b/api-ref/src/docbkx/ch_compute-v2-ext.xml index 3903b224e..7695002f5 100644 --- a/api-ref/src/docbkx/ch_compute-v2-ext.xml +++ b/api-ref/src/docbkx/ch_compute-v2-ext.xml @@ -10,14 +10,14 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2" role="api-reference"> - Compute API v2 extensions + Compute API v2 extensions (CURRENT) Extensions add features, MIME types, actions, states, headers, parameters, and resources to the core Compute API without requiring a version change.
Extensions - List available Compute API v2 extensions and show details for a - specified extension. + List available Compute API v2 extensions and show + details for a specified extension. diff --git a/api-ref/src/docbkx/ch_compute-v2.xml b/api-ref/src/docbkx/ch_compute-v2.xml index 2d1f08249..0c9a4d657 100644 --- a/api-ref/src/docbkx/ch_compute-v2.xml +++ b/api-ref/src/docbkx/ch_compute-v2.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="compute-core-v2" role="api-reference"> - Compute API v2 + Compute API v2 (CURRENT) Launch virtual machines from images or images stored on persistent volumes. API v1.1 is identical to API v2.
diff --git a/api-ref/src/docbkx/ch_databases-v1.xml b/api-ref/src/docbkx/ch_databases-v1.xml index 92ba1b9aa..c4e14ece5 100644 --- a/api-ref/src/docbkx/ch_databases-v1.xml +++ b/api-ref/src/docbkx/ch_databases-v1.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="databases-v1.0"> - Databases Service API v1.0 + Databases Service API v1.0 (CURRENT)
API versions diff --git a/api-ref/src/docbkx/ch_identity-admin-v2.xml b/api-ref/src/docbkx/ch_identity-admin-v2.xml index 38429c454..9e7ac1c25 100644 --- a/api-ref/src/docbkx/ch_identity-admin-v2.xml +++ b/api-ref/src/docbkx/ch_identity-admin-v2.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2" xlink:href="#identity-admin-v2" role="api-reference"> - Identity admin API v2.0 + Identity admin API v2.0 (STABLE) Get an authentication token that permits access to the Compute API. - Identity API v2.0 extensions + Identity API v2.0 extensions (STABLE) Query the Identity API to list available extensions with a &GET; request to v2.0/extensions.
diff --git a/api-ref/src/docbkx/ch_identity-v2.xml b/api-ref/src/docbkx/ch_identity-v2.xml index fa1218700..fa683f61f 100644 --- a/api-ref/src/docbkx/ch_identity-v2.xml +++ b/api-ref/src/docbkx/ch_identity-v2.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="identity-v2" xlink:href="#identity-v2"> - Identity API v2.0 + Identity API v2.0 (STABLE) Get an authentication token that permits access to the Compute API.
diff --git a/api-ref/src/docbkx/ch_identity-v3-ext.xml b/api-ref/src/docbkx/ch_identity-v3-ext.xml index 194e24525..72f346a59 100644 --- a/api-ref/src/docbkx/ch_identity-v3-ext.xml +++ b/api-ref/src/docbkx/ch_identity-v3-ext.xml @@ -10,7 +10,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="identity-v3-ext" xlink:href="#identity-v3-ext" role="api-reference"> - Identity API v3 extensions + Identity API v3 extensions (STABLE) Query the Identity API to list available extensions with a &GET; request to v3/extensions.
diff --git a/api-ref/src/docbkx/ch_identity-v3.xml b/api-ref/src/docbkx/ch_identity-v3.xml index 51f521545..513d7a661 100644 --- a/api-ref/src/docbkx/ch_identity-v3.xml +++ b/api-ref/src/docbkx/ch_identity-v3.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="identity-v3" xlink:href="#identity-v3" role="api-reference"> - Identity API v3 + Identity API v3 (STABLE) Get an authentication token that permits access to the Compute API.
diff --git a/api-ref/src/docbkx/ch_images-v1.xml b/api-ref/src/docbkx/ch_images-v1.xml index 9d2dbbaa1..c47028d53 100644 --- a/api-ref/src/docbkx/ch_images-v1.xml +++ b/api-ref/src/docbkx/ch_images-v1.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="image-v1" role="api-reference"> - Image Service API v1 + Image Service API v1 (SUPPORTED) Load images for use at launch time by the Compute API. Also, assign metadata to images. Some cloud implementations do not expose this API and offer diff --git a/api-ref/src/docbkx/ch_images-v2.xml b/api-ref/src/docbkx/ch_images-v2.xml index 2a90a00e2..6cd0621a9 100644 --- a/api-ref/src/docbkx/ch_images-v2.xml +++ b/api-ref/src/docbkx/ch_images-v2.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="image-v2"> - Image Service API v2 + Image Service API v2 (SUPPORTED) Image Service API v2.0, API v2.1, and API v2.2.
API versions diff --git a/api-ref/src/docbkx/ch_netconn-ext-v2.xml b/api-ref/src/docbkx/ch_netconn-ext-v2.xml index 6c6e1686f..7c65fb665 100644 --- a/api-ref/src/docbkx/ch_netconn-ext-v2.xml +++ b/api-ref/src/docbkx/ch_netconn-ext-v2.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="netconn-v2-ext"> - Networking (neutron) API v2.0 extensions + Networking API v2.0 extensions (CURRENT)
Quotas extension (quotas) List, show information for, update, and reset diff --git a/api-ref/src/docbkx/ch_netconn-v2.xml b/api-ref/src/docbkx/ch_netconn-v2.xml index c41ac88b4..882eae4b8 100644 --- a/api-ref/src/docbkx/ch_netconn-v2.xml +++ b/api-ref/src/docbkx/ch_netconn-v2.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="netconn-v2"> - Networking (neutron) API v2.0 + Networking API v2.0 (CURRENT) Use virtual networking services among devices that are managed by the OpenStack Compute service. The Networking (neutron) API v2.0 combines the API v1.1 functionality with diff --git a/api-ref/src/docbkx/ch_objectstorage-v1.xml b/api-ref/src/docbkx/ch_objectstorage-v1.xml index c32470cac..4060d2f21 100644 --- a/api-ref/src/docbkx/ch_objectstorage-v1.xml +++ b/api-ref/src/docbkx/ch_objectstorage-v1.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="objectstorage-v1"> - Object Storage API v1 + Object Storage API v1 (SUPPORTED) Manage the accounts, containers, and objects in the Object Storage system. To run the cURL command examples for these requests, set diff --git a/api-ref/src/docbkx/ch_orchestration-v1.xml b/api-ref/src/docbkx/ch_orchestration-v1.xml index 9331dccc8..daabf181a 100644 --- a/api-ref/src/docbkx/ch_orchestration-v1.xml +++ b/api-ref/src/docbkx/ch_orchestration-v1.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="orchestration-v1"> - Orchestration API v1 + Orchestration API v1 (CURRENT) Use a template language to orchestrate OpenStack services.
diff --git a/api-ref/src/docbkx/ch_telemetry-v2.xml b/api-ref/src/docbkx/ch_telemetry-v2.xml index 83c58633f..e38aa790e 100644 --- a/api-ref/src/docbkx/ch_telemetry-v2.xml +++ b/api-ref/src/docbkx/ch_telemetry-v2.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="telemetry-v2"> - Telemetry API v2 + Telemetry API v2 (CURRENT) Manage telemetry operations.
Alarms diff --git a/api-ref/src/docbkx/itemizedlist-service-list.xml b/api-ref/src/docbkx/itemizedlist-service-list.xml index 6e83f406c..f98c9cdbc 100644 --- a/api-ref/src/docbkx/itemizedlist-service-list.xml +++ b/api-ref/src/docbkx/itemizedlist-service-list.xml @@ -9,51 +9,59 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="service-list"> - Block - Storage API + Block + Storage API v2 (CURRENT) + + + Block + Storage API v1 (CURRENT) Compute API - v2 + v2 (CURRENT) Compute - API v2 extensions + API v2 extensions (CURRENT) Compute API v3 (EXPERIMENTAL) - Database - Service API + Database + Service API v1.0 (CURRENT) Identity API - v3 and extensions + v3 (STABLE) Identity API - v2.0 and extensions + v2.0 (STABLE) - Image Service - API + Image Service + API v2 (SUPPORTED) - Networking - (neutron) API and extensions + Image Service + API v1 (SUPPORTED) - Object - Storage API + Networking + API v2.0 (CURRENT) - Orchestration API + Object + Storage API v1 (SUPPORTED) - Telemetry - API + Orchestration API v1 (CURRENT) + + + Telemetry + API v2 (CURRENT) diff --git a/api-ref/src/docbkx/preface.xml b/api-ref/src/docbkx/preface.xml index dc91359fb..ea220193f 100644 --- a/api-ref/src/docbkx/preface.xml +++ b/api-ref/src/docbkx/preface.xml @@ -13,7 +13,6 @@ OpenStack API Complete Reference Use the OpenStack APIs and extensions in your OpenStack cloud. - You must install the packages for each API separately. After you authenticate through the Identity API, @@ -24,6 +23,65 @@ see the OpenStack API Quick Start. + The API status reflects the + state of the endpoint on the service. This table shows the + possible API status values + and descriptions: + + + + Status + Stable + Description + + + + CURRENT + + Yes + This version is up-to-date, recent, and might + receive future versions. This endpoint should be + prioritized over all others. + + + + SUPPORTED + + Yes + This version is available on the server, however + is not likely the most recent available and might + not be updated or might be deprecated at some time + in the future. + + + + DEPRECATED + + Yes + This version is still available but is being + deprecated and might be removed in the + future. + + + + EXPERIMENTAL + + No + This version is under development or contains + features that are otherwise subject to + change. + + + + + An API that is not marked as stable is still under + development. + + For more information about API status values and version information, see + Version Discovery.