From f208917c520cc1a92e6177cebba16decd0247232 Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Wed, 20 Apr 2016 08:42:24 -0400 Subject: [PATCH] Fix remaining json reference warnings This fixes the last json reference warning which exist. It also trims out the baremetal API calls that we don't support any more (we only have the readonly proxy). That was erroneously added to the compute API docs in refactors of api-site last cycle. Change-Id: I08be639b610304049b0959902ed8876559111274 --- api-ref/source/extensions.inc | 3 +- api-ref/source/images.inc | 3 +- api-ref/source/os-baremetal-nodes.inc | 138 +------------------------- api-ref/source/os-consoles.inc | 5 +- 4 files changed, 6 insertions(+), 143 deletions(-) diff --git a/api-ref/source/extensions.inc b/api-ref/source/extensions.inc index b96c736f6a..30974b1c7a 100644 --- a/api-ref/source/extensions.inc +++ b/api-ref/source/extensions.inc @@ -46,6 +46,5 @@ Response **Example Show Extension Details: JSON response** -.. literalinclude:: ../../doc/api_samples/extensions-info/extensions-get-resp.json +.. literalinclude:: ../../doc/api_samples/extension-info/extensions-get-resp.json :language: javascript - diff --git a/api-ref/source/images.inc b/api-ref/source/images.inc index 7150410896..429dce48e3 100644 --- a/api-ref/source/images.inc +++ b/api-ref/source/images.inc @@ -66,7 +66,7 @@ Response **Example Show Image Details: JSON response** -.. literalinclude:: ../../doc/api_samples/images/image-show-resp.json +.. literalinclude:: ../../doc/api_samples/images/images-details-get-resp.json :language: javascript List Images With Details @@ -300,4 +300,3 @@ Request Response -------- - diff --git a/api-ref/source/os-baremetal-nodes.inc b/api-ref/source/os-baremetal-nodes.inc index b3b3cf9e59..5fe1cd1476 100644 --- a/api-ref/source/os-baremetal-nodes.inc +++ b/api-ref/source/os-baremetal-nodes.inc @@ -6,54 +6,6 @@ Bare metal nodes. -Add Bare Metal Node -=================== - -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/os-baremetal-nodes - -Adds a bare metal node to a server. - -Preconditions - -You can add a bare metal node to a server with an ``ACTIVE``, ``PAUSED``, ``SHUTOFF``, ``VERIFY_RESIZE``, or ``SOFT_DELETED`` status. - -You can add a bare metal node to a server with a status that is not locked. - -Normal response codes: 202 - -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) - -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - - server_id: server_id - -**Example Add Bare Metal Node: JSON request** - -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-create-req.json - :language: javascript - -**Example Add Bare Metal Node: JSON request** - -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-create-with-address-req.json - :language: javascript - -Response --------- - -**Example Add Bare Metal Node: JSON response** - -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-create-resp.json - :language: javascript - -**Example Add Bare Metal Node: JSON request** - -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-create-with-address-resp.json - :language: javascript List Bare Metal Nodes ===================== @@ -80,70 +32,9 @@ Response **Example List Bare Metal Nodes: JSON response** -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-nodes-list-resp.json +.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-list-resp.json :language: javascript -Add Interface To Bare Metal Node -================================ - -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/os-baremetal-nodes/action - -Adds an interface to a bare metal node that is associated with a server. - -Normal response codes: 202 - -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) - -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - - server_id: server_id - -**Example Add Interface To Bare Metal Node: JSON request** - -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-req.json - :language: javascript - -Response --------- - -**Example Add Interface To Bare Metal Node: JSON response** - -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-resp.json - :language: javascript - -Delete Interface From Bare Metal Node -===================================== - -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/os-baremetal-nodes/action - -Deletes an interface from a bare metal node that is associated with a server. - -Normal response codes: 200 - -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) - -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - - server_id: server_id - -**Example Delete Interface From Bare Metal Node: JSON request** - -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-remove-interface-req.json - :language: javascript - -Response --------- - Show Bare Metal Node Details ============================ @@ -174,30 +65,5 @@ Response **Example Show Bare Metal Node Details: JSON response** -.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-show-resp.json +.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-get-resp.json :language: javascript - -Delete Bare Metal Node -====================== - -.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/os-baremetal-nodes/{node_id} - -Deletes a bare metal node from a server. - -Normal response codes: 202 - -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) - -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - - server_id: server_id - - node_id: node_id - -Response --------- - diff --git a/api-ref/source/os-consoles.inc b/api-ref/source/os-consoles.inc index 11420d8c8c..4d770d8553 100644 --- a/api-ref/source/os-consoles.inc +++ b/api-ref/source/os-consoles.inc @@ -54,7 +54,7 @@ Response **Example List consoles: JSON response** -.. literalinclude:: ../../doc/api_samples/os-consoles/consoles-list-get-resp.json +.. literalinclude:: ../../doc/api_samples/consoles/consoles-list-get-resp.json :language: javascript Show Console Details @@ -83,7 +83,7 @@ Response **Example List consoles: JSON response** -.. literalinclude:: ../../doc/api_samples/os-consoles/consoles-get-resp.json +.. literalinclude:: ../../doc/api_samples/consoles/consoles-get-resp.json :language: javascript Delete Console @@ -139,4 +139,3 @@ Response .. literalinclude:: ../../doc/api_samples/os-console-auth-tokens/get-console-connect-info-get-resp.json :language: javascript -