The volume_type parameter to the volume create API can be
either the volume type name or ID, the cinder-api will look
it up either way. This wasn't obvious from the API reference
and required digging into the code to figure it out. This change
simply clarifies the usage in the API reference.
Change-Id: Iae8c43374dee9767e17252279822ccd2121d8246
The volume-type parameter in the update quota class sets
API reference was confusing. The volume_type is a namespace
on quota class values for snapshots, volumes and gigabytes.
The os-quota-sets API reference had this documented correctly,
so the os-quota-sets parameter values are re-used here for
os-quota-class-sets.
Change-Id: I6e8993f909834797572ec4b911bf709c3701fff1
Closes-Bug: #1794120
The "name" parameter to the volume create API is optional,
this makes the docs reflect that. While in here, I've
renamed volume_name_1 to volume_name_optional so the variable
name is descriptive and dropped the redundant name_8 variable.
Change-Id: Ice42f06112a268b229f770f34096de19eb3447b2
Closes-Bug: #1794115
I62072573624c9e579a61affed6a7f8d57a6fdb6d tries to add schema
validation for volume services, and there are some inconsistencies
in the api ref doc.
https://developer.openstack.org/api-ref/block-storage/v3/#list-all-cinder-services
1. As Response Example shows, status takes the value of enabled
or disabled, not available/unavailable.
2. response may contain backend_state field which is optional.
Change-Id: I2435e3dc7c704de158b479d2ea543409b7686a07
This pulls in our microversion history document into the api-ref to make
it easier for api consumers to discover the history of API changes.
Change-Id: I9033a48e3f60199b60a904c8cf028f4a1e037ec3
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
I512bfc97a1c3d4a508daf580d99fefe2a9ae4e13 tries to add response
schema validation for messages interfaces, and there are some
inconsistencies in api ref:
1. delete message success code is 204, not 202
2. id is of the format uuid, which means string, not integer.
Change-Id: I13280bf158f541ed0514930274df8c03a0f81c4c
This documents the default value (False) for the no_snapshots
parameter to the 3.55 volume transfer API and also fixes the
no_snapshots value in the API sample to use proper json.
Change-Id: I852a04c0b772de64fa82c9c1630dff8ba6454eeb
This adds the simple pre-conditions for the volume transfer
API (in its various forms) to the API reference. This came
up during discussions about nova server instance ownership
transfer and questioning whether or not in-use volumes could
be transferred and finding the API did not mention that case
at all.
Change-Id: I0bd42dd6a0e291979fb37bcab3823dfde369e7a9
Adds the v2 and v3 API reference documentation for the
admin-only (by default) os-migrate_volume volume action
API. The only major difference with the v3 API is the
cluster parameter introduced in the 3.16 microversion.
Change-Id: I70f6b2cc4d25ea155ce09ddeec26b995890a2db3
Partial-Bug: #1607539
Adds the api-ref information for the the 3.55 version of the volume
transfer API.
Change-Id: Ib91c2f7018184821437da41bc0f7b0c0b2e69f0c
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
We had a few instances where the title level used for calls in the
api-ref was wrong, resulting in the api call being hidden inside the
details of another title level.
This fixes title levels to be consistent and adds a missing inclusion to
the v2 index.
Closes-bug: #1787203
Change-Id: I602250117dbf52f9e031e945040b45f089d8602e
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
The CoprHD driver was marked unsupported
in Rocky and the vendor has indicated that
the driver is deprecated. Given the feedback
I am removing the driver.
Change-Id: I978315402edeb0c5dd6aee28315973fa502b0e20
The description for the messages API was very terse. This adds some more
details to provide some description of what the API is used for.
Change-Id: If15400e9a538bf533e93f9693b6eddeb114fa7e5
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This feature changes Cinder to transfer
snapshots with volumes at the same time by default.
If user doesn't want to transfer snapshots, they could use
a new optional argument '--no-snapshots' after microversion 3.55.
And we also introduce the new V3 api 'v3/volume_transfers'
to move this API out of contrib into Cinder V3 API.
The cinderclient patch: https://review.openstack.org/#/c/577611/
Change-Id: If848d131e5edcdb77d0b3c2ca45a99c4d5e14d1e
Implements: blueprint transfer-snps-with-vols
This patch adds a reno for validate boolean parameters with spaces.
Also adds valid values in api-ref for boolean parameters that user
can pass in request body.
Implements: bp/json-schema-validation
Change-Id: Iff4b2906dba93a238d720a218fcf7a9f78b96a37
128 bit keys don't even work, and wouldn't be
recommended if they did.
Everyone should be using 256 bit keys.
Change-Id: I14c52b35abd55d0147b877b60af12c92130fa4a7
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
