65 Commits

Author SHA1 Message Date
Stephen Finucane
25f1cc2e25 Integrate pre-commit
Makes my life easier wrt testing.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I5a79494eb81622be5e56686a1995eb2f0bddb085
2023-03-22 17:16:30 +00:00
Ghanshyam Mann
157f358057 [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also replace policy.json to policy.yaml ref from doc and code.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: I1aa12bcd2638390f25d57ce8abeeec248121dc02
2021-06-17 01:35:45 +08:00
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
rabi
b40524d262 Add API doc for files_container support
Also adds releasenote for this new feature.

Change-Id: I6da965770f2a0583277165cc6f39ae57caf43d93
Story: #1755453
Task: 22714
2018-07-26 09:50:54 +05:30
Zuul
71c1a4bef0 Merge "Add environment_files parameter in CREATE_STACK request" 2018-04-12 06:43:04 +00:00
Atsushi Sasaki
d5bec26faa Fix some typos
s/X-Openstack-Reqeuest-Id/X-Openstack-Request-Id/

Change-Id: Ib35b941dbeedfd178a9ef89d4ef38d23e8c0e373
Closes-bug: #1739324
2018-02-09 15:42:58 +09:00
liyi
39ef517433 Add environment_files parameter in CREATE_STACK request
Actually, stack creation API needs environment_files parameter,
so I add environment_files in documentation.

Change-Id: Id1c5ea9917c0ab5ff8b6db982749d30a070f1d7d
2017-11-30 16:32:24 +08: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
ricolin
552f94b928 Add converge flag in stack update for observing on reality
Add converge parameter for stack update API and RPC call,
that allow triggering observe on reality. This will be
triggered by API call with converge argument (with True
or False value) within. This flag also works for resources
within nested stack.
Implements bp get-reality-for-resources

Change-Id: I151b575b714dcc9a5971a1573c126152ecd7ea93
2017-08-07 05:39:29 +00:00
Jenkins
a336742cb9 Merge "[api-ref] Correct config_id in url instead of in body" 2017-07-21 09:45:53 +00:00
liyi
76142b371c Change tags type from 'string' to 'array'
Type of tags in stack object is array, not string.

Change-Id: I934c3f0cc159126f43b0d0fcd0b5d9efc9c25390
2017-07-13 13:46:54 +08:00
huangtianhua
8f12072dcc [api-ref] Correct config_id in url instead of in body
Change-Id: I88ecfba9bb8b8337b39ea069912319d6770dd036
2017-07-06 19:52:26 +08:00
Jenkins
cba588a0b7 Merge "Modify 'List template functions' API response parameter." 2017-04-06 01:41:20 +00:00
Jenkins
df0df78975 Merge "Fix api-ref build with Sphinx 1.5" 2017-03-17 10:10:01 +00:00
huangtianhua
fd60876841 Put error response codes into 'error' group
Change-Id: I2cfdbd2aac4a41eca1c6954c3e22329f7ffe9b07
2017-03-15 15:00:55 +08:00
liyi
e2d8301a77 Modify 'List template functions' API response parameter.
Reponse parameter 'template_functions' missing description
in 'List template functions' API.

Change-Id: I8b9e2b4139e9c5d2e53b9269aee6ceb86484b619
Closes-Bug: #1672752
2017-03-15 12:52:51 +08:00
liyi
990f484962 Modify stack_name regular expression in Orchestration API
The stack_name in request must match some regular expression, but
the code implementation and document description is inconsistent.

Change-Id: I02c09d2624253d9ce19735dbe745ff4d3321332d
Closes-Bug: #1671126
2017-03-09 13:33:29 +08:00
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
Jenkins
adc8b36cb7 Merge "Make *_id/name_url required for api-ref" 2016-12-26 07:41:54 +00:00
Kevin_Zheng
94bdbee7bf Trivial fix some typos in api-ref
Found some typos while reading the api-ref site

TrivialFix

Change-Id: I2945c03f3740944558d968fdd13d96cff811b863
2016-12-23 15:44:43 +08:00
huangtianhua
13d2560513 Make *_id/name_url required for api-ref
There are some *_id/name_url parameters are marked
as optional, they are required in url path, change
to required.

Change-Id: I55dffb180f3a4aaa027a54776f6af3660c7c1ea2
2016-12-22 18:53:18 +08:00
huangtianhua
a3b1b172e8 Correct response of template-version-list
Change-Id: Id5cabce0806ba2423195450c27d00a905d32d13c
2016-12-14 15:35:18 +08:00
Tanvir Talukder
4e465402d0 Allow mark-unhealthy by physical resource ID
If the name passed into mark-unhealthy is not a valid resource name,
check if it is a valid resource id and retrieve the resource via id
instead of name.

Change-Id: Ie28ed102665b2c6379d1f55b7a02b76d05e38ddd
Co-Authored-By: Zane Bitter <zbitter@redhat.com>
Closes-Bug: #1635295
2016-12-05 14:58:20 -05:00
gengchc2
b3733f1e9c Fix typo 'duplcate' to 'duplicate' in status.yaml
TrivialFix

Change-Id: I39aed5274c7890ec0144a708b4c5a8c900f226ba
2016-09-23 11:24:56 +08:00
Jenkins
21e49dc9b5 Merge "[api-ref] Rewrite the Heat API version" 2016-09-07 11:55:42 +00:00
Ha Van Tu
cc9480699c Correcting parameter type
The type of parameter should be "array" instead of "list".

Change-Id: I2606204bed081d4b7413a6745773841dffce91a4
2016-09-05 17:41:02 +07:00
Ha Van Tu
a3df3f8335 [api-ref] Rewrite the Heat API version
This patch validate the header: Change redundant request parameters to
response parameters and add more parameters to response parameters table.
http://developer.openstack.org/api-ref/orchestration/
v1/?expanded=list-versions-detail

Change-Id: I392af2faa54940f93ce1344e5e880a5583099608
2016-08-31 17:31:07 +07:00
Nguyen Phuong An
b22cd9d2d3 Change type of X-Openstack-Request-Id
This patch changes type of 'X-Openstack-Request-Id' attribute from
UUID to string to uniform with all ID attributes.

Change-Id: I444a0f5e7cef77fa68bc869cb0ad003cf749679b
2016-08-29 14:44:21 +07:00
tengqm
654b3344b5 Fix problems left in api-ref
This patch fixes the known problems in api-ref docs:

- the patch update stack api is now documented;
- the patch update preview api is now documented;
- the unused parameters in 'parameters.yaml' are all removed;
- some incorrect references of parameters are fixed.

Change-Id: I89457c98f542304df788636e4ad3ace5d2e7deb5
2016-08-23 04:16:03 -04: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
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
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
5a43527d8e api-ref - stack identity usage in find calls
The Heat API for find-stack accepts either the stack name or the stack
UUID when retrieving the canonical URL for a stack resource. The
current documentation is inaccurate because it is described as only
accepting stack names.

Change-Id: Ic2dba4314d5fc7e8bef460e92d94b92f87635d71
2016-08-22 02:45:02 -04: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
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
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
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
Steve Baker
9af4a0acd8 Release note, api-ref for event list nested_depth
To document the feature for the spec-lite bug: #1588561

Change-Id: I466ebf159e4351f5e2d90cde298531803289ab4d
2016-08-04 12:18:31 +12: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