10 Commits

Author SHA1 Message Date
tengqm
654b3344b5 Fix problems left in api-ref
This patch fixes the known problems in api-ref docs:

- the patch update stack api is now documented;
- the patch update preview api is now documented;
- the unused parameters in 'parameters.yaml' are all removed;
- some incorrect references of parameters are fixed.

Change-Id: I89457c98f542304df788636e4ad3ace5d2e7deb5
2016-08-23 04:16:03 -04:00
tengqm
772c89770f api-ref - template version and functions
This patch fixes problems found in api-ref documentation about template
versions and template functions. The detailed changes include:

- Fixed status codes for the related APIs;
- Fixed response parameters which were missing in original doc;
- Fixed dcumentation about template-validate API where some request
  parameters were not documented.

Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-22 06:59:18 +00:00
tengqm
d130a726cd api-ref doc for stack (2)
This patch continues the fix to the api-ref doc for stack resource. To
ensure upcoming patches are not messing up the parameter defintions,
this patch is cleansing up the parameters that appear both in URLs and
request/response bodies: 'stack_id', 'stack_name', 'resource_name',
'event_id', 'snapshot_id', etc. These parameters sometimes are playing
different roles although the name is the same.
Other fixes included in this patch:

- added back the stack-outputs and stack-snapshots into index
- split resource-types out of stack-templates and add reference to it
  into index (git misunderstood this as a renaming, :))

Change-Id: I2b486a9b85d23d3225a5701c2265ecea2f4712f7
2016-08-18 05:58:24 -04:00
Jenkins
67e6f20967 Merge "[api-ref] Added template-function-list" 2016-06-01 11:34:13 +00:00
Jenkins
9c8393c024 Merge "template validate ignore errors api-ref update" 2016-05-30 10:52:51 +00:00
pallavi
c3a83a8779 [api-ref] Added template-function-list
Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d
Closes-Bug: #1473814
2016-05-27 04:14:15 +00:00
Peter Razumovsky
f5b64b3e4d Add to resource_schema returning description
Add to resource_schema command ability to return
resource description.

@APIImpact
@DocImpact

Change-Id: I148bb7764af4db45b75ce63d7fa58daa210b3ed4
Closes-bug: #1558049
2016-05-25 16:24:03 +03:00
Peter Razumovsky
42bfc8a282 Add to resource-type-list returning description
Add to resource-type-list command ability to return
resource description.

@APIImpact
@DocImpact

Change-Id: Ia92699e5ca60a891e9704c468e447e1053be7609
Closes-bug: #1558049
2016-05-25 16:10:34 +03:00
Kanagaraj Manickam
4635f666c4 template validate ignore errors api-ref update
api-ref is updated for template validate REST API
to provide details on the ignore_errors query
parameter.

Change-Id: I9e2911c7fbe708913b6f143c6d4e408b148ce672
2016-05-23 15:17:05 +05:30
Jay Dobies
4170566618 Migrate API documentations into the Heat tree
For more information, see:
http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html

This is the initial port from api-site. The includes in
source/v1/index.rst are alphabetized, but we may want to revisit that
and reorder them according to importance.

Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048
Implements: blueprint api-doc-migration
2016-05-04 15:46:28 -04:00