As end user can use either of "policy.json" or "policy.yaml" , so need
replace the mentioning of "policy.json" to the just "policy
configuration file" in api-ref.
Change-Id: Ibb8f56a89d3f188be18cc4ee7de493910a02fb98
Closes-Bug: #1875643
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 value of os-vol-image-meta is not in parameters.yaml, so use
os-show_image_metadata to replace it.
Change-Id: I0400a1bf8dbe34f4b857e62832d11b098a8a2d2f
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
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
Rather than our freeform way of listing response codes in our
api-ref, we should be using the os-api-ref extension option to
get nicely formatted response code listings.
https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code
Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
I had to dig into the code to figure out that the force
detach volume action was for admins by default. We should
make that clear in the API reference.
Change-Id: I3493e23dba8267fb7e403d30dd0d1e90c8f7726b
This adds some notes about two things to consider with a volume
retype operation on an in-use multiattach volume:
1. The volume API will reject a retype operation on an in-use volume
where the volume's multiattach value would change.
2. Retyping an in-use volume that has more than one active read/write
attachment is not recommended because on the nova side the swap
volume operation performs a blockRebase which could potentially
lead to data corruption.
In the future, we (nova or cinder or both) will likely need to make
some changes as to what the default attach_mode is for secondary
attachments to a multiattach volume, since today we default to read/write
if it's not specified by the caller when making the attachment.
Change-Id: Ib5a2830ea3cd37236947677225252ef42edaa347
We had a mix of formatting for our API response codes. This
makes it so all have a leading space, no trailing comma, and
no empty Error response labels.
This also addresses a formatting issue with due to the spacing
between the Normal and Error lines that was causing the two to
run together in the formatted HTML, making it harder to read.
Change-Id: Ic411ee9f671c48ce60bda21984dafe55135685ba
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
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
There is no document about update a volume's bootable status,
so add the missing doc.
Change-Id: If706205678cfd7a803e2d7733bec34494b47fc66
Partial-Bug: #1607539
There is no API doc found for force-delete volume in cinder.
We need to add the API doc for the operation with its description,
request and response parameters.
Change-Id: Id25b4070a3946d2d7d89f44bdc81039286a5d8fe
Closes-bug: #1673644
Now some API documents for volume actions like
extending volume(https://developer.openstack.org/api-ref/
block-storage/v3/?expanded=extend-a-volume-size-detail) are
using incorrect request argument description
'volume_id in body'.
It should be 'in path'.
Change-Id: I2006b4af4dfc09fb0403c1a78ecef4ac920a51c4
Closes-Bug: #1691358
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
Modifies heading levels in .inc files to allow nested display in
table of contents. Table of contents depth has been changed to allow
this.
Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
In the api ref most of our references to the status parameter are wrong,
since they are all referencing `status`, which in most cases is:
status:
description: |
The ``status`` of the consistency group snapshot.
This patch fixes this by referencing the right status parameter.
TrivialFix
Change-Id: I3f76ad10bacd8c75f742efc3ff3395a7effc31b5
Our Api-ref CI job failed due to the change[1] in os-api-ref.
This patch fixed the issue.
[1]: I8686006339b82ed5465dd8e4d3a8b15f85ee897c
Change-Id: I00458bef8729e9ff877b4e38563f5d133de47cf5
Updates v2 and v3 documentation to reflect admin-only status of
API within volume actions.
- Edited to add bug reference
Change-Id: Ib7eff37bbbc05fedd2d9c9349ca500b20875e64e
Closes-Bug: #1501752
Sofia Enriquez