8 Commits

Author SHA1 Message Date
Felipe Monteiro
8d161d9d19 api-ref: Change extensions updated type to updated_at
This changes the updated type to be updated_at (the updated
type is just a string whereas updated_at is iso-8601 formatted
string).

This change is consistent with:

* examples for os-extensions in API docs [0]
* Nova API docs for os-extensions [1]

[0] https://developer.openstack.org/api-ref/block-storage/v3/index.html#id6
[1] https://developer.openstack.org/api-ref/compute/#id402

Change-Id: I806dbc66f35fd0d9209c25c35adc2d64f5b9f8ed
2018-09-30 10:25:46 -04:00
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
lihaijing
4403ed17ca Api-ref: change 'tenant' to 'project' in v2 doc
Since 'tenant' is the old term, all things should now refer to 'project'.

Change-Id: I3a255df758583a3c4301041c8ebffb90b8263fef
2017-09-27 18:14:25 +08:00
Sean McGinnis
117f614428 api-ref: Normalize response codes
We had a mix of formatting for our API response codes. This
makes it so all have a leading space, no trailing comma, and
no empty Error response labels.

This also addresses a formatting issue with due to the spacing
between the Normal and Error lines that was causing the two to
run together in the formatted HTML, making it harder to read.

Change-Id: Ic411ee9f671c48ce60bda21984dafe55135685ba
2017-09-03 18:17:13 -05: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