143 Commits

Author SHA1 Message Date
Jenkins
aedb0048d8 Merge "Use 'min_version' to mark newly added parameters in DOC" 2017-06-29 20:33:25 +00:00
Jenkins
9ce5bae121 Merge "Show user_id when cinder snapshot-show" 2017-06-29 19:42:18 +00:00
TommyLike
c2db25ad61 Use 'min_version' to mark newly added parameters in DOC
This patch adds or updates the parameters by using 'min_version'
for these two patches below:

1. Added sorter, filter and pagination for group snapshot in v3.29
2. Added metadata in volume/summary response in v3.36

Change-Id: I09f6565d45ea2f346a09c8cb45ff24bec6f14acc
2017-06-29 17:33:13 +08:00
xgwang5843
dfa1f85582 remove extra characters "/"
Change-Id: Ib20a11d194155c5c15da5b599788a24ed2489421
2017-06-29 15:07:27 +08:00
wangxiyuan
a8b353e923 Api-ref: Add upload-to-image api-ref
The upload-to-image action for volume action is missing.

Closes-bug: #1566069
Change-Id: I3db7fe7fcca4936f35e0bb260d2d82ef6fbe6028
2017-06-29 09:19:10 +08:00
Jenkins
c1a7e41808 Merge "Add params for v3 API volume-type-create" 2017-06-28 15:56:37 +00:00
luqitao
b1e2b0459c Show user_id when cinder snapshot-show
The user_id attribute should be shown for end user or other
project(eg:ceilometer, cloudkitty). And it should consistent
with other cinder command to be shown.

Change-Id: I629bacb73135fd7756f6008b5c376a8ab0f0df6a
Closes-Bug: #1614095
2017-06-27 22:33:33 -04:00
Jenkins
3046f75968 Merge "[api-ref] Add snapshot metadata key api" 2017-06-28 00:18:31 +00:00
Jenkins
bd33bbffb7 Merge "[api-ref] Add backing-up to snapshot statuses" 2017-06-24 07:17:27 +00:00
junboli
c07d3018eb Add params for v3 API volume-type-create
In api-ref/source/v3/volumes-v3-type.inc, the api for type-create is missing request
params, So the patch is to add the missing param as well as the sample JSON files.

Change-Id: Iac982462ea0afe8e388d9f6e26b89c01e9c46a8c
2017-06-23 18:06:02 +08:00
Jenkins
9beb5ef9fa Merge "Cinder volume revert to snapshot" 2017-06-21 17:19:13 +00:00
TommyLike
8fba9a9080 Cinder volume revert to snapshot
This patch implements the spec of reverting volume to
latest snapshot.
Related tempest and client patches:

[1] https://review.openstack.org/#/c/463906/
[2] https://review.openstack.org/#/c/464903/

APIImpact
DocImpact
Partial-Implements: blueprint revert-volume-to-snapshot

Change-Id: Ib20d749c2118c350b5fa0361ed1811296d518a17
2017-06-21 10:35:32 +08:00
Jenkins
2abc50af33 Merge "Api-ref: fix parameter 'volume_id' info" 2017-06-20 04:15:32 +00:00
wangxiyuan
f89614d2e2 [api-ref] Add snapshot metadata key api
The patch did:
1. Add the missing GET/DELETE/PUT api-ref for snapshot metadata key.
2. Fix snapshot_id description.

Change-Id: I817b1ccffd5e929bcf78b913d666073596b93612
2017-06-19 11:27:22 +08:00
wangxiyuan
2b6bc7d8b8 [api-ref] Update volume metadata key api
The patch did:
1. Add the missing PUT api-ref for volume metadata key.
2. fix the metadata key api's request and response example.
Correct the "metadata" with "meta".

Change-Id: I315682ef86f660eb468991a336d9edae520a4189
2017-06-19 01:28:27 +00:00
Jenkins
ffa89ee161 Merge "Fix api-ref for v3 volume and snapshot manage" 2017-06-16 23:02:30 +00:00
Matt Riedemann
622a0ff424 api-ref: clarify retype docs around default policy permissions
Cinder's default policy allows the owner of a volume to initiate
a retype, even if they aren't an admin. However, if the volume
is going to be migrated during the retype operation, then Cinder
is going to call the Nova swap volume API, which by default is
admin-only. So if a non-admin user tries to retype and migrate
their volume, which is attached to a server instance, then it's
going to fail with a 403 error from Nova.

En lieu of a more complete solution, like Cinder using an
elevated service token to call Nova, this change just attempts
to document the restriction in the API reference.

Change-Id: I6282a6d319beead979780a33880947987906c2f3
Related-Bug: #1698224
2017-06-15 18:19:46 -04:00
Jenkins
8eeee1f580 Merge "Api-ref: Add doc for update backup" 2017-06-14 23:51:08 +00:00
jeremy.zhang
2d8d09f097 Fix response code for update and delete API in volume attachments
The normal response code for update or delete API described in volume
attachments api-ref is 202, but the actual response code from the curl
request is 200. This patch is to fix the response codes of these two
APIs in api-ref.

