157 Commits

Author SHA1 Message Date
Jenkins
79ff820cf1 Merge "api-ref: Add parameter "offset" to list apis" 2017-07-18 23:00:04 +00:00
Jenkins
798d8850a7 Merge "[api-ref]Fix API Doc error in creating backup" 2017-07-18 22:59:56 +00:00
Jenkins
c3805a102b Merge "Api-ref: Update doc for show backups" 2017-07-18 22:34:30 +00:00
Jenkins
2758720d63 Merge "Add missing api-ref documents for group type specs" 2017-07-18 12:33:10 +00:00
TommyLike
4a1d7cc17f Add missing api-ref documents for group type specs
Added the missing api-ref documents for group specs APIs.

Change-Id: I6c04ec9c073bc227a34a502b42ffd615e689a241
2017-07-18 01:07:09 +00:00
wanghao
576007aaa6 [api-ref]Fix API Doc error in creating backup
Now api doc for creating backup has an issue that
container and description should be optional.

Change-Id: I42a9918e98963f72fb6d057d457869df1a9315c3
Closes-Bug: #1704690
2017-07-17 10:25:05 +08:00
Mathieu Gagné
3dd842de82 Add ability to extend 'in-use' volume
This change adds the ability to extend 'in-use' volume.

Once the volume size is extended, Nova is informed of the size change
through the external-event extension so the virt driver can perform
the appropriate actions for the host and guest to detect the new volume size.

Tempest related patches:

1. https://review.openstack.org/#/c/480746/
2. https://review.openstack.org/#/c/480778/

Depends-On: If10cffd0dc4c9879f6754ce39bee5fae1d04f474

Blueprint: extend-attached-volume
Co-Authored-By: TommyLike <tommylikehu@gmail.com>
APIImpact
Change-Id: I60c8ea9eb0bbcfe41f5f0a30ed8dc67bdcab3ebc
2017-07-12 11:48:32 -04:00
junboli
db4327b6fe Keep consistent of naming convention
In the project, some of the terminology, like URL, URLs, API, APIs, OpenStack,
UUID, Cinder are neglectfully written as url, api, openstack, uuid, cinder.
This patch is to keep consistent of naming convention.

Change-Id: I98777fb4748cbc58b6e2fd1aca058d3e44069d07
2017-07-10 10:46:44 +08:00
Jenkins
fbfd4266f1 Merge "Add params for API v3 snapshot-create" 2017-07-09 15:40:53 +00:00
Sean McGinnis
cf0de020fd Fix v1 API api-ref link
The v1 API is incorrectly formatted, causing the
generated link in the page to not actually go to
the v1 pages. Fixed formatting.

Change-Id: I1a27a4edb2b2a79222678ee807cedd487da96b7b
2017-07-06 13:43:35 -05:00
junboli
5b9e9875df Add params for API v3 snapshot-create
In api-ref/source/v3/volumes-v3-snapshots.inc, the API for snapshot-create
is missing request params [metadata] and response params [updated_at], So
the patch is to add the missing param as well as the sample JSON files.

Change-Id: Id77525922e4b94613da35c4329c24f2fda8fda10
2017-07-06 07:06:52 +00:00
luqitao
a19518ce9d Api-ref: Update doc for show backups
Now cinder has supported to query project id of a given backup since
V3.18 after the patch [1].
This patch added the related api-ref.

[1] I6fde17baffe88ab4d4e69dcc2fefdbcb8d7a4dc5

Change-Id: Ie581b33964bf24689cf0ab099b8c7341af4aeb4b
2017-07-04 22:50:57 -04:00
xgwang5843
830e968cfa api-ref: Add parameter "offset" to list apis
Cinder has supported to list volumes/snapshots/types with
parameter "offset" from v2, so add the missing content.

Change-Id: I939d5131cd1b369653bb03810888b7ad56d46088
2017-07-05 10:44:32 +08:00
Ildiko Vancsa
f0e5c7be17 Add 'reserved' status to api-ref
Change-Id: If06f1e6e685df294f5009608a57c28680f66baff
2017-07-04 14:28:17 +02:00
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