7 Commits

Author SHA1 Message Date
huangtianhua
8f12072dcc [api-ref] Correct config_id in url instead of in body
Change-Id: I88ecfba9bb8b8337b39ea069912319d6770dd036
2017-07-06 19:52:26 +08:00
tengqm
cd04e9e7af api-ref - software config status codes
This patch fixes the formatting of status codes returned from API calls.
This change is leveraging the new status_code stanza supported by new
version of os-api-ref library.

Change-Id: Ib108e04b08c88696eadabf7bc32b41f47c0ead80
2016-08-22 06:59:26 +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
8ee3e581d3 Fix api-ref doc for software deployment.
The current api documentation for software deployment is a mess. This
patch is an attempt to fix it.

Change-Id: I41da79865c2836e6750314497e910982bc5462a9
2016-08-08 03:04:43 -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
sharat.sharma
9ccb0946da Adding two parameters into Software configuration
This patch added two parameter: software_config and
software_deployments.
"software_config" add into "Create configuration" and
"Show configuration details".
"software_deployments" parameter add into "Show deployment details",
"Update deployment" and "Create deployment".

Change-Id: Iee5cb9affb5dd88cf8769bea20ff3934fcd43b07
Closes-Bug: #1567193
2016-05-11 13:36:11 +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