514 Commits

Author SHA1 Message Date
Jenkins
beea718b7a Merge "Add os-detach to api-ref" 2016-09-19 16:58:59 +00:00
scottda
2aed75f987 Add os-detach to api-ref
os-detach was missing from api-ref.

Change-Id: I1e2990178ff7fcf3c6953e35469af04a3bde6010
Closes-Bug: #1618609
2016-09-19 07:06:03 -06:00
Jenkins
37be83c58d Merge "Fixed request/response parameters in doc" 2016-09-15 20:22:34 +00:00
Justin A Wilson
f794629360 Fixed request/response parameters in doc
user_id, project_id and status were listed as request parameters when
they are actually response parameters.

Change-Id: I5ff464c6aae853929b2b10ba62898913977016b0
Closes-Bug: 1603177
2016-09-15 16:01:01 +00:00
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
Mark T. Voelker
081e5bb35a Mark v1 as DEPRECATED in devref
The Cinder v1 API has been deprecated for a while now[1][2][3], but
the api-quick-start index still shows it as SUPPORTED.  A patch has
been submitted to fix the index page[4] but to be consistent with
the documentation for other projects[5] we should also update the v1
index page's header to clearly state it's status.

[1] https://wiki.openstack.org/wiki/ReleaseNotes/Juno#Cinder_Features
[2] http://developer.openstack.org/api-ref-blockstorage-v1.html
[3] https://review.openstack.org/#/c/309652/
[4] https://review.openstack.org/#/c/370407/
[5] Such as: http://developer.openstack.org/api-ref/identity/v2/

Change-Id: I4200767227368dc12f53e2410816b6fde375d390
Partial-Bug: #1623642
2016-09-14 16:08:09 -04: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
Corey Wright
cff6c08c2c Doc: qos-specs is always and only "Administrators only"
Because of the underlying SQLAlchemy qos-specs functionality, which is
the only in-tree DB implementation, requiring context.is_admin to be
True, it's not technically correct to say "Administrators only,
depending on policy settings."  Even if the associated
volume_extension:qos_specs_manage policy doesn't require an
"administrator", the @requires_admin_context decorator on the
underlying functionality definitely will.

    ERROR: User does not have admin privileges (HTTP 403)

Change-Id: I0bc6a59c612b6c4ff7dcaff36dad712d8e3e03c2
Partial-Bug: #1621715
2016-09-08 22:58:12 -05:00
Ha Van Tu
e82d639e96 [api-ref] Correct response code in Cinder API v1
This patch corrects reponses code in Cinder API v1

Change-Id: I3491f0af455b30a6db66dc38ae3983e8799aa851
2016-09-08 11:53:36 +07:00
Jenkins
345cbf8b00 Merge "Remove doc for promote/reenable replica" 2016-09-06 12:38:12 +00:00
Cao Shufeng
b9ef6efa97 Remove doc for promote/reenable replica
Cinder v2 api no longer supports replication 1.0 and the apis for
os-promote-replica and os-reenable-replica [1][2].
These 2 api had been removed in this patch[3].

We should update the doc about it.
Trivial Fix

[1]: http://developer.openstack.org/api-ref-blockstorage-v2.html#promotereplicaVolume
[2]: http://developer.openstack.org/api-ref-blockstorage-v2.html#reenablereplicaVolume
[3]: https://review.openstack.org/#/c/275797/35/cinder/api/contrib/volume_replication.py

Change-Id: I6e4f0174b4ac5d7861925354ac3860b8f1c55b84
2016-09-04 03:25:20 -04:00
Ha Van Tu
b017983f5b Config logABug feature for Cinder api-ref
Currently, Cinder api-ref is configured with logABug feature.
When users click "Report bug" button,
it leads to "bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/cinder/".

Change-Id: Iabd97f92a9cdc64513fc572630ef223762794f95
2016-08-31 04:32:30 +00:00
Andreas Jaeger
f589c6e2d1 Cleanup api-ref
Remove useage of old os-api-ref version and replace with current version.

Follow other repositories and merge v1 and v2 in a single document.

Note that we need to have a single document so that preview of the
document works properly in our CI.

Change-Id: I82c8b9ca317298b3dc1f7133ce8c0e9b3503730d
2016-08-27 17:13:04 +02: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