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
Actually, stack creation API needs environment_files parameter,
so I add environment_files in documentation.
Change-Id: Id1c5ea9917c0ab5ff8b6db982749d30a070f1d7d
This is to enable preview of the merged environment
without merging the environment on the client side.
Related-Bug: #1635409
Change-Id: I7ec3af729a65164230153021f438bf226cc5e858
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
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
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
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
There are some *_id/name_url parameters are marked
as optional, they are required in url path, change
to required.
Change-Id: I55dffb180f3a4aaa027a54776f6af3660c7c1ea2
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
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
This patch changes type of 'X-Openstack-Request-Id' attribute from
UUID to string to uniform with all ID attributes.
Change-Id: I444a0f5e7cef77fa68bc869cb0ad003cf749679b
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
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
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
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
This patch fixes problems found in stack/resource events APIs. There
were APIs not precisely documented.
Change-Id: Icb98c8406e1ff6428cb7d9af3f98d6f4982f3922
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
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
This patch fixes inaccuracies/defects in the api-ref documentation for
services and stack-outputs.
Change-Id: I083607df0f5b72ee004e23d855df870a963c1578
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
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
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
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
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
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
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
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
The current api documentation for software deployment is a mess. This
patch is an attempt to fix it.
Change-Id: I41da79865c2836e6750314497e910982bc5462a9
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
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