From d8f9d2328ea2ce965b45096736f6c2b4bd647eaa Mon Sep 17 00:00:00 2001 From: ghanshyam Date: Tue, 19 Apr 2016 19:32:48 +0900 Subject: [PATCH] Fix api ref for ips, limits, metdata and agent This patch fix API ref for correct sample files and status code for below APIs - ips - limits - server metadata - agents Part of bp:api-ref-in-rst Change-Id: I91b769eefde78381dc0feb6b5c8c6cf753203732 --- api-ref/source/ips.inc | 4 ++-- api-ref/source/limits.inc | 2 +- api-ref/source/metadata.inc | 16 ++++++++-------- api-ref/source/os-agents.inc | 14 +++++++------- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/api-ref/source/ips.inc b/api-ref/source/ips.inc index f4a83061f0..321be736d4 100644 --- a/api-ref/source/ips.inc +++ b/api-ref/source/ips.inc @@ -34,7 +34,7 @@ Response **Example List Ips: JSON request** -.. literalinclude:: ../../doc/api_samples/ips/ips-resp.json +.. literalinclude:: ../../doc/api_samples/server-ips/server-ips-resp.json :language: javascript Show Ip Details @@ -65,6 +65,6 @@ Response **Example Show Ip Details: JSON request** -.. literalinclude:: ../../doc/api_samples/ips/ips-network-resp.json +.. literalinclude:: ../../doc/api_samples/server-ips/server-ips-network-resp.json :language: javascript diff --git a/api-ref/source/limits.inc b/api-ref/source/limits.inc index 3df2812367..5a6de58635 100644 --- a/api-ref/source/limits.inc +++ b/api-ref/source/limits.inc @@ -30,6 +30,6 @@ Response **Example Show Rate And Absolute Limits: JSON request** -.. literalinclude:: ../../doc/api_samples/limits/limits-get-resp.json +.. literalinclude:: ../../doc/api_samples/limits/limit-get-resp.json :language: javascript diff --git a/api-ref/source/metadata.inc b/api-ref/source/metadata.inc index 2f5dc6b25a..01fb82a5f2 100644 --- a/api-ref/source/metadata.inc +++ b/api-ref/source/metadata.inc @@ -37,7 +37,7 @@ Response **Example List All Metadata: JSON request** -.. literalinclude:: ../../doc/api_samples/metadata/server-metadata-list-resp.json +.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json :language: javascript Create Or Replace Metadata Items @@ -66,7 +66,7 @@ Request **Example Create Or Replace Metadata Items: JSON request** -.. literalinclude:: ../../doc/api_samples/metadata/server-metadata-create-req.json +.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json :language: javascript Response @@ -74,7 +74,7 @@ Response **Example Create Or Replace Metadata Items: JSON request** -.. literalinclude:: ../../doc/api_samples/metadata/server-metadata-list-resp.json +.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json :language: javascript Update Metadata Items @@ -103,7 +103,7 @@ Request **Example Update Metadata Items: JSON request** -.. literalinclude:: ../../doc/api_samples/metadata/server-metadata-create-req.json +.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json :language: javascript Response @@ -111,7 +111,7 @@ Response **Example Update Metadata Items: JSON request** -.. literalinclude:: ../../doc/api_samples/metadata/server-metadata-list-resp.json +.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json :language: javascript Show Metadata Item Details @@ -142,7 +142,7 @@ Response **Example Show Metadata Item Details: JSON request** -.. literalinclude:: ../../doc/api_samples/metadata/server-metadata-show-resp.json +.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json :language: javascript Create Or Update Metadata Item @@ -172,7 +172,7 @@ Request **Example Create Or Update Metadata Item: JSON request** -.. literalinclude:: ../../doc/api_samples/metadata/server-metadata-item-update-req.json +.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-req.json :language: javascript Response @@ -180,7 +180,7 @@ Response **Example Create Or Update Metadata Item: JSON request** -.. literalinclude:: ../../doc/api_samples/metadata/server-metadata-item-show-resp.json +.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json :language: javascript Delete Metadata Item diff --git a/api-ref/source/os-agents.inc b/api-ref/source/os-agents.inc index 341dd0346b..7901682032 100644 --- a/api-ref/source/os-agents.inc +++ b/api-ref/source/os-agents.inc @@ -18,7 +18,7 @@ Create Agent Build Creates an agent build. -Normal response codes: 201 +Normal response codes: 200 Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) @@ -38,7 +38,7 @@ Request **Example Create Agent Build: JSON request** -.. literalinclude:: ../../doc/api_samples/os-agents/agent-create-req.json +.. literalinclude:: ../../doc/api_samples/os-agents/agent-post-req.json :language: javascript Response @@ -46,7 +46,7 @@ Response **Example Create Agent Build: JSON request** -.. literalinclude:: ../../doc/api_samples/os-agents/agent-create-resp.json +.. literalinclude:: ../../doc/api_samples/os-agents/agent-post-resp.json :language: javascript List Agent Builds @@ -79,7 +79,7 @@ Response **Example List Agent Builds: JSON request** -.. literalinclude:: ../../doc/api_samples/os-agents/agents-list-resp.json +.. literalinclude:: ../../doc/api_samples/os-agents/agents-get-resp.json :language: javascript Delete Agent Build @@ -89,7 +89,7 @@ Delete Agent Build Deletes an existing agent build. -Normal response codes: 202 +Normal response codes: 200 Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) @@ -129,7 +129,7 @@ Request **Example Update Agent Build: JSON request** -.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-req.json +.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-put-req.json :language: javascript Response @@ -144,6 +144,6 @@ Response **Example Update Agent Build: JSON request** -.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-resp.json +.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-put-resp.json :language: javascript