Change-Id: I6eb43f63bb504cb64b12f55de759779058b2979d
2017-06-13 23:03:14 +08:00
jeremy.zhang
7aee80e200 Fix api-ref for v3 volume and snapshot manage
From cinder api v3.8, manageable_volumes and manageable_snapshot
rest sources were added that were previously in api extensions.
This patch is to replace os-manage-[volume|snapshot] with
manageable_[volumes|snapshots] in v3 api-ref.

Change-Id: I7b9af1a1243adb082581bc3c67d8697eacc3e70a
2017-06-07 22:14:33 +08:00
lihaijing
5ee69ae2f0 Api-ref: fix parameter 'volume_id' info
In Volumes (volumes) v2/v3 API methods, the request parameter
'volume_id' should be a 'path' param in request param table,
not a 'body' param.

Closes-bug: #1691989
Change-Id: If931d05504d4f050e7da4f4df6f8d49d4318c95d
2017-06-07 14:04:08 +08:00
wangxiyuan
a71b838aad Api-ref: Add doc for update backup
Cinder added updating backup support in V3.9.

This patch added related api-ref.

Change-Id: I537cb609240e3bcfa130a116e1912d1b660a21f8
Closes-bug: #1607388
2017-06-07 02:07:30 +00:00
luqitao
e9acdab687 [api-ref]Adds API documentation for 'os-set_bootable' action
There is no document about update a volume's bootable status,
so add the missing doc.

Change-Id: If706205678cfd7a803e2d7733bec34494b47fc66
Partial-Bug: #1607539
2017-06-04 07:44:47 -04:00
Vu Cong Tuan
7404ba21b8 Trivial fix typos
Change-Id: Icd38d004eb89f1902365d71d64aa34a65eee9d37
2017-06-01 09:25:28 +07:00
Jenkins
3c1e569beb Merge "Fix api-ref for POST backup for optional name" 2017-05-31 12:30:59 +00:00
Jenkins
ae28bdb395 Merge "Add the missing "vol_type_id" param for qos association api-ref" 2017-05-30 17:24:45 +00:00
Jenkins
cb67f4f177 Merge "Make "connector" param to be optional in force-detach api" 2017-05-28 22:53:54 +00:00
ghanshyam
b817ad2225 Fix api-ref for POST backup for optional name
name attribute in create backup request is optional but
api-ref does not say so.
- https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=create-a-backup-detail#backups-backups

Change-Id: I9ac456382ac8d3a27256762e3a56bd784abda201
Closes-Bug: #1678005
2017-05-28 16:43:33 -05:00
Jenkins
c83a9bbb97 Merge "api-ref: add list manageable resource API" 2017-05-28 21:18:48 +00:00
luqitao
b7f85fe0c9 Add the missing "vol_type_id" param for qos association api-ref
According to the code [1], "vol_type_id" is a required param,
so do "project_id/tenant_id" and "qos_id", they aren't optional params.

[1] https://github.com/openstack/cinder/blob/master/cinder/api/contrib/qos_specs_manage.py#L261:L269

Change-Id: I7727a9b675080bb92d2e42e293868a1e4eb92e10
2017-05-27 00:53:38 -04:00
luqitao
00edd490c6 Make "connector" param to be optional in force-detach api
One of the purposes of force-detach is to help the admin clean up
if things are in a bad state, so there might not be a connector to
pass in. This is the case if Cinder thinks the volume is attached
but the Nova instance has already been deleted.

Change-Id: I417ed7b100dfe8402599028597511949e00725ac
Closes-Bug: #1619647
2017-05-26 01:30:28 -04:00
Andrey Volkov
8235e6e1e2 api-ref cleanup: required flag for tenants
Current url scheme doesn't allow to skip admin_tenant_id
or tenant_id params. This change marks them as required
in api-ref. Get default quotas for a project signature
was changed on correct also.

Partial-Bug: #1415214

Change-Id: I0c528d1c49346477b608a12f8f35ee6d47404bd3
2017-05-23 14:48:48 +00:00
wangxiyuan
95115ae7ab api-ref: add list manageable resource API
This patch did:
1. Add list manageable volumes API doc.
2. Add create and list manageable snapshots API doc.

