36 Commits

Author SHA1 Message Date
Gorka Eguileor
bc7c001d76 Fix api-ref status parameter
In the api ref most of our references to the status parameter are wrong,
since they are all referencing `status`, which in most cases is:

 status:
   description: |
     The ``status`` of the consistency group snapshot.

This patch fixes this by referencing the right status parameter.

TrivialFix

Change-Id: I3f76ad10bacd8c75f742efc3ff3395a7effc31b5
2017-01-26 13:28:42 +01:00
wangxiyuan
a3602906a3 Fix the api-ref CI failure
Our Api-ref CI job failed due to the change[1] in os-api-ref.

This patch fixed the issue.

[1]: I8686006339b82ed5465dd8e4d3a8b15f85ee897c

Change-Id: I00458bef8729e9ff877b4e38563f5d133de47cf5
2017-01-25 14:04:45 +00:00
Jenkins
d9e48eb1a4 Merge "Fix response bootable parameter type in api document" 2017-01-16 13:42:22 +00:00
Masayuki Igawa
556a2f8f7f Fix response bootable parameter type in api document
This commit fixes the response bootable parameter type in the api
document. The type is string not boolean in the current code. And
the request parameter's type is boolean. I think this is an
inconsistency but we shouldn't change it to keep the backward
compatibility.

Change-Id: Ia0c70341f595580d12888e1f517e314fb98d4a6b
2016-11-30 15:52:20 +09:00
Jenkins
5221653ad9 Merge "Update v2 and v3 Volume actions documentation" 2016-11-27 20:48:20 +00:00
wangxiyuan
3f7200b6da [api-ref]Add api ref for "volume type encryption"
the api ref for "volume type encryption" is missing.

Change-Id: I4320426ac8270da4922f4ae3d8b1ca8d732f25b1
Closes-bug: #1562043
2017-01-05 10:59:20 +08:00
Jenkins
196618ac05 Merge "[api-ref] Show more specific parameter of capabilities" 2016-12-18 17:26:17 +00:00
Mitsuhiro Tanino
7fa8165180 [api-ref] Show more specific parameter of capabilities
Current capabilities api-ref explains that the API takes
{hostname}, but this is not accurate.
Actually this api takes hostname@volume_backend_name format.
To avoid confusion, this explanation should be updated.

Change-Id: I0d9e9925a1b011f49cefc9867f617e8b51ec7437
2016-12-14 15:34:34 -05:00
Gorka Eguileor
9acf079b8c Support A/A on Scheduler operations
This patch allows scheduler to work with clustered hosts to support A/A
operations.

Reporting capabilities of clustered hosts will be grouped by the
cluster_name instead of the host, and non clustered hosts will still be
stored by host.

To avoid replacing a newer capability report with an older version we
timestamp capabilities on the volumes (it's backward compatible) and
only replace currently stored values in scheduler when they are newer.

Following actions now support A/A operation:

- manage_existing
- manage_existing_snapshot
- get_pools
- create_volume
- retype
- migrate_volume_to_host
- create_consistencygroup
- create_group
- update_service_capabilities
- extend_volume

And Affinity and Driver filters have been updated.

The new functionality to notify service capabilities has not been
changed to Active/Active and will be done in another patch.

APIImpact: Added microversion 3.16
Specs: https://review.openstack.org/327283
Implements: blueprint cinder-volume-active-active-support
Change-Id: I611e75500f3d5281188c5aae287c62e5810e6b72
2016-12-14 17:48:28 +01:00
Sean McGinnis
7592c8e0d1 [api-ref] Correct status code of backup delete
Current doc states "Error repsonse codes:204". This should actually
by "Normal response code" and be 202 (Accepted) vs 204 (No Content).

Change-Id: I6e3855b2d1280de3e0fe6b5638feb54e9dfa4c10
Closes-bug: #1598237
2016-11-30 09:22:00 +00:00
Samantha Blanco
9ee2e94e58 Update v2 and v3 Volume actions documentation
Updates v2 and v3 documentation to reflect admin-only status of
API within volume actions.
- Edited to add bug reference

Change-Id: Ib7eff37bbbc05fedd2d9c9349ca500b20875e64e
Closes-Bug: #1501752
2016-11-18 16:43:04 -05:00
Matt Riedemann
33d1270dca Fix v2 volume create api-reference request parameters
This fixes several things:

1. The consistencygroup_id and metadata parameters are optional.
2. Several parameters used were for non-volume types, this changes
   the api-ref to use the proper parameters that have the correct
   descriptions for creating a volume.

At some point the parameter names in parameters.yaml need to have
more descriptive names than the lazy *_1, *_2, etc names so it's
easier to know what a parameter is for,
e.g. volume_description_body_required, but that's for a later
cleanup.

Change-Id: I1fb8ca507c85bfbf0add41b507c014ae995e17d0
Closes-Bug: #1642983
2016-11-18 10:33:44 -05: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
Jenkins
0f29ca0450 Merge "[api-ref] Correct response code in Cinder API v2" 2016-11-01 18:12:12 +00:00
Jenkins
4dea7c7516 Merge "Doc: qos-specs is always and only "Administrators only"" 2016-10-31 13:07:10 +00:00
Jenkins
871e292498 Merge "Removed extra xml api-ref files" 2016-10-30 00:52:32 +00:00
Jenkins
2ca6e3eed9 Merge "[api-ref] Correct response code in Cinder API v1" 2016-10-29 10:52:04 +00: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
Lujin
8efbf756a3 Add 'replication_targets' and 'display_name' in API docs
'replication_targets' is always returned in Response of GET/v2/
{tenant_id}/capabilities/{hostname} API, but it is not written
in either Response parameters table or JSON example.

'display_name' is listed in JSON example but not described in
Response parameter table.

This patch adds the above two missing information.

Change-Id: Ib3bf54df7c5c400cfec64dd9c7df136c87cd6376
Closes-Bug: #1603306
2016-09-28 18:05:33 +09:00
Jenkins
16160dc09c Merge "Mark v1 as DEPRECATED in devref" 2016-09-26 10:32:13 +00:00
Jenkins
f8ce044518 Merge "Create v3 API Reference" 2016-09-23 03:09:51 +00:00
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
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