From 02a6f560f0d621628433e4a3ae6cc889ed906deb Mon Sep 17 00:00:00 2001 From: sxmatch Date: Tue, 3 Jan 2017 14:40:16 +0800 Subject: [PATCH] Reorganized api-ref folder Now Mogan has his own V1 api-ref folder, but the documents in here are not be organized very well like other projects. So this patch wants to improve it better. Change-Id: Ia2cd8dd99b617c64550e50c96c49aa1e323862bd Closes-Bug: #1653616 --- api-ref/source/index.rst | 19 ++++++++++++------- .../source/{ => v1}/availability_zones.inc | 2 +- api-ref/source/v1/index.rst | 12 ++++++++++++ api-ref/source/{ => v1}/instances.inc | 18 +++++++++--------- api-ref/source/{ => v1}/parameters.yaml | 0 .../availability-zone-list-resp.json | 0 .../instances/instance-create-req.json | 0 .../instances/instance-create-resp.json | 0 .../instances/instance-detail-resp.json | 0 .../instance-get-state-response.json | 0 .../instances/instance-list-detail-resp.json | 0 .../instances/instance-list-resp.json | 0 .../instances/instance-set-power-off.json | 0 .../instances/instance-update-req.json | 0 .../instances/instance-update-resp.json | 0 .../samples}/types/type-create-post-req.json | 0 .../samples}/types/type-create-post-resp.json | 0 .../types/type-extra-specs-list-resp.json | 0 .../types/type-extra-specs-patch-req.json | 0 .../types/type-extra-specs-patch-resp.json | 0 .../v1/samples}/types/type-get-resp.json | 0 .../samples}/types/type-update-put-req.json | 0 .../samples}/types/type-update-put-resp.json | 0 .../v1/samples}/types/types-list-resp.json | 0 api-ref/source/{ => v1}/types.inc | 18 +++++++++--------- api-ref/source/{ => v1}/urls.inc | 0 26 files changed, 43 insertions(+), 26 deletions(-) rename api-ref/source/{ => v1}/availability_zones.inc (84%) create mode 100644 api-ref/source/v1/index.rst rename api-ref/source/{ => v1}/instances.inc (90%) rename api-ref/source/{ => v1}/parameters.yaml (100%) rename {doc/api_samples => api-ref/source/v1/samples}/availability_zones/availability-zone-list-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-create-req.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-create-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-detail-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-get-state-response.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-list-detail-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-list-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-set-power-off.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-update-req.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/instances/instance-update-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/type-create-post-req.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/type-create-post-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/type-extra-specs-list-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/type-extra-specs-patch-req.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/type-extra-specs-patch-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/type-get-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/type-update-put-req.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/type-update-put-resp.json (100%) rename {doc/api_samples => api-ref/source/v1/samples}/types/types-list-resp.json (100%) rename api-ref/source/{ => v1}/types.inc (88%) rename api-ref/source/{ => v1}/urls.inc (100%) diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index e638258a..923c4b4d 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,12 +1,17 @@ -:tocdepth: 2 - ====================== Baremetal Compute API ====================== -.. rest_expand_all:: +Contents: -.. include:: urls.inc -.. include:: instances.inc -.. include:: types.inc -.. include:: availability_zones.inc +.. toctree:: + :maxdepth: 1 + + v1/index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/api-ref/source/availability_zones.inc b/api-ref/source/v1/availability_zones.inc similarity index 84% rename from api-ref/source/availability_zones.inc rename to api-ref/source/v1/availability_zones.inc index 5f2b615f..d0a7ee59 100644 --- a/api-ref/source/availability_zones.inc +++ b/api-ref/source/v1/availability_zones.inc @@ -28,5 +28,5 @@ Response **Example List availability zone information** -.. literalinclude:: ../../doc/api_samples/availability_zones/availability-zone-list-resp.json +.. literalinclude:: samples/availability_zones/availability-zone-list-resp.json :language: javascript diff --git a/api-ref/source/v1/index.rst b/api-ref/source/v1/index.rst new file mode 100644 index 00000000..6bca94b9 --- /dev/null +++ b/api-ref/source/v1/index.rst @@ -0,0 +1,12 @@ +:tocdepth: 2 + +================================== +Baremetal Compute API V1 (CURRENT) +================================== + +.. rest_expand_all:: + +.. include:: urls.inc +.. include:: instances.inc +.. include:: types.inc +.. include:: availability_zones.inc diff --git a/api-ref/source/instances.inc b/api-ref/source/v1/instances.inc similarity index 90% rename from api-ref/source/instances.inc rename to api-ref/source/v1/instances.inc index 557a0775..08547d7e 100644 --- a/api-ref/source/instances.inc +++ b/api-ref/source/v1/instances.inc @@ -41,7 +41,7 @@ Request **Example Create Instance: JSON request** -.. literalinclude:: ../../doc/api_samples/instances/instance-create-req.json +.. literalinclude:: samples/instances/instance-create-req.json :language: javascript Response @@ -67,7 +67,7 @@ Response **Example Create Instance: JSON response** -.. literalinclude:: ../../doc/api_samples/instances/instance-create-resp.json +.. literalinclude:: samples/instances/instance-create-resp.json :language: javascript @@ -108,7 +108,7 @@ Response **Example List of Instances: JSON response** -.. literalinclude:: ../../doc/api_samples/instances/instance-list-resp.json +.. literalinclude:: samples/instances/instance-list-resp.json :language: javascript @@ -153,7 +153,7 @@ Response **Example Detailed list of Instances: JSON response** -.. literalinclude:: ../../doc/api_samples/instances/instance-list-detail-resp.json +.. literalinclude:: samples/instances/instance-list-detail-resp.json :language: javascript @@ -203,7 +203,7 @@ Response **Example Instance Details: JSON response** -.. literalinclude:: ../../doc/api_samples/instances/instance-detail-resp.json +.. literalinclude:: samples/instances/instance-detail-resp.json :language: javascript @@ -231,7 +231,7 @@ The BODY of the PATCH request must be a JSON PATCH document, adhering to **Example Update Instance: JSON request** -.. literalinclude:: ../../doc/api_samples/instances/instance-update-req.json +.. literalinclude:: samples/instances/instance-update-req.json :language: javascript Response @@ -257,7 +257,7 @@ Response **Example Update Instance: JSON response** -.. literalinclude:: ../../doc/api_samples/instances/instance-update-resp.json +.. literalinclude:: samples/instances/instance-update-resp.json :language: javascript @@ -326,7 +326,7 @@ Response **Example instance state:** -.. literalinclude:: ../../doc/api_samples/instances/instance-get-state-response.json +.. literalinclude:: samples/instances/instance-get-state-response.json Change Instance Power State @@ -353,4 +353,4 @@ Request **Example request to power off a Instance:** -.. literalinclude:: ../../doc/api_samples/instances/instance-set-power-off.json +.. literalinclude:: samples/instances/instance-set-power-off.json diff --git a/api-ref/source/parameters.yaml b/api-ref/source/v1/parameters.yaml similarity index 100% rename from api-ref/source/parameters.yaml rename to api-ref/source/v1/parameters.yaml diff --git a/doc/api_samples/availability_zones/availability-zone-list-resp.json b/api-ref/source/v1/samples/availability_zones/availability-zone-list-resp.json similarity index 100% rename from doc/api_samples/availability_zones/availability-zone-list-resp.json rename to api-ref/source/v1/samples/availability_zones/availability-zone-list-resp.json diff --git a/doc/api_samples/instances/instance-create-req.json b/api-ref/source/v1/samples/instances/instance-create-req.json similarity index 100% rename from doc/api_samples/instances/instance-create-req.json rename to api-ref/source/v1/samples/instances/instance-create-req.json diff --git a/doc/api_samples/instances/instance-create-resp.json b/api-ref/source/v1/samples/instances/instance-create-resp.json similarity index 100% rename from doc/api_samples/instances/instance-create-resp.json rename to api-ref/source/v1/samples/instances/instance-create-resp.json diff --git a/doc/api_samples/instances/instance-detail-resp.json b/api-ref/source/v1/samples/instances/instance-detail-resp.json similarity index 100% rename from doc/api_samples/instances/instance-detail-resp.json rename to api-ref/source/v1/samples/instances/instance-detail-resp.json diff --git a/doc/api_samples/instances/instance-get-state-response.json b/api-ref/source/v1/samples/instances/instance-get-state-response.json similarity index 100% rename from doc/api_samples/instances/instance-get-state-response.json rename to api-ref/source/v1/samples/instances/instance-get-state-response.json diff --git a/doc/api_samples/instances/instance-list-detail-resp.json b/api-ref/source/v1/samples/instances/instance-list-detail-resp.json similarity index 100% rename from doc/api_samples/instances/instance-list-detail-resp.json rename to api-ref/source/v1/samples/instances/instance-list-detail-resp.json diff --git a/doc/api_samples/instances/instance-list-resp.json b/api-ref/source/v1/samples/instances/instance-list-resp.json similarity index 100% rename from doc/api_samples/instances/instance-list-resp.json rename to api-ref/source/v1/samples/instances/instance-list-resp.json diff --git a/doc/api_samples/instances/instance-set-power-off.json b/api-ref/source/v1/samples/instances/instance-set-power-off.json similarity index 100% rename from doc/api_samples/instances/instance-set-power-off.json rename to api-ref/source/v1/samples/instances/instance-set-power-off.json diff --git a/doc/api_samples/instances/instance-update-req.json b/api-ref/source/v1/samples/instances/instance-update-req.json similarity index 100% rename from doc/api_samples/instances/instance-update-req.json rename to api-ref/source/v1/samples/instances/instance-update-req.json diff --git a/doc/api_samples/instances/instance-update-resp.json b/api-ref/source/v1/samples/instances/instance-update-resp.json similarity index 100% rename from doc/api_samples/instances/instance-update-resp.json rename to api-ref/source/v1/samples/instances/instance-update-resp.json diff --git a/doc/api_samples/types/type-create-post-req.json b/api-ref/source/v1/samples/types/type-create-post-req.json similarity index 100% rename from doc/api_samples/types/type-create-post-req.json rename to api-ref/source/v1/samples/types/type-create-post-req.json diff --git a/doc/api_samples/types/type-create-post-resp.json b/api-ref/source/v1/samples/types/type-create-post-resp.json similarity index 100% rename from doc/api_samples/types/type-create-post-resp.json rename to api-ref/source/v1/samples/types/type-create-post-resp.json diff --git a/doc/api_samples/types/type-extra-specs-list-resp.json b/api-ref/source/v1/samples/types/type-extra-specs-list-resp.json similarity index 100% rename from doc/api_samples/types/type-extra-specs-list-resp.json rename to api-ref/source/v1/samples/types/type-extra-specs-list-resp.json diff --git a/doc/api_samples/types/type-extra-specs-patch-req.json b/api-ref/source/v1/samples/types/type-extra-specs-patch-req.json similarity index 100% rename from doc/api_samples/types/type-extra-specs-patch-req.json rename to api-ref/source/v1/samples/types/type-extra-specs-patch-req.json diff --git a/doc/api_samples/types/type-extra-specs-patch-resp.json b/api-ref/source/v1/samples/types/type-extra-specs-patch-resp.json similarity index 100% rename from doc/api_samples/types/type-extra-specs-patch-resp.json rename to api-ref/source/v1/samples/types/type-extra-specs-patch-resp.json diff --git a/doc/api_samples/types/type-get-resp.json b/api-ref/source/v1/samples/types/type-get-resp.json similarity index 100% rename from doc/api_samples/types/type-get-resp.json rename to api-ref/source/v1/samples/types/type-get-resp.json diff --git a/doc/api_samples/types/type-update-put-req.json b/api-ref/source/v1/samples/types/type-update-put-req.json similarity index 100% rename from doc/api_samples/types/type-update-put-req.json rename to api-ref/source/v1/samples/types/type-update-put-req.json diff --git a/doc/api_samples/types/type-update-put-resp.json b/api-ref/source/v1/samples/types/type-update-put-resp.json similarity index 100% rename from doc/api_samples/types/type-update-put-resp.json rename to api-ref/source/v1/samples/types/type-update-put-resp.json diff --git a/doc/api_samples/types/types-list-resp.json b/api-ref/source/v1/samples/types/types-list-resp.json similarity index 100% rename from doc/api_samples/types/types-list-resp.json rename to api-ref/source/v1/samples/types/types-list-resp.json diff --git a/api-ref/source/types.inc b/api-ref/source/v1/types.inc similarity index 88% rename from api-ref/source/types.inc rename to api-ref/source/v1/types.inc index f36fe0b5..4d596dbe 100644 --- a/api-ref/source/types.inc +++ b/api-ref/source/v1/types.inc @@ -42,7 +42,7 @@ Response **Example List types** -.. literalinclude:: ../../doc/api_samples/types/types-list-resp.json +.. literalinclude:: samples/types/types-list-resp.json :language: javascript Create Type @@ -72,7 +72,7 @@ Request **Example Create Type** -.. literalinclude:: ../../doc/api_samples/types/type-create-post-req.json +.. literalinclude:: samples/types/type-create-post-req.json :language: javascript Response @@ -91,7 +91,7 @@ Response **Example Create type** -.. literalinclude:: ../../doc/api_samples/types/type-create-post-resp.json +.. literalinclude:: samples/types/type-create-post-resp.json :language: javascript Update Type @@ -120,7 +120,7 @@ Request **Example Update Type** -.. literalinclude:: ../../doc/api_samples/types/type-update-put-req.json +.. literalinclude:: samples/types/type-update-put-req.json :language: javascript Response @@ -139,7 +139,7 @@ Response **Example Update type** -.. literalinclude:: ../../doc/api_samples/types/type-update-put-resp.json +.. literalinclude:: samples/types/type-update-put-resp.json :language: javascript Show Type Details @@ -176,7 +176,7 @@ Response **Example Show type Details** -.. literalinclude:: ../../doc/api_samples/types/type-get-resp.json +.. literalinclude:: samples/types/type-get-resp.json :language: javascript @@ -235,7 +235,7 @@ Response **Example List Extra Specs** -.. literalinclude:: ../../doc/api_samples/types/type-extra-specs-list-resp.json +.. literalinclude:: samples/types/type-extra-specs-list-resp.json :language: javascript @@ -260,7 +260,7 @@ Request **Example Create Extra Specs** -.. literalinclude:: ../../doc/api_samples/types/type-extra-specs-patch-req.json +.. literalinclude:: samples/types/type-extra-specs-patch-req.json :language: javascript Response @@ -272,7 +272,7 @@ Response **Example Create Extra Specs** -.. literalinclude:: ../../doc/api_samples/types/type-extra-specs-patch-resp.json +.. literalinclude:: samples/types/type-extra-specs-patch-resp.json :language: javascript diff --git a/api-ref/source/urls.inc b/api-ref/source/v1/urls.inc similarity index 100% rename from api-ref/source/urls.inc rename to api-ref/source/v1/urls.inc