Change-Id: Iccffb69b0ffb220f43258ee4c47d5d8964ae7836
Closes-bug: #1590977
2017-05-23 09:51:28 +08:00
Jenkins
07857fb572 Merge "api-ref cleanup: remove quotas user related calls" 2017-05-23 00:07:34 +00:00
Jenkins
284fe17f6c Merge "Add the missing parameters in the api-ref of ext-backups.inc" 2017-05-22 17:21:04 +00:00
Jenkins
e4bf29c88f Merge "Fix incorrect volume_id request description in api-ref" 2017-05-22 16:22:39 +00:00
liuyamin
551c2963a0 Add the missing parameters in the api-ref of ext-backups.inc
Add "snapshot_id" and "data_timestamp" and "volume_name" to
the response parameters and error response code in the api-ref of
ext-backups.inc.

Change-Id: I2e3a6c737a74816e5e56b5a435a73e0bf501bec8
Closes-bug: #1676693
2017-05-22 14:01:27 +08:00
TommyLike
8fcb809509 Add 'resource_filters' API to support generalized filtering
This patch adds ``resource_filters`` API to retrieve
configured resource filters.

APIImpact

Partial: blueprint generalized-filtering-for-cinder-list-resource
Depends-On: ff3d41b15abb2915de87830980147be51e5da971

Change-Id: I387268b277c46c72624a3d3b5eabf03724a7a847
2017-05-20 10:33:21 +08:00
liuyamin
238a16a8a6 Add API documentation for force-delete volume in v2 and v3.
There is no API doc found for force-delete volume in cinder.
We need to add the API doc for the operation with its description,
request and response parameters.

Change-Id: Id25b4070a3946d2d7d89f44bdc81039286a5d8fe
Closes-bug: #1673644
2017-05-19 15:52:17 +08:00
wanghao
0b675b0438 Add missing retype API documentation
Now retype is missing in v2/v3 API documentation.
Add it in doc.

Change-Id: I2ba0d7b993a5b3e21c396ed3d0862808e0daf0b3
Closes-Bug: #1603293
2017-05-18 11:47:20 +08:00
wanghao
7e17004018 Fix incorrect volume_id request description in api-ref
Now some API documents for volume actions like
extending volume(https://developer.openstack.org/api-ref/
block-storage/v3/?expanded=extend-a-volume-size-detail) are
using incorrect request argument description
'volume_id in body'.

It should be 'in path'.

Change-Id: I2006b4af4dfc09fb0403c1a78ecef4ac920a51c4
Closes-Bug: #1691358
2017-05-17 14:41:51 +08:00
TommyLike
5c90bd64fe Add documentation for invalid filter keys
Now cinder will raise 400 if invalid filter
keys are specified, Update the corresponding
list APIs.

DocImpact
Depends-On: ff3d41b15abb2915de87830980147be51e5da971

Change-Id: I8419b374d7f743e7e9fc88e31c8c4f7d9470059b
2017-05-17 09:11:27 +08:00
Jenkins
5faa626f80 Merge "[api-ref] Add cascade to volume delete" 2017-05-11 19:12:24 +00:00
Matt Riedemann
e13256469d Re-arrange v3 API reference
This applies an order to the v3 API reference documents.

The idea being how does a new user come into and use the API
and what APIs should they see first when getting started.
Naturally they need to know about versions and microversions
that are avaible. Then they might need to know about volume
types before creating a volume. Once they create a volume
and know the basics of working with volumes, they can start
to take some actions on volumes. After that it's just kind
of a random free for all of APIs and the only order applied
to the rest is sorting alphabetically by title.

Change-Id: I8956de3e6907582f7115430eb959813a13e87a49
2017-05-03 09:32:06 -05:00
Matt Riedemann
ad56443ecb Re-order api-ref home page index
Since the v2 API is deprecated, put it in the index after
the v3 API which is current, since as a user the first thing
I want to see is the currently supported API reference, not
the deprecated stuff I shouldn't be using anyway.

Change-Id: I760533ca693cb8f678a6031e07789cd68f11bc47
2017-05-03 09:28:50 -05:00
Jenkins
ae1df67883 Merge "Add attachment API doc" 2017-05-03 00:31:04 +00:00
Amy Marrich (spotz)
e0e201c9a9 Volume Type Encryption added to v2 api-ref
Added volume type encryption sections to volumes v2 types and
added related parameters to parameters file.

Appropriate sample files added.

Had to add for v2 to several headings to pass tox/gates

Change-Id: I7a35551c4ebd345ce2d6c42217015b29c324d96c
Closes-Bug: #1679736
2017-04-26 08:20:05 -05:00
TommyLike
5c19a66950 Add attachment API doc
Add attachment API related Docs, please note we
use 'instance_uuid' in the request and 'instance' in
the response to represent the same thing 'server_id'.

DocImpact

Change-Id: I8bd5a9061af2b47fd227e8cf2f48f80f271bde14
2017-04-21 10:30:41 +08:00
Jenkins
22777e559e Merge "api-ref: fix rest method error in reset group and group-snapshot status." 2017-04-13 20:14:22 +00:00
Jenkins
6ce8d6f32f Merge "Missing volume status on block storage v2 API" 2017-04-11 05:32:43 +00:00