524 Commits

Author SHA1 Message Date
whoami-rajat
6dd3b9c51f Add project_id in group snapshots list and show API
Add ``project_id`` to response body of list group snapshots
with detail and show group snapshot detail APIs.

Merging the group and group snapshot response in same MV
was discussed in weekly meeting[1].

[1] http://eavesdrop.openstack.org/meetings/cinder/2019/cinder.2019-02-20-16.00.log.html#l-122
Change-Id: Ided66450b5d7de32551edbce249e94f6174da2eb
Implements: blueprint add-project-id-to-group-groupsnapshot-response
2019-03-01 22:59:19 +05:30
Zuul
019d1e9dd6 Merge "[api-ref] Fix the parameter of image metadata" 2019-02-28 16:58:09 +00:00
zhangbailin
f54964d520 api-ref: add qos_specs_id to show default volume type response
https://developer.openstack.org/api-ref/block-storage/v3/?expanded=update-extra-specification-for-volume-type-detail,delete-extra-specification-for-volume-type-detail,show-volume-type-detail-detail,show-default-volume-type-detail,show-extra-specification-for-volume-type-detail,show-all-extra-specifications-for-volume-type-detail,create-or-update-extra-specs-for-volume-type-detail,update-a-volume-type-detail#show-default-volume-type

Change-Id: Ia097263b2354534fc77f229cc257bc8de8dd51dc
2019-02-25 06:18:48 +00:00
Zuul
77c6f1010c Merge "Doc8: Stop skipping D001: Line too long" 2019-02-23 22:39:37 +00:00
Zuul
ca4e634ede Merge "docs: Add os-migrate_volume_completion api-ref" 2019-02-21 18:00:46 +00:00
Lee Yarwood
71ca8578be docs: Add os-migrate_volume_completion api-ref
This admin API is only called externally by Nova at present when
finishing the migration or retype of an attached volume. However for
future reference it would be really useful to have this listed in the
official API reference guide.

Change-Id: I5fad6eb4903784870aa26fa0996a391bbbbb9276
2019-02-20 11:40:30 +00:00
Sean McGinnis
d5b539be36
Doc8: Stop skipping D001: Line too long
This cleans up the cases where we had D001 violations so we can stop
skipping that check in doc8 runs.

Change-Id: Ie52f6ecac1a645fcbcc643b9ca63e033b622d830
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-02-19 16:51:56 -06:00
Sean McGinnis
b6f9932f9c
Include .inc files in doc8 linting
We use *.inc files extensively, especially in the api-ref, but these
files are not covered by default with our doc8 validation.

This adds support for those files and fixes a few issues that were
identified after enabling coverage.

Change-Id: I807823f3cb44274c3940db55e901d434304a09f5
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-02-19 11:33:05 -06:00
whoami-rajat
15d1a00a57 Automate generation of volume actions api-ref samples
This patch adds the following tests:

1) Volume actions
2) Volume manage extensions

Change-Id: I7f27a336a6735f4d346cc47c983dfee55f47f55d
Partially-Implements: blueprint generating-sample-files
2019-02-08 01:13:03 +05:30
Zuul
3902a2bf28 Merge "api-ref: Correct response body type for show host details" 2019-02-06 23:25:01 +00:00
Zuul
e10f524529 Merge "Automate generation of volumes api-ref samples" 2019-02-06 19:28:36 +00:00
Zuul
a714ac1ec1 Merge "api-ref: modify 'keys' description" 2019-02-05 23:17:54 +00:00
TommyLike
311c5153bc Support transfer pagination
This patch adds support for transfer pagination.

Co-Authored-By: Yikun Jiang <yikunkero@gmail.com>

Closes-bug: #1814195

Change-Id: Idb04f783b2287b2b45d626131648b0005a232fbe
2019-02-01 10:44:23 +08:00
whoami-rajat
b079d1a022 Add project_id in group list and show API
Add ``project_id`` to response body of list groups with detail and show
group detail APIs.

Depends-On: I190cc67a001ffce2a533480e6e39e26cd3f981df
Change-Id: I3bc34a30b02f8a1ec2c5fecbcde6bd369c8e4a76
Implements: blueprint add-project-id-to-group-response
2019-01-30 13:20:58 +05:30
zhangbailin
c15a32aba7 api-ref: Add cipher to update an encryption type interface
Change-Id: I76b6d1f155e912a87c0ca157df3dcbbe59946800
2019-01-27 19:04:48 -05:00
Zuul
9cc474baa7 Merge "api-ref: fix response example of list-backups" 2019-01-24 13:05:21 +00:00
Zuul
7ac5101d1d Merge "api-ref: add response body for set-image-metadata-for-a-volume" 2019-01-24 11:17:25 +00:00
Zuul
ee9cf86967 Merge "Improve volume transfer records" 2019-01-22 13:25:45 +00:00
Zuul
5117ce1cab Merge "api-ref: volume_type_access should be array instead of object" 2019-01-15 01:55:39 +00:00
Yikun Jiang
3e16dfff8e Improve volume transfer records
Add a new microversion API to add source_project_id,
destination_project_id, accepted fields to the response of follow
APIs:

