8 Commits

Author SHA1 Message Date
whoami-rajat
c5c5c009ff Automate generation of API versions api-ref samples
This patch adds Tests for the following :

1) API versions
2) API extensions

Change-Id: Ieaa1e2768c091b93c7afcbf04ec4a181cb021ec5
Partially-Implements: blueprint generating-sample-files
2019-01-10 19:48:18 +05:30
Sean McGinnis
a96fad9f3b Fix api-ref response code title levels
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
2018-03-13 15:57:54 -05:00
Sean McGinnis
2e5a91da72 Use rest_status_code for api-ref response codes
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
2018-03-08 21:59:37 -06:00
Ken'ichi Ohmichi
8564ac6cbd Fix status_code of "list versions" API
The status code of "list versions" API is 300 because the API method
is decorated with MULTIPLE_CHOICES[1] and the unit test[2] expects the
code. In addition, the corresponding Tempest test[3] also verifies 300
as the code. So it is not necessary to write the other status codes on
the api-ref.

[1]: http://git.openstack.org/cgit/openstack/cinder/tree/cinder/api/versions.py?id=a4a5fac7564503a09751db98d2a4f8be3766577a#n123
[2]: http://git.openstack.org/cgit/openstack/cinder/tree/cinder/tests/unit/api/test_versions.py?id=a4a5fac7564503a09751db98d2a4f8be3766577a#n66
[3]: Id5791665d8435fac7552733b0c1126cee4359d00

Change-Id: Id28e26fca0adbdcfb0d905f52ca697a74db3be75
2017-03-22 10:08:40 -07:00
Nicholas Jones
aa9cabdb42 Fix Block Storage API reference nesting
Modifies heading levels in .inc files to allow nested display in
table of contents. Table of contents depth has been changed to allow
this.

Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-09 08:37:27 -06:00
xing-yang
0e8ebbdf82 Add API Reference for groups
This patch adds API reference for group types,
groups, and group snapshots.

Change-Id: Ia42b4a036fc6396cca37c03092c089cc5df1170a
2016-08-02 18:04:58 -04:00
Sheel Rana
2fa79b35ba Removed extra xml api-ref files
We have already removed xml support from cinder code
in previous release.
As per previous discussions, xml references are required
to eliminate to sync code and api-ref.

Implements : blueprint eliminate-xml-references

Change-Id: I0cb7da56306e29cff8385c784bfc3f49cd9cfddd
2016-10-18 23:37:57 +05:30
Mark T. Voelker
931e2f8161 Create v3 API Reference
The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref
was ever created.  This is problematic for end users and would hinder
the v3 API from being included in DefCore Interoperability Guidelines
somewhere down the line (since one of DefCore's Criteria[1] is that a
Capability be well documented).  This patch creates an API ref for v3.
It also adds a header to the v2 index to show that it is SUPPORTED,
whereas v3 is CURRENT.

[1]
http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77

Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e
Closes-Bug: #1616072
2016-09-19 14:33:01 -04:00