365 Commits

Author SHA1 Message Date
jeremy.zhang
999cd2be12 Fix parameter description in volume and snapshot manage extension
The parameters 'cinder_id', 'reason_not_safe', 'extra_info' can be None,
but are required in the response body of listing detail of managable
volumes or snapshots.

Change-Id: Iade148d2afeaae486aab4dc789d52e9522f206ee
2018-06-30 10:21:16 +08:00
Zuul
7959cd24d5 Merge "Add v3 api-ref for force delete snapshot" 2018-06-25 23:42:19 +00:00
Zuul
41178f1346 Merge "api-ref: Rephrase delete volume precondition" 2018-06-25 22:47:42 +00:00
Zuul
adf262aef4 Merge "api-ref: Adds os-update_readonly_flag API" 2018-06-22 21:46:10 +00:00
jeremy.zhang
299f4ecd0c Fix v3 sample files
This patch is mainly to fix some v3 sample json files to keep the format consistent.

Change-Id: Ibfe171f19e1530c0fcdc6a531c36871d1bc51a3c
2018-06-22 01:05:08 +08:00
jeremy.zhang
6ba228e2cd Add v3 api-ref for force delete snapshot
This patch is to add v3 api-ref for force delete a snapshot.

Change-Id: I44d16a9fa9065b5e92b18c487b45e7076ec03b0e
2018-06-21 23:34:16 +08:00
Dongcan Ye
cb0cb208e3 api-ref: Adds os-update_readonly_flag API
This patch adds "os-update_readonly_flag" volume action API.

Change-Id: Idad24f9a17af3323a26ed487f1f0d20306bf935f
Closes-Bug: #1775915
Closes-Bug: #1771390
2018-06-21 04:38:16 +00:00
jeremy.zhang
9519e20308 Add v3 api-ref for updating snapshot status
This patch adds v3 api-ref for updating relative fields to status of a snapshot.

Change-Id: I24b8a05c814eb6a69ce957c75b8d168576774380
2018-06-20 19:13:58 +08:00
Dongcan Ye
9e490e25a3 api-ref: Rephrase delete volume precondition
Change-Id: Ibab0cb257a17a1af37d522348f517185b80dfabc
Closes-Bug: #1774280
2018-06-16 03:34:48 +00:00
Zuul
b229a9aded Merge "api-ref: Fix some params in volume types" 2018-06-13 04:00:38 +00:00
Zuul
9a7b250606 Merge "[api-ref] Fix the parameter metadata in v3" 2018-06-12 14:06:56 +00:00
Zuul
38492b1bba Merge "Add missing volume APIs" 2018-06-12 12:40:52 +00:00
Zuul
7989b4c9b6 Merge "Api-ref: Fix the incorrect parameter description" 2018-06-12 12:31:26 +00:00
Zuul
20623abfe9 Merge "trivial: Add min_version: 3.1 to api_ref for upload volume" 2018-06-12 12:31:23 +00:00
Zuul
e6348f4aef Merge "[Api-ref] fix the type of service_id in worker cleanup api" 2018-06-11 23:40:31 +00:00
liuyamin
45f954d894 [api-ref] Fix the parameter metadata in v3
Change-Id: I5dffe060d73f700de6cd29101127e205362e203d
2018-06-11 16:02:58 +08:00
Felipe Monteiro
7c24eab261 trivial: Add min_version: 3.1 to api_ref for upload volume
This patchset adds min_version: 3.1 to protected and
visiblity params which were added to upload volume to
image action in microversion 3.1 [0][1][2].

[0] 7d95fb79c4/cinder/api/schemas/volume_actions.py (L150)
[1] https://github.com/openstack/cinder/blob/master/cinder/api/contrib/volume_actions.py#L232
[2] 7d95fb79c4/cinder/api/microversions.py (L42)

Change-Id: Ibdfa086d9bdadd11263b0a71aa3fff65faddb32d
2018-06-08 20:04:23 -04:00
Dongcan Ye
e3f24ed15e api-ref: Fix some params in volume types
This patch adds some missing params in volume types
and volume type access APIs. Also trivial fix for
the order of the params in the URL.

