summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-03-17 10:10:01 +0000
committerGerrit Code Review <review@openstack.org>2017-03-17 10:10:01 +0000
commitdf0df78975cae9ea813e540d000a1816bdcbaaa7 (patch)
treec8a845681688a3c8c23ba970c2d77cd87278913d /api-ref
parentfbd8da59a16d42044b2ee734306d4716915cc164 (diff)
parent6529a2ebd7b46039feae45d7314d9764ce7ac4e8 (diff)
downloadheat-df0df78975cae9ea813e540d000a1816bdcbaaa7.tar.gz
Merge "Fix api-ref build with Sphinx 1.5"
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/v1/events.inc2
-rw-r--r--api-ref/source/v1/parameters.yaml20
-rw-r--r--api-ref/source/v1/samples/stack-outputs-list-response.json2
-rw-r--r--api-ref/source/v1/stack-templates.inc2
-rw-r--r--api-ref/source/v1/stacks.inc4
-rw-r--r--api-ref/source/v1/versions.inc2
6 files changed, 16 insertions, 16 deletions
diff --git a/api-ref/source/v1/events.inc b/api-ref/source/v1/events.inc
index 9980ba8de..a0f72ece2 100644
--- a/api-ref/source/v1/events.inc
+++ b/api-ref/source/v1/events.inc
@@ -97,7 +97,7 @@ Request Parameters
- stack_name: stack_name_url
Response Parameters
-------------------
+-------------------
.. rest_parameters:: parameters.yaml
diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml
index f2eea1b2b..6a5bdd462 100644
--- a/api-ref/source/v1/parameters.yaml
+++ b/api-ref/source/v1/parameters.yaml
@@ -48,16 +48,16 @@ output_key_url:
in: path
required: true
type: string
-resource_name_url:
+resource_name_or_physical_id_url:
description: |
- The name of a resource in the stack.
+ The name of a resource in the stack, or the ID of its underlying physical
+ resource.
in: path
required: true
type: string
-resource_name_or_physical_id_url:
+resource_name_url:
description: |
- The name of a resource in the stack, or the ID of its underlying physical
- resource.
+ The name of a resource in the stack.
in: path
required: true
type: string
@@ -717,7 +717,7 @@ files:
value provides the contents of the file. The following code shows
the general structure of this parameter.
- .. code-block:: json
+ .. code-block:: none
{ ...
"files": {
@@ -734,7 +734,7 @@ files:
map with the path to the file as the name and the file contents as
the value. So, a simple example looks like this:
- .. code-block:: json
+ .. code-block:: none
{
   "files": {
@@ -943,7 +943,7 @@ parameters:
In the example, ``a`` and ``b`` would be the names of two
parameters defined in the template.
- .. code-block:: json
+ .. code-block:: none
{ ...
"parameters": {
@@ -982,7 +982,7 @@ parameters:
map with the path to the file as the name and the file contents as
the value. So, a simple example looks like this:
- .. code-block:: json
+ .. code-block:: none
{
"files": {
@@ -1463,7 +1463,7 @@ template:
The content of the string is a JSON- or YAML-formatted Orchestration
template. For example:
- .. code-block:: json
+ .. code-block:: none
"template": {
"heat_template_version": "2013-05-23",
diff --git a/api-ref/source/v1/samples/stack-outputs-list-response.json b/api-ref/source/v1/samples/stack-outputs-list-response.json
index ce9fabebb..97f000aae 100644
--- a/api-ref/source/v1/samples/stack-outputs-list-response.json
+++ b/api-ref/source/v1/samples/stack-outputs-list-response.json
@@ -2,7 +2,7 @@
"outputs": [
{
"output_key": "output name",
- "description": "output description",
+ "description": "output description"
}
]
}
diff --git a/api-ref/source/v1/stack-templates.inc b/api-ref/source/v1/stack-templates.inc
index 0ee9856a3..e9b735871 100644
--- a/api-ref/source/v1/stack-templates.inc
+++ b/api-ref/source/v1/stack-templates.inc
@@ -81,7 +81,7 @@ Request Parameters
- template_version: template_version_url
Response Parameters
-------------------
+-------------------
.. rest_parameters:: parameters.yaml
diff --git a/api-ref/source/v1/stacks.inc b/api-ref/source/v1/stacks.inc
index 32537760b..241d21377 100644
--- a/api-ref/source/v1/stacks.inc
+++ b/api-ref/source/v1/stacks.inc
@@ -634,7 +634,7 @@ Request Parameters
- stack_identity: stack_identity
Response Parameters
-------------------
+-------------------
.. rest_parameters:: parameters.yaml
@@ -682,7 +682,7 @@ Request Parameters
- stack_id: stack_id_url
Response Parameters
-------------------
+-------------------
This request does not return anything in the response body.
diff --git a/api-ref/source/v1/versions.inc b/api-ref/source/v1/versions.inc
index 8fbcaa5e5..79bbd8836 100644
--- a/api-ref/source/v1/versions.inc
+++ b/api-ref/source/v1/versions.inc
@@ -24,7 +24,7 @@ Request Parameters
This operation does not accept a request body.
Response Parameters
-------------------
+-------------------
.. rest_parameters:: parameters.yaml