6 Commits

Author SHA1 Message Date
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
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
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
442c8e8a1c Fix missing JSON response in API reference
Currently, the API reference is showing a blank sample response
for the v2 "List API Versions" call [1].  That appears to be because
the sample file it includes is "versions-resp.json" which exists, but
is 0 bytes (completely empty).  There is also a
"versions-response.json" file present in the samples directory, which
appears to contain a valid JSON reply.

This patch fixes the problem by removing the 0-byte sample file and
pointing to the correct one.

[1]
http://developer.openstack.org/api-ref/block-storage/v2/#list-api-versions

Change-Id: If2c1b486229681f68ba4ab0c13307de4599d9b72
Closes-Bug: #1623744
2016-09-14 21:48:48 -04:00
Sheel Rana
7f2131e3a1 Update api-ref path
api-ref path needs update to support uploading cinder api-refs to
developer.openstack.org/api-ref/block-storage

update includes
https://github.com/openstack/cinder/tree/master/api-ref/v2/source
to
https://github.com/openstack/cinder/tree/master/api-ref/source/v2

Depends-on: Id38dd0609c77b0d6bcd0d935a9312b0211134802

Implements: bp api-reference-to-rst

Change-Id: If3a058a95f1eaa8481a926183591ff0f4b23e97b
2016-08-27 16:58:10 +02:00