Change-Id: I767f68b4252a3b70755494cf82ca3b284112be75
2018-06-07 00:52:01 +00:00
junboli
9448e6e372 Api-ref: Fix the incorrect parameter description
In the attachment API, the response parameters, such as ``detached_at``,
``attached_at``, ``attach_mode``, ``instance`` are optional, however these
should be required, this is to fix these.

Change-Id: I2748e971655c3f5715585409e5c021f0d91690e4
2018-06-06 18:30:58 +08:00
Zuul
9bfc74428d Merge "Fix create backup API document" 2018-06-05 00:01:40 +00:00
Zuul
392e92b47c Merge "Fix api-ref for backup export and import" 2018-06-05 00:01:32 +00:00
Zuul
0574a8bfb6 Merge "api-ref: Fix v3 API version details error" 2018-06-05 00:01:25 +00:00
jeremy.zhang
a6dd458612 Fix api-ref for backup export and import
Add missing paramater description for backup export and import function.

Change-Id: I6408138ac738717c766752f5358025dbe62d7319
2018-05-29 22:51:19 +08:00
junboli
8ee82f04e6 Missing request parameters in update quotas
"backup_gigabytes" and "per_volume_gigabytes" parameters
are supported in api v2, they aren't mentioned in api v2
document[1]. On the other hand both of them are mentioned
in api v3 document[2].

[1] https://developer.openstack.org/api-ref/block-storage/
    v2/index.html#update-quotas
[2] https://developer.openstack.org/api-ref/block-storage/
    v3/index.html?highlight=backup_gigabytes#update-quotas
    -for-a-project

Change-Id: I135efd5c2b4735f5821922643926390976453bf5
Closes-bug: #1727631
2018-05-29 20:03:51 +08:00
liuyamin
e6d4b20656 [Api-ref] fix the type of service_id in worker cleanup api
According to [1], the type of service_id is int, so fix it.

[1]https://review.openstack.org/#/c/569036/

Change-Id: Ie142582a2a73564127be83c1e3531a07311b4153
2018-05-29 14:19:14 +08:00
Dongcan Ye
b8078a8e38 api-ref: Fix v3 API version details error
Show v3 API version details should not return informations about v2,
meanwhile location is not in Response Parameters.

Change-Id: Ida12222b3bdac10d030d56b9724f09ee097c0b3c
2018-05-28 03:54:37 +00:00
TommyLike
1a5b0c0133 Fix create backup API document
Make 'snapshot_id' optional as well as
reword parameter description.

Change-Id: I9ee404a8db5320d2a4cd7b50c2166446169bbba5
2018-05-16 15:29:09 +08:00
liuyamin
cfcd94bc9a Add missing volume APIs
A bunch of volume APIs are missing in current documentation, such
as os-reserve/os-unreserve/os-begin_detaching/os-roll_detaching
os-initialize_connection/os-terminate_connection, this patch is aim to
add the missing APIs.

Change-Id: If0732aa94db4e8cdef30a2be0c53314b507ee002
Closes-bug: #1761049
2018-05-15 20:15:49 +08:00
junboli
bed11c76da [Api-ref] fix incorrect host value in worker cleanup api
The value of host in sample request and sample response is not correct,
this change is to update this.


Change-Id: If8524a08795c222e67ca2c85243a42fb27e43bdb
Close-bug: #1758955
2018-05-15 02:44:52 +00:00
Zuul
a0e7cd9874 Merge "[doc] Add the possible status for attachment" 2018-05-09 01:43:59 +00:00
Zuul
c93371dc2a Merge "Add missing 'transfer' parameter in API document" 2018-05-02 23:27:10 +00:00
Zuul
283928fe1d Merge "api-ref: modify 'has_dependent_backups' param's description" 2018-05-02 17:29:52 +00:00
TommyLike
181ab96ac8 Add missing 'transfer' parameter in API document
This patch adds the missing parameter 'transfer' to accept
transfer's API document.

Change-Id: I88f0a01ef22be9ff1b483e517f08866a7e1b19ce
2018-05-02 15:57:52 +00:00
junboli
e608b0727c [doc] Add the possible status for attachment
Add the possible status of the attachment, and also
make short description for each status.

