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
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>
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
The description for the backups API in both the v2 and v3
reference had a generic statement that only available volumes
can be backed up and restored, which is misleading since it
is possible to backup an in-use volume if the force parameter
is used.
This change drops the generic statement from the high-level
description and opts for per-API descriptions about the status
preconditions for backup and restore operations.
The v3 restore reference already mentioned the status precondition
so the only change to that is fixing the bullet list formatting.
Change-Id: Ib6c61af9ced2527884569fa15a848a215dd985b8
Closes-Bug: #1799499
https://developer.openstack.org/api-ref/block-storage/v3/index.html#list-snapshots-and-details
1. updated_at is missing in the response fields of show-snapshot
and list-snapshots
2. id's description is "The UUID of the volume transfer.", which
is incorrect.
3. volume_id's description is "The UUID of the volume.", which is
not very accurate.
4. os-extended-snapshot-attributes:progress is something like '100%',
so it should be string, not integer
5. response fields of show-snapshot-metadata is incorrect.
6. metadata is missing in the response example of update-snapshot
7. snapshots_links is missing in the response of list-snapshot
Change-Id: I0f6994c2d2dc27d3d594acdd460e27c338f86a2c
Some drivers will report total_capacity and free_capacity
as float, so this is to change the data type description to
include floating point.
Change-Id: Icd206ba3733adf9543a9e1384ef7245e287ee858
With the addition of schema validation and the release of cinderclient
4.0.0 we no longer accept source_replica as a volume creation parameter.
This was part of the short lived replication v1 functionality that was
removed several releases ago and never had support beyond one backend
type for one or two releases and has had no affect for quite a while
now.
Change-Id: Idd848628759884c1e637ca17dc292f776e4adf47
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
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 "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
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
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>
"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
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
