20 Commits

Author SHA1 Message Date
Zane Bitter
2cad992023 API ref: Update sample output of resource type APIs
Bring the API samples up to date with the current code.

Change-Id: I6a4d8dff6410227b653f25714fc0d468c76052d5
2020-01-07 12:46:47 -05:00
Steven Hardy
313faad5f1 Return Environment from validate_template
This is to enable preview of the merged environment
without merging the environment on the client side.

Related-Bug: #1635409
Change-Id: I7ec3af729a65164230153021f438bf226cc5e858
2017-11-14 17:35:52 +00:00
rabi
01b5878129 Add REST api support for cancel without rollback
We already have REST api support for cancelling a
UPDATE_IN_PROGRESS stack with rollback. This adds a
new action 'cancel_without_rollback' to allow for
canceling a create/update in_progress stack without
rollback.

APIImpact

Change-Id: I6c6ffa0502ab8745cfb2f9c5ef263f1e02dfc4ca
Closes-Bug: #1709041
2017-11-08 17:08:43 +05:30
Andreas Jaeger
6529a2ebd7 Fix api-ref build with Sphinx 1.5
Sphinx 1.5 is more picky about some code, it complaints if code-blocks
are not valid json and also about too short underlines.

Fix one json file, fix underlines, change code-blocks to none so that
Sphinx 1.5 builds this again.

Enable treating warnings as errors to avoid regressions. Note that with
current tools there are no double stanza warnings anymore.

Change-Id: I58d1452ffddf091d56dcfad8140caba084800a0e
2017-03-07 09:34:00 +00:00
huangtianhua
a3b1b172e8 Correct response of template-version-list
Change-Id: Id5cabce0806ba2423195450c27d00a905d32d13c
2016-12-14 15:35:18 +08: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
623c5a5354 api-ref - stack actions
This patch fixes problems found in api-ref documentation related
to stack actions and missing stack APIs. More specifically, this
include the following changes:

- Fix status code documentation about stack actions;
- Added response parameters for some actions although there is no
  body returned -- there are still header returned;
- Added documentation about stack-export API;
- Added documentation about stack-environment-show API;
- Added documentation about stack-files-show API;

Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-22 06:59:12 +00:00
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
2286eae3f3 api-ref - stack snapshots
This patch fixes problems in api-ref doc for stack snapshots releated
APIs. The specific changes include:

- Added response parameter/example for stack-restore API;
- Renamed stack-show-snapshot-response to stack-snapshot-show-response
  for consistency.
- Fixed parameter reference for software-config related to status
  and status_reason.
- Added missing docs for response codes.
- Removed some parameters which never appears in snapshot list calls;
- Reordered docs about API calls so the flow becomes: create, list,
  show, restore and delete.

Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-22 06:59:00 +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
959b5694df api-ref doc for stack (5)
This is the last patch concerning api-ref docs for stack resources. The
major changes are about stack-abandon, stack-adopt, template-show APIs.

Change-Id: I2af6e5ba653ac2dfa6a81478a17367bf4f661944
2016-08-18 23:52:38 -04:00
tengqm
772ef5ef89 api-ref doc for stack (4)
This patch fixes the api-ref documentation for stack resources. More
specifically, this patch fixes the documentation for the 'stack-update',
'stack-update-preview', 'stack-delete', 'stack-find-delete' calls.

Change-Id: Ie8987c49a758a161015d111a8cfa50b0fbda88f8
2016-08-18 09:50:16 -04:00
tengqm
a2a028be90 api-ref doc for stack (3)
Fix docs for stack-find, stack-show, stack-list APIs.
Major changes include:

- Revise stack query parameters to differentiate them from stack
  object body fields.
- Added 'resolve_outputs' to stack-find interface.
- Added response sample and documentation for stack-find API.
  We should faithfully document the 302 status code and body.
- Added missing parameter 'stacks' for stack-list call.
- Added missing 'X-Openstack-Request-Id' parameter in responses.

Change-Id: Ifc4937a254ff766ae83c80c009047d926eebf72f
2016-08-18 09:40:52 -04:00
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
1243dc3797 Fix software config api-ref doc
This patch adds the missing list operation on software configs. It also
reorders the operations on configs/deployments so that finding API docs
will be a little bit easier.

Change-Id: I26e4b34000b71c61f9d9de327c7754ff9031d6b4
2016-08-07 23:46:17 -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
pallavi
c3a83a8779 [api-ref] Added template-function-list
Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d
Closes-Bug: #1473814
2016-05-27 04:14:15 +00: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