6 Commits

Author SHA1 Message Date
tengqm
50f38415da api-ref - events
This patch fixes problems found in stack/resource events APIs. There
were APIs not precisely documented.

Change-Id: Icb98c8406e1ff6428cb7d9af3f98d6f4982f3922
2016-08-22 06:59:06 +00:00
tengqm
81d92bebb3 api-ref - stack resources
This patch fixes the problems found in the api-ref doc for stack
resources. More specifically, changes include:
- Add 'physical_resource_id' as a query parameter;
- Add 'resource_id' as a query parameter;
- Add 'with_attr' parameter when showing resource;
- Add API doc for resource-mark-unhealthy;
- Add response parameters for resource-show-metadata API;
- Add missing fields such 'links', openstack-request-id in some responses.
- Add a special description for the 400 status code of resource-signal.

Change-Id: I6e6889e79f25431278e82b2c499267d8853470d1
2016-08-22 06:58:53 +00:00
tengqm
14a7304a62 api-ref - services/stack-outputs doc
This patch fixes inaccuracies/defects in the api-ref documentation for
services and stack-outputs.

Change-Id: I083607df0f5b72ee004e23d855df870a963c1578
2016-08-22 06:58:37 +00:00
tengqm
84b1d89a80 api-ref - build/resource-type/versions
This patch fixes the format and content of the api-ref documentation for
the build-info, resource-type-{list|template|schema}, versions APIs.
Major changes include:
- use status code table to show response codes
- add missing response parameters such as request id
- fixed cases where the response format was not clearly/correctly
  documented.

Change-Id: Id7ac58ff19d3f7a0feb4d872efa7b46c01fa8f4b
2016-08-22 02:24:59 -04: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
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