From 6f8cda2f397e50ddb4fe65fe1761a51f6c8ac8f9 Mon Sep 17 00:00:00 2001 From: ghanshyam Date: Tue, 19 Apr 2016 17:52:18 +0900 Subject: [PATCH] Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b --- api-ref/source/extensions.inc | 2 +- api-ref/source/flavors.inc | 8 +++---- api-ref/source/images.inc | 6 ++--- api-ref/source/ips.inc | 4 ++-- api-ref/source/limits.inc | 2 +- api-ref/source/metadata.inc | 10 ++++---- api-ref/source/os-agents.inc | 6 ++--- api-ref/source/os-aggregates.inc | 14 +++++------ .../source/os-assisted-volume-snapshots.inc | 2 +- api-ref/source/os-baremetal-nodes.inc | 8 +++---- api-ref/source/os-cells.inc | 8 +++---- api-ref/source/os-certificates.inc | 4 ++-- api-ref/source/os-cloudpipe.inc | 4 ++-- api-ref/source/os-fixed-ips.inc | 2 +- api-ref/source/os-flavor-access.inc | 6 ++--- api-ref/source/os-flavor-extra-specs.inc | 8 +++---- api-ref/source/os-floating-ip-dns.inc | 10 ++++---- api-ref/source/os-floating-ip-pools.inc | 2 +- api-ref/source/os-floating-ips-bulk.inc | 8 +++---- api-ref/source/os-floating-ips.inc | 6 ++--- api-ref/source/os-fping.inc | 4 ++-- api-ref/source/os-hosts.inc | 12 +++++----- api-ref/source/os-hypervisors.inc | 8 +++---- api-ref/source/os-instance-actions.inc | 4 ++-- .../source/os-instance-usage-audit-log.inc | 4 ++-- api-ref/source/os-interface.inc | 6 ++--- api-ref/source/os-keypairs.inc | 6 ++--- api-ref/source/os-migrations.inc | 2 +- api-ref/source/os-networks.inc | 6 ++--- api-ref/source/os-quota-sets.inc | 6 ++--- api-ref/source/os-server-external-events.inc | 2 +- api-ref/source/os-server-groups.inc | 6 ++--- api-ref/source/os-server-password.inc | 2 +- api-ref/source/os-services.inc | 8 +++---- api-ref/source/os-simple-tenant-usage.inc | 4 ++-- api-ref/source/os-tenant-network.inc | 6 ++--- api-ref/source/os-virtual-interfaces.inc | 2 +- api-ref/source/os-volumes.inc | 24 +++++++++---------- .../source/servers-action-remote-consoles.inc | 8 +++---- api-ref/source/servers-actions.inc | 2 +- api-ref/source/servers-multiple-create.inc | 8 +++---- api-ref/source/servers.inc | 9 ++++--- 42 files changed, 129 insertions(+), 130 deletions(-) diff --git a/api-ref/source/extensions.inc b/api-ref/source/extensions.inc index 8565ec5cc144..494081e78ab1 100644 --- a/api-ref/source/extensions.inc +++ b/api-ref/source/extensions.inc @@ -44,7 +44,7 @@ Response - description: description - updated: updated -**Example Show Extension Details: JSON request** +**Example Show Extension Details: JSON response** .. literalinclude:: ../../doc/api_samples/extensions/extension-show-resp.json :language: javascript diff --git a/api-ref/source/flavors.inc b/api-ref/source/flavors.inc index 49b017f9f95a..ade82620a8ce 100644 --- a/api-ref/source/flavors.inc +++ b/api-ref/source/flavors.inc @@ -40,7 +40,7 @@ Query Parameters Response -------- -**Example List Flavors: JSON request** +**Example List Flavors: JSON response** .. literalinclude:: ../../doc/api_samples/flavors/flavors-list-resp.json :language: javascript @@ -72,7 +72,7 @@ Request Response -------- -**Example Create Flavor: JSON request** +**Example Create Flavor: JSON response** .. literalinclude:: ../../doc/api_samples/flavors/flavor-create-resp.json :language: javascript @@ -100,7 +100,7 @@ Request Response -------- -**Example Show Flavor Details: JSON request** +**Example Show Flavor Details: JSON response** .. literalinclude:: ../../doc/api_samples/flavors/flavor-show-resp.json :language: javascript @@ -162,7 +162,7 @@ Query Parameters Response -------- -**Example List Flavors With Details: JSON request** +**Example List Flavors With Details: JSON response** .. literalinclude:: ../../doc/api_samples/flavors/flavors-list-detail-resp.json :language: javascript diff --git a/api-ref/source/images.inc b/api-ref/source/images.inc index f3937ab71f72..7c0a27d569ff 100644 --- a/api-ref/source/images.inc +++ b/api-ref/source/images.inc @@ -37,7 +37,7 @@ Request Response -------- -**Example Show Image Details: JSON request** +**Example Show Image Details: JSON response** .. literalinclude:: ../../doc/api_samples/images/image-show-resp.json :language: javascript @@ -89,7 +89,7 @@ Request Response -------- -**Example Show Image Metadata Item Details: JSON request** +**Example Show Image Metadata Item Details: JSON response** .. literalinclude:: ../../doc/api_samples/images/image-metadata-item-show-resp.json :language: javascript @@ -123,7 +123,7 @@ Request Response -------- -**Example Create Or Update Image Metadata Item: JSON request** +**Example Create Or Update Image Metadata Item: JSON response** .. literalinclude:: ../../doc/api_samples/images/image-metadata-item-update-resp.json :language: javascript diff --git a/api-ref/source/ips.inc b/api-ref/source/ips.inc index f4a83061f0d3..74ecd2b2e7f8 100644 --- a/api-ref/source/ips.inc +++ b/api-ref/source/ips.inc @@ -32,7 +32,7 @@ Request Response -------- -**Example List Ips: JSON request** +**Example List Ips: JSON response** .. literalinclude:: ../../doc/api_samples/ips/ips-resp.json :language: javascript @@ -63,7 +63,7 @@ Request Response -------- -**Example Show Ip Details: JSON request** +**Example Show Ip Details: JSON response** .. literalinclude:: ../../doc/api_samples/ips/ips-network-resp.json :language: javascript diff --git a/api-ref/source/limits.inc b/api-ref/source/limits.inc index 3df2812367b2..706b957d33a0 100644 --- a/api-ref/source/limits.inc +++ b/api-ref/source/limits.inc @@ -28,7 +28,7 @@ Request Response -------- -**Example Show Rate And Absolute Limits: JSON request** +**Example Show Rate And Absolute Limits: JSON response** .. literalinclude:: ../../doc/api_samples/limits/limits-get-resp.json :language: javascript diff --git a/api-ref/source/metadata.inc b/api-ref/source/metadata.inc index 2f5dc6b25a56..58f578c61fba 100644 --- a/api-ref/source/metadata.inc +++ b/api-ref/source/metadata.inc @@ -35,7 +35,7 @@ Request Response -------- -**Example List All Metadata: JSON request** +**Example List All Metadata: JSON response** .. literalinclude:: ../../doc/api_samples/metadata/server-metadata-list-resp.json :language: javascript @@ -72,7 +72,7 @@ Request Response -------- -**Example Create Or Replace Metadata Items: JSON request** +**Example Create Or Replace Metadata Items: JSON response** .. literalinclude:: ../../doc/api_samples/metadata/server-metadata-list-resp.json :language: javascript @@ -109,7 +109,7 @@ Request Response -------- -**Example Update Metadata Items: JSON request** +**Example Update Metadata Items: JSON response** .. literalinclude:: ../../doc/api_samples/metadata/server-metadata-list-resp.json :language: javascript @@ -140,7 +140,7 @@ Request Response -------- -**Example Show Metadata Item Details: JSON request** +**Example Show Metadata Item Details: JSON response** .. literalinclude:: ../../doc/api_samples/metadata/server-metadata-show-resp.json :language: javascript @@ -178,7 +178,7 @@ Request Response -------- -**Example Create Or Update Metadata Item: JSON request** +**Example Create Or Update Metadata Item: JSON response** .. literalinclude:: ../../doc/api_samples/metadata/server-metadata-item-show-resp.json :language: javascript diff --git a/api-ref/source/os-agents.inc b/api-ref/source/os-agents.inc index 341dd0346bff..9df30b1980f7 100644 --- a/api-ref/source/os-agents.inc +++ b/api-ref/source/os-agents.inc @@ -44,7 +44,7 @@ Request Response -------- -**Example Create Agent Build: JSON request** +**Example Create Agent Build: JSON response** .. literalinclude:: ../../doc/api_samples/os-agents/agent-create-resp.json :language: javascript @@ -77,7 +77,7 @@ Request Response -------- -**Example List Agent Builds: JSON request** +**Example List Agent Builds: JSON response** .. literalinclude:: ../../doc/api_samples/os-agents/agents-list-resp.json :language: javascript @@ -142,7 +142,7 @@ Response - md5hash: md5hash - version: version -**Example Update Agent Build: JSON request** +**Example Update Agent Build: JSON response** .. literalinclude:: ../../doc/api_samples/os-agents/agent-update-resp.json :language: javascript diff --git a/api-ref/source/os-aggregates.inc b/api-ref/source/os-aggregates.inc index 05aadeb437d8..24d1a278367f 100644 --- a/api-ref/source/os-aggregates.inc +++ b/api-ref/source/os-aggregates.inc @@ -35,7 +35,7 @@ Request Response -------- -**Example Create Aggregate: JSON request** +**Example Create Aggregate: JSON response** .. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-create-resp.json :language: javascript @@ -67,7 +67,7 @@ Request Response -------- -**Example List Aggregates: JSON request** +**Example List Aggregates: JSON response** .. literalinclude:: ../../doc/api_samples/os-aggregates/aggregates-list-resp.json :language: javascript @@ -100,7 +100,7 @@ Request Response -------- -**Example Show Aggregate Details: JSON request** +**Example Show Aggregate Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-show-resp.json :language: javascript @@ -156,7 +156,7 @@ Request Response -------- -**Example Update Aggregate: JSON request** +**Example Update Aggregate: JSON response** .. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-update-resp.json :language: javascript @@ -191,7 +191,7 @@ Request Response -------- -**Example Add Host: JSON request** +**Example Add Host: JSON response** .. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-add-host-resp.json :language: javascript @@ -226,7 +226,7 @@ Request Response -------- -**Example Create Or Update Aggregate Metadata: JSON request** +**Example Create Or Update Aggregate Metadata: JSON response** .. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-metadata-create-resp.json :language: javascript @@ -261,7 +261,7 @@ Request Response -------- -**Example Remove Host: JSON request** +**Example Remove Host: JSON response** .. literalinclude:: ../../doc/api_samples/os-aggregates/aggregate-remove-host-resp.json :language: javascript diff --git a/api-ref/source/os-assisted-volume-snapshots.inc b/api-ref/source/os-assisted-volume-snapshots.inc index a262c09306aa..1becbf99cfb1 100644 --- a/api-ref/source/os-assisted-volume-snapshots.inc +++ b/api-ref/source/os-assisted-volume-snapshots.inc @@ -48,7 +48,7 @@ Response - id: id - volume_id: volume_id -**Example Create Assisted Volume Snapshots: JSON request** +**Example Create Assisted Volume Snapshots: JSON response** .. literalinclude:: ../../doc/api_samples/os-assisted-volume-snapshots/snapshot-create-assisted-resp.json :language: javascript diff --git a/api-ref/source/os-baremetal-nodes.inc b/api-ref/source/os-baremetal-nodes.inc index 1d530991079c..72c203fc1d72 100644 --- a/api-ref/source/os-baremetal-nodes.inc +++ b/api-ref/source/os-baremetal-nodes.inc @@ -45,7 +45,7 @@ Request Response -------- -**Example Add Bare Metal Node: JSON request** +**Example Add Bare Metal Node: JSON response** .. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-create-resp.json :language: javascript @@ -78,7 +78,7 @@ Request Response -------- -**Example List Bare Metal Nodes: JSON request** +**Example List Bare Metal Nodes: JSON response** .. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-nodes-list-resp.json :language: javascript @@ -111,7 +111,7 @@ Request Response -------- -**Example Add Interface To Bare Metal Node: JSON request** +**Example Add Interface To Bare Metal Node: JSON response** .. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-resp.json :language: javascript @@ -172,7 +172,7 @@ Request Response -------- -**Example Show Bare Metal Node Details: JSON request** +**Example Show Bare Metal Node Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-show-resp.json :language: javascript diff --git a/api-ref/source/os-cells.inc b/api-ref/source/os-cells.inc index 615ef3caa9b0..759167833ba0 100644 --- a/api-ref/source/os-cells.inc +++ b/api-ref/source/os-cells.inc @@ -31,7 +31,7 @@ Request Response -------- -**Example List Cells: JSON request** +**Example List Cells: JSON response** .. literalinclude:: ../../doc/api_samples/os-cells/cells-list-resp.json :language: javascript @@ -60,7 +60,7 @@ Request Response -------- -**Example List Cells With Details: JSON request** +**Example List Cells With Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-cells/cells-list-empty-resp.json :language: javascript @@ -90,7 +90,7 @@ Request Response -------- -**Example Show Cell Data: JSON request** +**Example Show Cell Data: JSON response** .. literalinclude:: ../../doc/api_samples/os-cells/cell-show-resp.json :language: javascript @@ -120,7 +120,7 @@ Request Response -------- -**Example Show Cell Capacities: JSON request** +**Example Show Cell Capacities: JSON response** .. literalinclude:: ../../doc/api_samples/os-cells/cells-capacities-show-resp.json :language: javascript diff --git a/api-ref/source/os-certificates.inc b/api-ref/source/os-certificates.inc index 095640c6d159..de9f4aae8488 100644 --- a/api-ref/source/os-certificates.inc +++ b/api-ref/source/os-certificates.inc @@ -28,7 +28,7 @@ Request Response -------- -**Example Create Certificate: JSON request** +**Example Create Certificate: JSON response** .. literalinclude:: ../../doc/api_samples/os-certificates/certificate-create-resp.json :language: javascript @@ -56,7 +56,7 @@ Request Response -------- -**Example Show Certificate Details: JSON request** +**Example Show Certificate Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-certificates/certificate-show-root-resp.json :language: javascript diff --git a/api-ref/source/os-cloudpipe.inc b/api-ref/source/os-cloudpipe.inc index 506bf1230224..88cd0a7ad61f 100644 --- a/api-ref/source/os-cloudpipe.inc +++ b/api-ref/source/os-cloudpipe.inc @@ -28,7 +28,7 @@ Request Response -------- -**Example List Cloudpipes: JSON request** +**Example List Cloudpipes: JSON response** .. literalinclude:: ../../doc/api_samples/os-cloudpipe/cloud-pipe-show-resp.json :language: javascript @@ -61,7 +61,7 @@ Request Response -------- -**Example Create Cloudpipe: JSON request** +**Example Create Cloudpipe: JSON response** .. literalinclude:: ../../doc/api_samples/os-cloudpipe/cloud-pipe-create-resp.json :language: javascript diff --git a/api-ref/source/os-fixed-ips.inc b/api-ref/source/os-fixed-ips.inc index 7e3292bd0c9d..c1ebd4548c36 100644 --- a/api-ref/source/os-fixed-ips.inc +++ b/api-ref/source/os-fixed-ips.inc @@ -30,7 +30,7 @@ Request Response -------- -**Example Show Fixed Ip Details: JSON request** +**Example Show Fixed Ip Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-fixed-ips/fixedip-show-resp.json :language: javascript diff --git a/api-ref/source/os-flavor-access.inc b/api-ref/source/os-flavor-access.inc index 9e780d55d9f8..dd44729ba41c 100644 --- a/api-ref/source/os-flavor-access.inc +++ b/api-ref/source/os-flavor-access.inc @@ -32,7 +32,7 @@ Request Response -------- -**Example List Flavor Access Information For Given Flavor: JSON request** +**Example List Flavor Access Information For Given Flavor: JSON response** .. literalinclude:: ../../doc/api_samples/os-flavor-access/flavor-access-list-resp.json :language: javascript @@ -67,7 +67,7 @@ Request Response -------- -**Example Add Flavor Access To Tenant: JSON request** +**Example Add Flavor Access To Tenant: JSON response** .. literalinclude:: ../../doc/api_samples/os-flavor-access/flavor-access-add-resp.json :language: javascript @@ -102,7 +102,7 @@ Request Response -------- -**Example Remove Flavor Access From Tenant: JSON request** +**Example Remove Flavor Access From Tenant: JSON response** .. literalinclude:: ../../doc/api_samples/os-flavor-access/flavor-access-remove-resp.json :language: javascript diff --git a/api-ref/source/os-flavor-extra-specs.inc b/api-ref/source/os-flavor-extra-specs.inc index 9b5a114ea15e..3d4aec400001 100644 --- a/api-ref/source/os-flavor-extra-specs.inc +++ b/api-ref/source/os-flavor-extra-specs.inc @@ -35,7 +35,7 @@ Request Response -------- -**Example Create Extra Specs For A Flavor: JSON request** +**Example Create Extra Specs For A Flavor: JSON response** .. literalinclude:: ../../doc/api_samples/os-flavor-extra-specs/flavor-extra-spec-create-resp.json :language: javascript @@ -68,7 +68,7 @@ Request Response -------- -**Example List Extra Specs For A Flavor: JSON request** +**Example List Extra Specs For A Flavor: JSON response** .. literalinclude:: ../../doc/api_samples/os-flavor-extra-specs/flavor-extra-specs-list-resp.json :language: javascript @@ -97,7 +97,7 @@ Request Response -------- -**Example Show An Extra Spec For A Flavor: JSON request** +**Example Show An Extra Spec For A Flavor: JSON response** .. literalinclude:: ../../doc/api_samples/os-flavor-extra-specs/flavor-extra-spec-show-resp.json :language: javascript @@ -131,7 +131,7 @@ Request Response -------- -**Example Update An Extra Spec For A Flavor: JSON request** +**Example Update An Extra Spec For A Flavor: JSON response** .. literalinclude:: ../../doc/api_samples/os-flavor-extra-specs/flavor-extra-spec-update-resp.json :language: javascript diff --git a/api-ref/source/os-floating-ip-dns.inc b/api-ref/source/os-floating-ip-dns.inc index c9bba6794acc..e064c46d6e43 100644 --- a/api-ref/source/os-floating-ip-dns.inc +++ b/api-ref/source/os-floating-ip-dns.inc @@ -29,7 +29,7 @@ Request Response -------- -**Example List Dns Domains: JSON request** +**Example List Dns Domains: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-domains-list-resp.json :language: javascript @@ -62,7 +62,7 @@ Request Response -------- -**Example Create Or Update Dns Domain: JSON request** +**Example Create Or Update Dns Domain: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-resp.json :language: javascript @@ -119,7 +119,7 @@ Request Response -------- -**Example Create Or Update Dns Entry: JSON request** +**Example Create Or Update Dns Entry: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-resp.json :language: javascript @@ -148,7 +148,7 @@ Request Response -------- -**Example Find Unique Dns Entry: JSON request** +**Example Find Unique Dns Entry: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-show-resp.json :language: javascript @@ -201,7 +201,7 @@ Request Response -------- -**Example List Dns Entries: JSON request** +**Example List Dns Entries: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-by-ip-show-resp.json :language: javascript diff --git a/api-ref/source/os-floating-ip-pools.inc b/api-ref/source/os-floating-ip-pools.inc index f6c9f2853431..1826b04c5040 100644 --- a/api-ref/source/os-floating-ip-pools.inc +++ b/api-ref/source/os-floating-ip-pools.inc @@ -35,7 +35,7 @@ Response - floating_ip_pools: floating_ip_pools - name: name -**Example List Floating Ip Pools: JSON request** +**Example List Floating Ip Pools: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ip-pools/floatingippools-list-resp.json :language: javascript diff --git a/api-ref/source/os-floating-ips-bulk.inc b/api-ref/source/os-floating-ips-bulk.inc index ffcb92e1b1f3..205b0146eea6 100644 --- a/api-ref/source/os-floating-ips-bulk.inc +++ b/api-ref/source/os-floating-ips-bulk.inc @@ -31,7 +31,7 @@ Request Response -------- -**Example List Floating Ips: JSON request** +**Example List Floating Ips: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json :language: javascript @@ -64,7 +64,7 @@ Request Response -------- -**Example Create Floating Ips: JSON request** +**Example Create Floating Ips: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json :language: javascript @@ -97,7 +97,7 @@ Request Response -------- -**Example Bulk-Delete Floating Ips: JSON request** +**Example Bulk-Delete Floating Ips: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json :language: javascript @@ -125,7 +125,7 @@ Request Response -------- -**Example List Floating Ips By Host: JSON request** +**Example List Floating Ips By Host: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json :language: javascript diff --git a/api-ref/source/os-floating-ips.inc b/api-ref/source/os-floating-ips.inc index 443c6fab4aa0..d0d1c1562d39 100644 --- a/api-ref/source/os-floating-ips.inc +++ b/api-ref/source/os-floating-ips.inc @@ -51,7 +51,7 @@ Request Response -------- -**Example List Floating Ip Addresses: JSON request** +**Example List Floating Ip Addresses: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips/floating-ips-list-resp.json :language: javascript @@ -88,7 +88,7 @@ Request Response -------- -**Example Create (Allocate) Floating Ip Address: JSON request** +**Example Create (Allocate) Floating Ip Address: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips/floating-ip-create-resp.json :language: javascript @@ -118,7 +118,7 @@ Request Response -------- -**Example Show Floating Ip Address Details: JSON request** +**Example Show Floating Ip Address Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips/floating-ip-show-resp.json :language: javascript diff --git a/api-ref/source/os-fping.inc b/api-ref/source/os-fping.inc index c44fb8cd38cd..179136ad2d47 100644 --- a/api-ref/source/os-fping.inc +++ b/api-ref/source/os-fping.inc @@ -43,7 +43,7 @@ Query Parameters Response -------- -**Example Ping Instances: JSON request** +**Example Ping Instances: JSON response** .. literalinclude:: ../../doc/api_samples/os-fping/fping-instances-list-resp.json :language: javascript @@ -73,7 +73,7 @@ Request Response -------- -**Example Ping An Instance: JSON request** +**Example Ping An Instance: JSON response** .. literalinclude:: ../../doc/api_samples/os-fping/fping-instance-show-resp.json :language: javascript diff --git a/api-ref/source/os-hosts.inc b/api-ref/source/os-hosts.inc index e2a9541031d7..b4900dee1db0 100644 --- a/api-ref/source/os-hosts.inc +++ b/api-ref/source/os-hosts.inc @@ -30,7 +30,7 @@ Request Response -------- -**Example List Hosts: JSON request** +**Example List Hosts: JSON response** .. literalinclude:: ../../doc/api_samples/os-hosts/hosts-list-resp.json :language: javascript @@ -63,7 +63,7 @@ Request Response -------- -**Example Enable Host: JSON request** +**Example Enable Host: JSON response** .. literalinclude:: ../../doc/api_samples/os-hosts/host-put-maintenance-resp.json :language: javascript @@ -91,7 +91,7 @@ Request Response -------- -**Example Show Host Details: JSON request** +**Example Show Host Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-hosts/host-get-resp.json :language: javascript @@ -119,7 +119,7 @@ Request Response -------- -**Example Reboot Host: JSON request** +**Example Reboot Host: JSON response** .. literalinclude:: ../../doc/api_samples/os-hosts/host-get-reboot.json :language: javascript @@ -147,7 +147,7 @@ Request Response -------- -**Example Shut Down Host: JSON request** +**Example Shut Down Host: JSON response** .. literalinclude:: ../../doc/api_samples/os-hosts/host-get-shutdown.json :language: javascript @@ -175,7 +175,7 @@ Request Response -------- -**Example Start Host: JSON request** +**Example Start Host: JSON response** .. literalinclude:: ../../doc/api_samples/os-hosts/host-get-startup.json :language: javascript diff --git a/api-ref/source/os-hypervisors.inc b/api-ref/source/os-hypervisors.inc index f1eb72b52b54..d23e4efdab49 100644 --- a/api-ref/source/os-hypervisors.inc +++ b/api-ref/source/os-hypervisors.inc @@ -30,7 +30,7 @@ Request Response -------- -**Example List Hypervisors: JSON request** +**Example List Hypervisors: JSON response** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisors-list-resp.json :language: javascript @@ -57,7 +57,7 @@ Request Response -------- -**Example Show Hypervisor Statistics: JSON request** +**Example Show Hypervisor Statistics: JSON response** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-statistics-show-resp.json :language: javascript @@ -85,7 +85,7 @@ Request Response -------- -**Example Show Hypervisor Details: JSON request** +**Example Show Hypervisor Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-show-resp.json :language: javascript @@ -113,7 +113,7 @@ Request Response -------- -**Example Show Hypervisor Uptime: JSON request** +**Example Show Hypervisor Uptime: JSON response** .. literalinclude:: ../../doc/api_samples/os-hypervisors/hypervisor-uptime-show-resp.json :language: javascript diff --git a/api-ref/source/os-instance-actions.inc b/api-ref/source/os-instance-actions.inc index 8defb2b0e05f..6a6a7983d570 100644 --- a/api-ref/source/os-instance-actions.inc +++ b/api-ref/source/os-instance-actions.inc @@ -32,7 +32,7 @@ Request Response -------- -**Example List Actions For Server: JSON request** +**Example List Actions For Server: JSON response** .. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-actions-list-resp.json :language: javascript @@ -61,7 +61,7 @@ Request Response -------- -**Example Show Server Action Details: JSON request** +**Example Show Server Action Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-action-show-resp.json :language: javascript diff --git a/api-ref/source/os-instance-usage-audit-log.inc b/api-ref/source/os-instance-usage-audit-log.inc index b2590ce453b0..6a4ddb23b407 100644 --- a/api-ref/source/os-instance-usage-audit-log.inc +++ b/api-ref/source/os-instance-usage-audit-log.inc @@ -28,7 +28,7 @@ Request Response -------- -**Example List Usage Audits For An Instance: JSON request** +**Example List Usage Audits For An Instance: JSON response** .. literalinclude:: ../../doc/api_samples/os-instance-usage-audit-log/usage-audits-list-resp.json :language: javascript @@ -62,7 +62,7 @@ Query Parameters Response -------- -**Example List Usage Audits Before Specified Time: JSON request** +**Example List Usage Audits Before Specified Time: JSON response** .. literalinclude:: ../../doc/api_samples/os-instance-usage-audit-log/usage-audits-log-list-resp.json :language: javascript diff --git a/api-ref/source/os-interface.inc b/api-ref/source/os-interface.inc index aaafd486cc07..036b1e1b76c5 100644 --- a/api-ref/source/os-interface.inc +++ b/api-ref/source/os-interface.inc @@ -49,7 +49,7 @@ Response - port_id: port_id - port_state: port_state -**Example Create Interface: JSON request** +**Example Create Interface: JSON response** .. literalinclude:: ../../doc/api_samples/os-interface/port-interface-create-resp.json :language: javascript @@ -86,7 +86,7 @@ Response - net_id: net_id - port_id: port_id -**Example List Port Interfaces: JSON request** +**Example List Port Interfaces: JSON response** .. literalinclude:: ../../doc/api_samples/os-interface/port-interfaces-list-resp.json :language: javascript @@ -115,7 +115,7 @@ Request Response -------- -**Example Show Port Interface Details: JSON request** +**Example Show Port Interface Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-interface/port-interface-show-resp.json :language: javascript diff --git a/api-ref/source/os-keypairs.inc b/api-ref/source/os-keypairs.inc index 4edaa09fcd6a..234960138384 100644 --- a/api-ref/source/os-keypairs.inc +++ b/api-ref/source/os-keypairs.inc @@ -28,7 +28,7 @@ Request Response -------- -**Example List Keypairs: JSON request** +**Example List Keypairs: JSON response** .. literalinclude:: ../../doc/api_samples/os-keypairs/keypairs-list-resp.json :language: javascript @@ -62,7 +62,7 @@ Request Response -------- -**Example Create Or Import Keypair: JSON request** +**Example Create Or Import Keypair: JSON response** .. literalinclude:: ../../doc/api_samples/os-keypairs/keypair-import-resp.json :language: javascript @@ -113,7 +113,7 @@ Request Response -------- -**Example Show Keypair Details: JSON request** +**Example Show Keypair Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-keypairs/keypair-show-resp.json :language: javascript diff --git a/api-ref/source/os-migrations.inc b/api-ref/source/os-migrations.inc index f9236f471eff..5dc657bde99b 100644 --- a/api-ref/source/os-migrations.inc +++ b/api-ref/source/os-migrations.inc @@ -30,7 +30,7 @@ Request Response -------- -**Example List Migrations: JSON request** +**Example List Migrations: JSON response** .. literalinclude:: ../../doc/api_samples/os-migrations/migrations-list-resp.json :language: javascript diff --git a/api-ref/source/os-networks.inc b/api-ref/source/os-networks.inc index 202097431461..c0c61759efd0 100644 --- a/api-ref/source/os-networks.inc +++ b/api-ref/source/os-networks.inc @@ -40,7 +40,7 @@ Request Response -------- -**Example Create Network: JSON request** +**Example Create Network: JSON response** .. literalinclude:: ../../doc/api_samples/os-networks/network-create-resp.json :language: javascript @@ -69,7 +69,7 @@ Request Response -------- -**Example List Networks: JSON request** +**Example List Networks: JSON response** .. literalinclude:: ../../doc/api_samples/os-networks/networks-list-resp.json :language: javascript @@ -128,7 +128,7 @@ Request Response -------- -**Example Show Network Details: JSON request** +**Example Show Network Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-networks/network-show-resp.json :language: javascript diff --git a/api-ref/source/os-quota-sets.inc b/api-ref/source/os-quota-sets.inc index 9ea34008fa15..8a4ab00590c2 100644 --- a/api-ref/source/os-quota-sets.inc +++ b/api-ref/source/os-quota-sets.inc @@ -85,7 +85,7 @@ Response - server_groups: server_groups - server_group_members: server_group_members -**Example Update Quotas: JSON request** +**Example Update Quotas: JSON response** .. literalinclude:: ../../doc/api_samples/os-quota-sets/quota-update-resp.json :language: javascript @@ -168,7 +168,7 @@ Response - server_groups: server_groups - server_group_members: server_group_members -**Example Show A Quota: JSON request** +**Example Show A Quota: JSON response** .. literalinclude:: ../../doc/api_samples/os-quota-sets/user-quotas-show-get-.json :language: javascript @@ -217,7 +217,7 @@ Response - server_groups: server_groups - server_group_members: server_group_members -**Example List Default Quotas For Tenant: JSON request** +**Example List Default Quotas For Tenant: JSON response** .. literalinclude:: ../../doc/api_samples/os-quota-sets/quotas-default-list-resp.json :language: javascript diff --git a/api-ref/source/os-server-external-events.inc b/api-ref/source/os-server-external-events.inc index 8c9706fca649..a346b6224817 100644 --- a/api-ref/source/os-server-external-events.inc +++ b/api-ref/source/os-server-external-events.inc @@ -50,7 +50,7 @@ Response - status: status - tag: tag -**Example Run Events: JSON request** +**Example Run Events: JSON response** .. literalinclude:: ../../doc/api_samples/os-server-external-events/event-create-resp.json :language: javascript diff --git a/api-ref/source/os-server-groups.inc b/api-ref/source/os-server-groups.inc index f18468758f66..e74cec5aaee2 100644 --- a/api-ref/source/os-server-groups.inc +++ b/api-ref/source/os-server-groups.inc @@ -48,7 +48,7 @@ Response - project_id: project_id - user_id: user_id -**Example List Server Groups: JSON request** +**Example List Server Groups: JSON response** .. literalinclude:: ../../doc/api_samples/os-server-groups/server-groups-list-resp.json :language: javascript @@ -93,7 +93,7 @@ Response - project_id: project_id - user_id: user_id -**Example Create Server Group: JSON request** +**Example Create Server Group: JSON response** .. literalinclude:: ../../doc/api_samples/os-server-groups/server-group-create-resp.json :language: javascript @@ -132,7 +132,7 @@ Response - project_id: project_id - user_id: user_id -**Example Show Server Group Details: JSON request** +**Example Show Server Group Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-server-groups/server-group-show-resp.json :language: javascript diff --git a/api-ref/source/os-server-password.inc b/api-ref/source/os-server-password.inc index d1f9a9c01308..60f4e19d4e07 100644 --- a/api-ref/source/os-server-password.inc +++ b/api-ref/source/os-server-password.inc @@ -35,7 +35,7 @@ Request Response -------- -**Example Show Server Password: JSON request** +**Example Show Server Password: JSON response** .. literalinclude:: ../../doc/api_samples/os-server-password/password-show-resp.json :language: javascript diff --git a/api-ref/source/os-services.inc b/api-ref/source/os-services.inc index 0eddea7c8e16..2f2ef279612e 100644 --- a/api-ref/source/os-services.inc +++ b/api-ref/source/os-services.inc @@ -48,7 +48,7 @@ Response - forced_down: forced_down - zone: zone -**Example List Compute Services: JSON request** +**Example List Compute Services: JSON response** .. literalinclude:: ../../doc/api_samples/v2.11/services-list-resp.json :language: javascript @@ -91,7 +91,7 @@ Response - host: host - status: status -**Example Enable Scheduling For A Compute Service: JSON request** +**Example Enable Scheduling For A Compute Service: JSON response** .. literalinclude:: ../../doc/api_samples/v2.11/service-enable-put-resp.json :language: javascript @@ -134,7 +134,7 @@ Response - host: host - status: status -**Example Disable Scheduling For A Compute Service: JSON request** +**Example Disable Scheduling For A Compute Service: JSON response** .. literalinclude:: ../../doc/api_samples/os-services/service-disable-put-resp.json :language: javascript @@ -179,7 +179,7 @@ Response - host: host - status: status -**Example Log Disabled Compute Service Information: JSON request** +**Example Log Disabled Compute Service Information: JSON response** .. literalinclude:: ../../doc/api_samples/os-services/service-disable-log-put-resp.json :language: javascript diff --git a/api-ref/source/os-simple-tenant-usage.inc b/api-ref/source/os-simple-tenant-usage.inc index f5a02c7b4cc4..3bae0b2ddc91 100644 --- a/api-ref/source/os-simple-tenant-usage.inc +++ b/api-ref/source/os-simple-tenant-usage.inc @@ -28,7 +28,7 @@ Request Response -------- -**Example List Tenant Usage For All Tenants: JSON request** +**Example List Tenant Usage For All Tenants: JSON response** .. literalinclude:: ../../doc/api_samples/os-simple-tenant-usage/simple-tenant-usage-show-general-resp.json :language: javascript @@ -55,7 +55,7 @@ Request Response -------- -**Example Show Usage Details For Tenant: JSON request** +**Example Show Usage Details For Tenant: JSON response** .. literalinclude:: ../../doc/api_samples/os-simple-tenant-usage/simple-tenant-usage-show-resp.json :language: javascript diff --git a/api-ref/source/os-tenant-network.inc b/api-ref/source/os-tenant-network.inc index de3903259cf0..4e84cdfa1438 100644 --- a/api-ref/source/os-tenant-network.inc +++ b/api-ref/source/os-tenant-network.inc @@ -35,7 +35,7 @@ Request Response -------- -**Example Create Project Network: JSON request** +**Example Create Project Network: JSON response** .. literalinclude:: ../../doc/api_samples/os-tenant-networks/network-create-resp.json :language: javascript @@ -64,7 +64,7 @@ Request Response -------- -**Example List Project Networks: JSON request** +**Example List Project Networks: JSON response** .. literalinclude:: ../../doc/api_samples/os-networks/networks-list-resp.json :language: javascript @@ -94,7 +94,7 @@ Request Response -------- -**Example Show Project Network Details: JSON request** +**Example Show Project Network Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-tenant-networks/network-show-resp.json :language: javascript diff --git a/api-ref/source/os-virtual-interfaces.inc b/api-ref/source/os-virtual-interfaces.inc index 4d7f2c089db9..1fc072faaeef 100644 --- a/api-ref/source/os-virtual-interfaces.inc +++ b/api-ref/source/os-virtual-interfaces.inc @@ -43,7 +43,7 @@ Response - id: id - mac_address: mac_address -**Example List Virtual Interfaces: JSON request** +**Example List Virtual Interfaces: JSON response** .. literalinclude:: ../../doc/api_samples/os-virtual-interfaces/vifs-list-resp.json :language: javascript diff --git a/api-ref/source/os-volumes.inc b/api-ref/source/os-volumes.inc index 7c3134fd21aa..497193ea55a0 100644 --- a/api-ref/source/os-volumes.inc +++ b/api-ref/source/os-volumes.inc @@ -28,7 +28,7 @@ Request Response -------- -**Example List Volumes: JSON request** +**Example List Volumes: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/volumes-list-resp.json :language: javascript @@ -68,7 +68,7 @@ Request Response -------- -**Example Create Volume: JSON request** +**Example Create Volume: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/volume-show-resp.json :language: javascript @@ -95,7 +95,7 @@ Request Response -------- -**Example List Volumes With Details: JSON request** +**Example List Volumes With Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/volumes-list-detail-resp.json :language: javascript @@ -123,7 +123,7 @@ Request Response -------- -**Example Show Volume Details: JSON request** +**Example Show Volume Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/volume-show-resp.json :language: javascript @@ -151,7 +151,7 @@ Request Response -------- -**Example Delete Volume: JSON request** +**Example Delete Volume: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/volume-delete-json-http.txt :language: javascript @@ -185,7 +185,7 @@ Response - name: name - extra_specs: extra_specs -**Example List Volume Types: JSON request** +**Example List Volume Types: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/volume-types-list-resp.json :language: javascript @@ -213,7 +213,7 @@ Request Response -------- -**Example Show Volume Type Details: JSON request** +**Example Show Volume Type Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/volume-type-show-resp.json :language: javascript @@ -246,7 +246,7 @@ Request Response -------- -**Example Create Snapshot: JSON request** +**Example Create Snapshot: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/snapshot-show-resp.json :language: javascript @@ -273,7 +273,7 @@ Request Response -------- -**Example List Snapshots: JSON request** +**Example List Snapshots: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/snapshots-list-resp.json :language: javascript @@ -300,7 +300,7 @@ Request Response -------- -**Example List Snapshots With Details: JSON request** +**Example List Snapshots With Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/snapshots-list-resp.json :language: javascript @@ -328,7 +328,7 @@ Request Response -------- -**Example Show Snapshot Details: JSON request** +**Example Show Snapshot Details: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/snapshot-show-resp.json :language: javascript @@ -358,7 +358,7 @@ Request Response -------- -**Example Delete Snapshot: JSON request** +**Example Delete Snapshot: JSON response** .. literalinclude:: ../../doc/api_samples/os-volumes/snapshot-delete-json-http.txt :language: javascript diff --git a/api-ref/source/servers-action-remote-consoles.inc b/api-ref/source/servers-action-remote-consoles.inc index 815a1422ea41..64e43a7c6f37 100644 --- a/api-ref/source/servers-action-remote-consoles.inc +++ b/api-ref/source/servers-action-remote-consoles.inc @@ -31,7 +31,7 @@ Request Response -------- -**Example Get Rdp Console (Os-Getrdpconsole Action): JSON request** +**Example Get Rdp Console (Os-Getrdpconsole Action): JSON response** .. literalinclude:: ../../doc/api_samples/servers-action/getRDPConsole-create-resp.json :language: javascript @@ -67,7 +67,7 @@ Request Response -------- -**Example Get Serial Console (Os-Getserialconsole Action): JSON request** +**Example Get Serial Console (Os-Getserialconsole Action): JSON response** .. literalinclude:: ../../doc/api_samples/servers-action/getSerialConsole-create-resp.json :language: javascript @@ -103,7 +103,7 @@ Request Response -------- -**Example Get Spice Console (Os-Getspiceconsole Action): JSON request** +**Example Get Spice Console (Os-Getspiceconsole Action): JSON response** .. literalinclude:: ../../doc/api_samples/servers-action/getSPICEConsole-create-resp.json :language: javascript @@ -139,7 +139,7 @@ Request Response -------- -**Example Get Vnc Console (Os-Getvncconsole Action): JSON request** +**Example Get Vnc Console (Os-Getvncconsole Action): JSON response** .. literalinclude:: ../../doc/api_samples/servers-action/getVNCConsole-create-resp.json :language: javascript diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc index 4aa41020a444..ac9927176f9a 100644 --- a/api-ref/source/servers-actions.inc +++ b/api-ref/source/servers-actions.inc @@ -360,7 +360,7 @@ Preserving the ephemeral disk Response -------- -**Example Rebuild Server (Rebuild Action): JSON request** +**Example Rebuild Server (Rebuild Action): JSON response** .. literalinclude:: ../../doc/api_samples/servers/server-action-rebuild.json :language: javascript diff --git a/api-ref/source/servers-multiple-create.inc b/api-ref/source/servers-multiple-create.inc index 81dbb4ffac3b..d7f76ebc8e70 100644 --- a/api-ref/source/servers-multiple-create.inc +++ b/api-ref/source/servers-multiple-create.inc @@ -55,7 +55,7 @@ Request - OS-DCF:diskConfig: OS-DCF:diskConfig - return_reservation_id: return_reservation_id -**Example Create multiple servers without reservation ID** +**Example Create multiple servers without reservation ID: JSON request** .. literalinclude:: ../../doc/api_samples/os-multiple-create/multiple-create-no-resv-post-resp.json :language: javascript @@ -72,7 +72,7 @@ Response - OS-DCF:diskConfig: OS-DCF:diskConfig - security_groups: security_groups -**Example Create multiple servers without reservation ID** +**Example Create multiple servers without reservation ID: JSON response** .. literalinclude:: ../../doc/api_samples/servers/server-create-resp.json :language: javascript @@ -123,7 +123,7 @@ Request - OS-DCF:diskConfig: OS-DCF:diskConfig - return_reservation_id: return_reservation_id -**Example Create multiple servers with reservation ID** +**Example Create multiple servers with reservation ID: JSON request** .. literalinclude:: ../../doc/api_samples/os-multiple-create/multiple-create-post-req.json :language: javascript @@ -135,7 +135,7 @@ Response - reservation_id: reservation_id -**Example Create multiple servers with reservation ID** +**Example Create multiple servers with reservation ID: JSON response** .. literalinclude:: ../../doc/api_samples/os-multiple-create/multiple-create-post-resp.json :language: javascript diff --git a/api-ref/source/servers.inc b/api-ref/source/servers.inc index 8bd2bde156d7..c4288b7aeeaf 100644 --- a/api-ref/source/servers.inc +++ b/api-ref/source/servers.inc @@ -172,7 +172,7 @@ Response - links: links - name: server_name -**Example List Servers: JSON request** +**Example List Servers: JSON response** .. literalinclude:: ../../doc/api_samples/servers/servers-list-resp.json :language: javascript @@ -292,7 +292,7 @@ Response - OS-DCF:diskConfig: OS-DCF:diskConfig - security_groups: security_groups -**Example Create Server: JSON request** +**Example Create Server: JSON response** .. literalinclude:: ../../doc/api_samples/servers/server-create-resp.json :language: javascript @@ -379,8 +379,7 @@ Response - updated: updated - user_id: user_id -Example Response ----------------- +**Example List Servers Detailed: JSON response** .. literalinclude:: /../../doc/api_samples/servers/servers-details-resp.json :language: javascript @@ -459,7 +458,7 @@ Response - updated: updated - user_id: user_id -**Example Show Server Details: JSON request** +**Example Show Server Details: JSON response** .. literalinclude:: ../../doc/api_samples/servers/server-get-resp.json :language: javascript