The parameters with name like example_1, example_2 ... etc. cause
confusion while updating the api-ref docs like the examples below:
https://review.openstack.org/#/c/609639/https://review.openstack.org/#/c/609611/
This patch does the following changes :
1) Replace numbering in the parameter with relevant names
2) Clean up unused parameters
Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
Using the wrong character resulted in the wrong title level
being used for the response codes, which in turn caused the
"detail" show/hide toggle to not be able to hide all of the
per-endpoint details. This corrects these to be at the correct
level.
Also ran into issues after changing them where sphinx was not
happy with the random title levels. This appears to be due to
the order processed and whether not earlier included files had
all subsequent levels. Adding an additional title in our first
included file resolved that problem.
Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03
Closes-bug: #1755566
Rather than our freeform way of listing response codes in our
api-ref, we should be using the os-api-ref extension option to
get nicely formatted response code listings.
https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code
Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
Update API document for API 'workers/cleanup',
also remove 'until' from allowed clean keys as
its value is always assigned in code.
Change-Id: Iea940d7c7e52718b8e5e8dcf706aa5d1126860ef
Allow triggering cleanup from API was introduced in cinder[1], but it's
not documented in the API docs. This change is to add it in the API docs.
[1] https://review.openstack.org/#/c/363010/
Closes-bug: #1708809
Change-Id: Iadec39e8411a598372bc19bb566627a143faa0d8