Change-Id: Ieef1ea94acf69fa906b9f62f2081d66166ba9174
2018-05-01 22:09:12 +00:00
lihaijing
1ae1a02933 api-ref: modify 'has_dependent_backups' param's description
Change-Id: Iec37578d367db109ef4d8eb8c07c832402661f75
Closes-Bug: #1766057
2018-04-27 15:33:28 +08:00
Dongcan Ye
8addf353f4 api-ref: Correct the cgsnapshot_id parameter
The cgsnapshot_id parameter in delete and get operations
should in path, and is required.

Change-Id: I5525c05769dcd27ff06d7b1d4c97698f99075f09
2018-04-26 17:08:32 +00:00
Sean McGinnis
e4a41feab3 Clarify sizing when creating vol from source
The api-ref stated new volumes created from a source volume or
snapshot would have the same size as the original, but that is
not the case if a larger size is requested.

Change-Id: Id2e0d53b56d5879026c182521a512dc2cfcd28f7
2018-04-17 17:47:39 -05:00
albertjone
d830328663 fixs grammar problems and unify format in api-ref
Change-Id: Ib83d1cb6def076c0ab06947b681cd10cd03ed002
2018-04-05 02:45:01 +00:00
TommyLike
902719a46e Remove extended attribute 'os-volume-replication' in Doc
'os-volume-replication:extended_status' and
'os-volume-replication:driver_date' are unavailable
since the merge of patch [1] during Liberty, remove these
from API document.

[1]: https://review.openstack.org/#/c/275797/

Change-Id: Ib319702f085930a6bf528ef95fb17a7da8451e96
2018-03-31 11:53:21 +08:00
wanghui
5653b99a55 Move openstackdocstheme to extensions in api-ref
Move openstackdocstheme to extensions. According to the guide below:
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: Ibfb75e2a484b09b18cd18a4b2d21d559d7d4b475
2018-03-27 10:45:17 +00:00
Zuul
5bf34b8923 Merge "Remove driver-specific notes from extend api-ref" 2018-03-26 20:25:43 +00:00
Eric Harney
2ba35e3709 api-ref: Fix microversion for volume.backup_id
This was added in 3.47 in change
Icdc6c7606c43243a9e12d7a42df293b729f589e5.

Change-Id: I87ade05c14ecb47d92a6406c8ce0bf9da1e31ffa
2018-03-26 12:04:09 -04:00
Eric Harney
f490b73f5f Remove driver-specific notes from extend api-ref
This is not part of the API contract.  It should
be documented elsewhere as a limitation of the
volume driver.

Change-Id: I3586853ce7e11150d54cc552863bd3d4f6db197b
2018-03-26 11:47:33 -04:00
Zuul
8ec1e9f04c Merge "Remove some unused parameters in parameters.yaml" 2018-03-23 10:37:32 +00:00
Zuul
517dcf451a Merge "Support cross AZ backups" 2018-03-18 01:26:19 +00:00
Zuul
9d894b5232 Merge "Fix api-ref response code title levels" 2018-03-14 04:30:37 +00:00
Sean McGinnis
a96fad9f3b Fix api-ref response code title levels
Using the wrong character resulted in the wrong title level
being used for the response codes, which in turn caused the
"detail" show/hide toggle to not be able to hide all of the
per-endpoint details. This corrects these to be at the correct
level.

Also ran into issues after changing them where sphinx was not
happy with the random title levels. This appears to be due to
the order processed and whether not earlier included files had
all subsequent levels. Adding an additional title in our first
included file resolved that problem.

Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03
Closes-bug: #1755566
2018-03-13 15:57:54 -05:00
Matt Riedemann
5b83e38daf Fix API reference attach_mode parameter default for attachments API
The default attach_mode for volume attachments is "rw", as can
be seen from looking at the VolumeAttachment.finish_attach method
and VolumeManager.attachment_update method. The REST API itself
does not set or return a default attach_mode, it's all set in the
data model when the attachment is 'completed' by assigning a host
connector.

Change-Id: I1e41e93bd534d830311a653eb16fef89a2d8431a
2018-03-13 15:03:21 -04:00
Zuul
12483f1995 Merge "Use rest_status_code for api-ref response codes" 2018-03-13 04:20:26 +00:00
Zuul
08cfa44d35 Merge "Add 'metadata' in backup detail&show API document" 2018-03-12 15:36:54 +00:00