8 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
junboli
65626f449f Fix version details API does not return 200 OK
When use version details api http://ip:8786/v2 to get api details,
it does not return 200 OK, and the return value is empty.

This change is to correct the version details API URL and its
sample response.

Change-Id: I547dca649db22b31051b490c2b230322d3c9d479
2018-01-12 08:52:09 +08:00
junboli
cca970b322 Api-ref: Reorganize volumes versions
In v2 sample path, there are redundant files version-v2-show-response.json,
in v3 sample path, there are redundant files version-v2-show-response.json
and version-v3-show-response.json, This patch is to remove the redundant
JSON file and reorganize volumes versions of v2 and v3

Change-Id: I3d9337cc94ad02138459742a7b84fe97bd09bb90
2017-07-10 17:28:40 +08:00
liuyamin
3f2539fa4f Delete the duplicate interface about the api version
In the document of cinder api,there are duplicate interface in the
api-versions.inc and volumes-v2/v3-versions.inc about listng all
api versions(rest_method:: GET /).So remove the interface in
volumes-v2/v3-versions.inc

Closes-Bug: #1674278
Change-Id: I34da088161771ec8e518a02235c7f78988a311f5
2017-03-23 14:24:57 +08: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
Ha Van Tu
a1284a5f43 [api-ref] Correct response code in Cinder API v2
This patch corrects reponses code in Cinder API v2.

Change-Id: I91d9b4ba96e53e9fe7cd593f2daf1f8a3cf7ab09
2016-09-09 18:02:53 +07: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