- Create a volume transfer
- Show volume transfer detail
- List volume transfer and detail

And the source_project_id will be recorded when a transfer is
created, the destination_project_id and accepted will be recorded
when a transfer is accepted.

Part of blueprint: improve-volume-transfer-records

Change-Id: I3d79f9a67a9aed7272871969e7c0942a1f396ea5
2019-01-14 11:50:43 +08:00
whoami-rajat
6ba39e4a9e Automate generation of volumes api-ref samples
This patch adds the following tests:

1) Volumes
2) volume-type access

Change-Id: Iad7932337647274dbbbc35045b4febbbc8d9d36d
Partially-Implements: blueprint generating-sample-files
2019-01-13 19:57:32 +05:30
whoami-rajat
c5c5c009ff Automate generation of API versions api-ref samples
This patch adds Tests for the following :

1) API versions
2) API extensions

Change-Id: Ieaa1e2768c091b93c7afcbf04ec4a181cb021ec5
Partially-Implements: blueprint generating-sample-files
2019-01-10 19:48:18 +05:30
Zuul
906acbc8a0 Merge "api-ref: fix some issues in volumes interfaces" 2019-01-09 02:40:18 +00:00
yenai
17aa176104 Add missing backup status in API doc
The status 'error_deleting' and 'deleted' doesn't exist in the doc.
Also the status error_restoring is a state of the volume, not backup.
This patch is to add and remove the respective statuses in the doc.

Change-Id: I96cd3d6fba38206a0a2b6c325092903b760b4ed4
2019-01-04 07:05:25 +00:00
Zuul
84d268d9a0 Merge "[Doc] Fix status and parameters of vol connection api" 2018-12-29 04:25:32 +00:00
liuyamin
c119ab87b9 [api-ref] Fix the parameter of image metadata
The value of os-vol-image-meta is not in parameters.yaml, so use
os-show_image_metadata to replace it.

Change-Id: I0400a1bf8dbe34f4b857e62832d11b098a8a2d2f
2018-12-25 10:29:30 +08:00
Zuul
5ea88854cc Merge "api-ref: add missing volumes_links in list-volume interfaces" 2018-12-19 01:59:32 +00:00
Zuul
dad7796622 Merge "Add user_id in backup list and show API" 2018-12-19 01:14:12 +00:00
Zuul
fba58e194e Merge "[api-ref] Fix the value of project_id" 2018-12-18 22:43:57 +00:00
zhufl
b389c18bd6 api-ref: volume_type_access should be array instead of object
https://developer.openstack.org/api-ref/block-storage/v3/index.html#list-private-volume-type-access-detail

volume_type_access in the response of "List private volume type access detail"
should be array, instead of object.

NOTE: the response sample file will be auto-generated in Iad7932337647274dbbbc35045b4febbbc8d9d36d

Change-Id: I1a02f3b7791f6c44d8e50949f28dc6a112429662
2018-12-17 09:22:20 +08:00
Zuul
806fac5606 Merge "Automate generation of api-ref samples" 2018-12-14 08:03:34 +00:00
zhangbailin
03867e3e89 Add user_id in backup list and show API
Add ``user_id`` to response body of list backup with detail and show
backup detail APIs. In this way, you can get the ``user_id`` in backup
list or show response, make the admin/user easy to manage backup file.

Blueprint: add-user-id-attribute-to-backup-response
Change-Id: I3ffb544ef3ee65276cee8b1e870d524fd0e57085
2018-12-12 00:52:05 -05:00
zhufl
eb10e43782 api-ref: add response body for set-image-metadata-for-a-volume
https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=set-image-metadata-for-a-volume-detail#set-image-metadata-for-a-volume
"Set image metadata for a volume" interface has response body,
so this is to add response parameter and response example for it.

Change-Id: I8139fd557cb3123dd71ab104e7e36546b862e345
2018-12-10 10:19:17 +08:00
Zuul
4eb559ef14 Merge "api-ref: fix succeed code and add field for update-backup" 2018-12-07 07:45:04 +00:00
whoami-rajat
67150217c9 Automate generation of api-ref samples
This patch adds the following functionality:

1) Base framework for test cases
2) Volume type tests

Change-Id: I0e51bcc8c634923ca6fcff99a9f40b786933caa5
Partially-Implements: blueprint generating-sample-files
2018-12-06 12:19:55 +05:30
zhufl
7fba6fdc4b api-ref: fix some issues in volumes interfaces
1. group_id is missing from the response of list-voluems and create_volume.

2. shared_targets and service_uuid are new in 3.48

3. migration_status, os-vol-host-attr:host, os-vol-mig-status-attr:migstat,
   and os-vol-mig-status-attr:name_id may not always be present, so they
   should be optional parameters.

