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
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I4ebb6e663471a7096bd9d0e1a90d8114d1875546
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Ie6b9bdc0cdb6939903920806334f71aa6133c12b
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
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: I9acc4200751e63fa29be738cfa00c4637efd8287
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
The os-api-ref 1.0.0 is out. We can remove the support to older version now.
Reference:
6d41feb58d
Change-Id: I33120c4c93fd976add6e9f52ef306cc3d050f162
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
Currently, heat api-ref is not configured with logABug feature.
When users click "Report bug" button, it leads to "openstack-manuals"
which is default.
Change-Id: I8f1fc450189d1cc2f931f5fdc8ba6d3eaccf5fc0
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