3 Commits

Author SHA1 Message Date
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
2c3def1b2f Fix api-ref generation errors
This patch fixes errors with the include directives generated by the
api-site team for the migration. This patch fixes the errors by bringing
our api-ref docs in line with the existing docs; verifying that the
previous docs are still valid will be a separate initiative.

Change-Id: Ibb7d57d8665dbfb655b2c3bd4a69fdc0f8a44d69
2016-05-16 12:17:06 -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