The normal response code for update or delete API described in volume
attachments api-ref is 202, but the actual response code from the curl
request is 200. This patch is to fix the response codes of these two
APIs in api-ref.
Change-Id: I6eb43f63bb504cb64b12f55de759779058b2979d
Cinder added updating backup support in V3.9.
This patch added related api-ref.
Change-Id: I537cb609240e3bcfa130a116e1912d1b660a21f8
Closes-bug: #1607388
There is no document about update a volume's bootable status,
so add the missing doc.
Change-Id: If706205678cfd7a803e2d7733bec34494b47fc66
Partial-Bug: #1607539
One of the purposes of force-detach is to help the admin clean up
if things are in a bad state, so there might not be a connector to
pass in. This is the case if Cinder thinks the volume is attached
but the Nova instance has already been deleted.
Change-Id: I417ed7b100dfe8402599028597511949e00725ac
Closes-Bug: #1619647
Current url scheme doesn't allow to skip admin_tenant_id
or tenant_id params. This change marks them as required
in api-ref. Get default quotas for a project signature
was changed on correct also.
Partial-Bug: #1415214
Change-Id: I0c528d1c49346477b608a12f8f35ee6d47404bd3
This patch did:
1. Add list manageable volumes API doc.
2. Add create and list manageable snapshots API doc.
Change-Id: Iccffb69b0ffb220f43258ee4c47d5d8964ae7836
Closes-bug: #1590977
Add "snapshot_id" and "data_timestamp" and "volume_name" to
the response parameters and error response code in the api-ref of
ext-backups.inc.
Change-Id: I2e3a6c737a74816e5e56b5a435a73e0bf501bec8
Closes-bug: #1676693
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
Now cinder will raise 400 if invalid filter
keys are specified, Update the corresponding
list APIs.
DocImpact
Depends-On: ff3d41b15abb2915de87830980147be51e5da971
Change-Id: I8419b374d7f743e7e9fc88e31c8c4f7d9470059b
This applies an order to the v3 API reference documents.
The idea being how does a new user come into and use the API
and what APIs should they see first when getting started.
Naturally they need to know about versions and microversions
that are avaible. Then they might need to know about volume
types before creating a volume. Once they create a volume
and know the basics of working with volumes, they can start
to take some actions on volumes. After that it's just kind
of a random free for all of APIs and the only order applied
to the rest is sorting alphabetically by title.
Change-Id: I8956de3e6907582f7115430eb959813a13e87a49
Since the v2 API is deprecated, put it in the index after
the v3 API which is current, since as a user the first thing
I want to see is the currently supported API reference, not
the deprecated stuff I shouldn't be using anyway.
Change-Id: I760533ca693cb8f678a6031e07789cd68f11bc47
Added volume type encryption sections to volumes v2 types and
added related parameters to parameters file.
Appropriate sample files added.
Had to add for v2 to several headings to pass tox/gates
Change-Id: I7a35551c4ebd345ce2d6c42217015b29c324d96c
Closes-Bug: #1679736
Add attachment API related Docs, please note we
use 'instance_uuid' in the request and 'instance' in
the response to represent the same thing 'server_id'.
DocImpact
Change-Id: I8bd5a9061af2b47fd227e8cf2f48f80f271bde14
Delete volume with cascade is supported by Cinder from V2.
cascade is missing in api-ref.
Change-Id: I66b4bb345aba5a6b4165f971556b858e4c0e258c
Closes-bug: #1677456
Volume/Snapshot contains two kinds API for it's metadata: POST/PUT
POST is used for creatng or replacing the volume/snapshot's
metadata items that match keys. It doesn't modify items that
are not in the request.
PUT is used for replacing all the volume/snapshot's metadata
with the key-value pairs in the request.
Cinder's api-ref description is wrong. This patch fixed the
description and added the missing POST/PUT request.
Change-Id: I51128d32c9f70ba57d7d4cf0634a16ca566db95f
In Block Storage API V3, reset group and group-snapshot status
actually use 'POST' method not 'PUT' mothod.
Change-Id: I1eb1f5576bfb0dc4c68e0067f8fa0453f1d3b9db
Closes-bug: #1676252
Add "display_name" and "replication_targets" to the response parameters
in the api-ref of getting capabilities.
Change-Id: Id1776641ea9938d024906707fec2e21404668ff7
Closes-bug: #1674237
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
This fixes the 500 resulting from the KeyError when mountpoint
is not provided during an os-attach call. It also fixes the
API reference docs to no longer lie about mountpoint being
an optional parameter.
Change-Id: Ica9ccb0246bc84c087afc338b5102ce48f57e82b
Closes-Bug: #1575675
In the document of cinder api,there are duplicate interface in the
api-versions.inc and volumes-v2/v3-versions.inc about listng all
api versions(rest_method:: GET /).So remove the interface in
volumes-v2/v3-versions.inc
Closes-Bug: #1674278
Change-Id: I34da088161771ec8e518a02235c7f78988a311f5