https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=reset-a-backup-s-status-detail,update-a-backup-detail,create-a-backup-detail#create-a-volume
https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=reset-a-backup-s-status-detail,update-a-backup-detail,create-a-backup-detail#show-a-volume-s-details

Change-Id: I11201f2a604818e633eb2000b3c69162c668721d
2018-11-27 13:20:35 +08:00
Zuul
1b5a4d42e3 Merge "api-ref: Adding backup create response example" 2018-11-26 23:04:05 +00:00
Yikun Jiang
892e402c8e [Doc] Fix status and parameters of vol connection api
The response 'status' of initialize connection is 200, and the
"connector" parameter is required in initialize/terminate connection
API request.

This patch try to fix these wrong content.

Change-Id: I9d8c7c951b03f10fa29e3b3cc107a17e37b0e2bc
2018-11-23 03:29:00 +00:00
Zuul
7022bc2afb Merge "api-ref: volume summary is available from v3.12" 2018-11-16 01:36:12 +00:00
Zuul
b7eb676b00 Merge "api-ref: document encryption type provider choices" 2018-11-16 01:35:20 +00:00
Zuul
bd1b40f37b Merge "api-ref: fix response code and data type for volume interfaces" 2018-11-16 01:34:34 +00:00
Matt Riedemann
e7732680e0 api-ref: document encryption type provider choices
This updates the encrypted volume type provider
parameter descriptions for the create and update
requests to note the two choices of 'luks' and 'plain'.
Since we don't want those choices in the response
parameter descriptions, the parameters have to be
broken down a bit in the parameters.yaml file to
be request/response and optional/required.

There are currently other supported values for the
encryption type provider, including the legacy
classpath values, but we want people using the
non-legacy values so only luks and plain are
documented here, and luks is marked as the
recommended choice over plain (dm-crypt).

Change-Id: I496d30ecf6390f51cdd8e547b7345b3da30e92de
Closes-Bug: #1803513
2018-11-15 07:39:31 -05:00
zhufl
d85308c83c api-ref: volume summary is available from v3.12
GET volumes/summary is introduced to Cinder from V3.12, so this
to add the comment for it.

Change-Id: I7211ba4355fe9a10203e01436e571f41f8040adc
2018-11-14 10:51:07 +08:00
liuyamin
4933a6ea67 [api-ref] Fix the value of project_id
Change-Id: Ic48601e0279495920e57be9854b34ab7bbe94e8e
2018-11-12 15:31:41 +08:00
zhufl
45dc058c5c api-ref: fix succeed code and add field for update-backup
https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=update-a-backup-detail#update-a-backup

1. metadata is present in the response example of "Update a backup",
but is missing from the response parameters.

2. succeed code of update-backup is 200, not 202

Change-Id: I5c6098b1950b361a38d4a2b3a928344a277a3ed0
2018-11-09 10:57:31 +08:00
zhufl
192da355ba api-ref: add missing volumes_links in list-volume interfaces
https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=list-accessible-volumes-detail#list-accessible-volumes
https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-accessible-volumes-with-details

volumes_links is in the response body of list-volume and
list-volume-with-details when pagination is used. So it should
be an optional parameter.

Change-Id: If61797f9a5cb5c522ed62886f4114d43e7cbbdef
2018-11-09 10:52:18 +08:00
whoami-rajat
49d73ef83c api-ref: Adding backup create response example
The backup create response json file exists but isn't linked
with the api-ref guide.
This patch adds the link to it.

Change-Id: Ib26670803ed57a23f282ac8f679db6e4957e8cc7
2018-11-08 14:03:44 +05:30
zhufl
43490897c6 api-ref: fix response example of list-backups
https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=list-backups-for-project-detail#list-backups-for-project

The response example of "List backups for project" is not correct,
which seems to be that of "List backups with detail".

Change-Id: I02e3ea8cd5965722d38ef6be6ee6c929fe1ae4a2
2018-11-07 09:28:08 +00:00
zhufl
cf11b8dfed api-ref: fix response code and data type for volume interfaces
1. https://developer.openstack.org/api-ref/block-storage/v3/?expanded=get-volumes-summary-detail#get-volumes-summary
total_count in "Get volumes summary" should be integer

2. https://developer.openstack.org/api-ref/block-storage/v3/index.html#create-metadata-for-volume
Response code for "Create metadata for volume" interface should be 200.

Change-Id: If278e939a9a580329e24709877c13ed4e70d6180
2018-11-06 16:54:26 +08:00
whoami-rajat
609412fcd2 Improve/Clean api-ref parameters
The parameters with name like example_1, example_2 ... etc. cause
confusion while updating the api-ref docs like the examples below:

https://review.openstack.org/#/c/609639/
https://review.openstack.org/#/c/609611/

This patch does the following changes :
1) Replace numbering in the parameter with relevant names
2) Clean up unused parameters

Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-11-05 10:47:14 +05:30