Commit Graph

88 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
Zuul a0ee275ebe Merge "API ref: Update sample output of resource type APIs" 2020-10-29 16:06:42 +00:00
Andreas Jaeger b3e7c590f0 Switch to newer openstackdocstheme and reno versions
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
2020-05-21 09:43:55 +02: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
pengyuesheng 14f2678c48 Bump the openstackdocstheme extension to 1.20
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
2019-08-01 09:43:50 +08: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
wanghui 9ab92e8287 Move openstackdocstheme to extensions in api-ref
Move openstackdocstheme to extensions. According to the guide below: 
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I09acab1026c621d29ba5076345f8facdf7cfd91f
2018-03-27 00:39:43 +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
M V P Nitesh 776241e2fa Fix doc generation for Python3
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
2017-04-17 18:12:24 +05:30
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
pawnesh.kumar f09a37e550 Correct invalid git URL in LogABug config
Change-Id: I942338ce0811d12dcb83ec08853ad2a9b31f7af0
2016-10-07 15:18:21 +00:00
gengchc2 b3733f1e9c Fix typo 'duplcate' to 'duplicate' in status.yaml
TrivialFix

Change-Id: I39aed5274c7890ec0144a708b4c5a8c900f226ba
2016-09-23 11:24:56 +08:00
Jenkins 5295a8aefb Merge "[api-ref] Remove temporary block in conf.py" 2016-09-13 13:41:37 +00:00
Jenkins 21e49dc9b5 Merge "[api-ref] Rewrite the Heat API version" 2016-09-07 11:55:42 +00:00
Nguyen Phuong An 29734db6d9 [api-ref] Remove temporary block in conf.py
The os-api-ref 1.0.0 is out. We can remove the support to older version now.
Reference:
6d41feb58d

Change-Id: I33120c4c93fd976add6e9f52ef306cc3d050f162
2016-09-07 07:25:45 +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 c19c71a2b1 Config logABug feature for heat api-ref
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
2016-08-31 11:53:51 +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
Jenkins 11064586e9 Merge "api-ref - software config status codes" 2016-08-23 07:14:16 +00:00
Jenkins c0f13af8e4 Merge "api-ref - template version and functions" 2016-08-23 07:14:08 +00:00
Jenkins 403f07c256 Merge "api-ref - stack actions" 2016-08-23 07:13:55 +00:00
Jenkins 5b28cf70ce Merge "api-ref - events" 2016-08-23 07:13:47 +00:00
Jenkins fa88f21b18 Merge "api-ref - stack snapshots" 2016-08-23 07:13:38 +00:00
Jenkins e7e29ee8ca Merge "api-ref - stack resources" 2016-08-23 07:13:33 +00:00
Jenkins 2806d5fb29 Merge "api-ref - services/stack-outputs doc" 2016-08-23 07:13:26 +00:00
Jenkins b4a2b4387b Merge "api-ref - stack identity usage in find calls" 2016-08-23 07:11:12 +00: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