5 Commits

Author SHA1 Message Date
tengqm
fa39e4b1fd api-ref doc for stack (1)
This patch, as a first step, fixes inaccuracies/bugs in api-ref
documentation for stacks. The major changes in this patch include:

- Added missing 'location' and 'X-OpenStack-Request-Id' parameters
  which both appear in some response headers.
- Deleted some descriptions about parameters that are never
  referenced in any APIs.
- Added missing 'deletion_time' parameter.
- Added missing 'environment_files' parameter.
- Added missing sample JSON file for stack-create-response.json.
- Fixed errors in stack-preview-response.json.
- Added tabular description of response codes.
- Added a status.yaml file for response code description (shared).

Change-Id: I826ed899f925812df9b44144469700453789e087
2016-08-18 05:11:01 -04:00
tengqm
77927765a9 Split stack api-ref doc into three files
This patch splits the stacks.inc file into three files so that we can
patch them separately. The original file contains API calls about
stacks, stack snapshots and stack outputs, however, the latter two
have every right to be documented separately.

Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
huangtianhua
ccdb9c9ae6 Show 'deletion_time' for stack-list/stack-show apis
We support to get the deleted stacks by filter in stack-list
api, support to show the deleted stack by stack-id,
so to show the 'deletion_time' info of stacks.

Change-Id: I8c55fe7f6a899ca66aa3fef15c93195c03c5aa11
Closes-Bug: #1587214
2016-06-20 10:23:35 +08:00
huangtianhua
2b41589185 [api-ref] Correct stack-list api-ref
Add three parameters in response body of stack-list.

Change-Id: I4f48a24a665d4bd1bf87d0634190126bf82c8430
2016-06-17 15:57:51 +08: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