68 Commits

Author SHA1 Message Date
TommyLike
663c4e383f Correct 'os-show_image_metadata' API document
The 'os-show_image_metadata' API is outdated.
Rewrite the document, also correct the response
codes for image metadata's create/delete APIs.

Change-Id: I50a5b3571973564b8b5010b412d94303866e8dcd
2017-08-02 08:55:46 +08:00
Jenkins
f2cd3ee8c2 Merge "[Api-ref] Update quota-set APIs ref" 2017-07-25 12:19:02 +00:00
Jenkins
8184822606 Merge "Api-ref: add documentation for v2/v3 backup 'os-reset_status' action" 2017-07-25 12:18:50 +00:00
Jenkins
777cdeba22 Merge "[api-ref] Backups: change parameter 'backup_id' to be mandatory" 2017-07-24 21:23:11 +00:00
jeremy.zhang
bf841e0e8f [api-ref] Backups: change parameter 'backup_id' to be mandatory
The pamameter 'backup_id' in volume v2 & v3 backups api-ref is optional,
which is wrongly described. This patch is to fix it.

Change-Id: I14280e778617ecf8928663261d4e985d727e99bf
2017-07-19 16:56:46 +00:00
jeremy.zhang
502d87cfe5 Fix 'connector' parameter in update attachments API
The 'connector' parameter in update attachments is not optional
in API implementation. This patch is to set the 'connector' to
be manadatory.

Change-Id: Id58abaa9ee345b274ebfbe6b89c1047f2e580ff3
2017-07-19 16:56:27 +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
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
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
wangxiyuan
107d080476 [Api-ref] Update quota-set APIs ref
The api-ref for quota-set is totally wrong. This patch updated
it to keep the same with Cinder's behavior.

Change-Id: Ib71d53e920a867ff080c929672f3120a639e3a28
Closes-bug: #1696347
2017-06-29 09:22:22 +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
lihaijing
57330a12a8 Api-ref: add documentation for v2/v3 backup 'os-reset_status' action
There is no document about v2/v3 backup 'os-reset_status' action. This
action explicitly updates the backup state. So add the missing content.

Change-Id: Ie0dd2b4e184d09e957c4ba296544f5019d05fda3
Partial-Bug: #1607539
2017-06-26 17:05:43 +08: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
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
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
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
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
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
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
Jenkins
5faa626f80 Merge "[api-ref] Add cascade to volume delete" 2017-05-11 19:12:24 +00:00
Jenkins
ae1df67883 Merge "Add attachment API doc" 2017-05-03 00:31:04 +00: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
0842264377 Merge "Adds API documentation for list and show hosts." 2017-04-11 04:16:03 +00:00
wangxiyuan
969d080c07 [api-ref] Add cascade to volume delete
Delete volume with cascade is supported by Cinder from V2.

cascade is missing in api-ref.

Change-Id: I66b4bb345aba5a6b4165f971556b858e4c0e258c
Closes-bug: #1677456
2017-03-31 15:35:15 +08:00
yfzhao
88aa1bcabb Add two response parameters in the api-ref of getting capabilities
Add "display_name" and "replication_targets" to the response parameters
in the api-ref of getting capabilities.

Change-Id: Id1776641ea9938d024906707fec2e21404668ff7
Closes-bug: #1674237
2017-03-25 12:25:07 +08:00
Jenkins
748b218ec5 Merge "api-ref: Fix volume_id parameter for the path" 2017-03-24 16:12:29 +00:00
Jenkins
42402ebbf4 Merge "Fix 500 error when 'mountpoint' is not provided to os-attach" 2017-03-24 16:12:12 +00:00
Matt Riedemann
b3400efd96 api-ref: Fix volume_id parameter for the path
When the volume_id is in the path for an API, it is
required. This fixes the volume_id_1 parameter for the
path argument by making it required and also renaming
it to be more clear of what it's used for. And finally,
this fixes the os-attach parameter to indicate volume_id
is in the path and is required, not optional.

Change-Id: I0e8868d35b5ea06ef809c896f943d92ad8e71e3e
2017-03-23 13:02:52 -04:00