'group_id' is mentioned as an optional parameter in api-ref doc for
POST /v3/{project_id}/group_snapshots API but in the code if we don't
pass group-id it returns BadRequest.
This patch fixes this discrepancy by updating the api-ref according
to the code.
Closes-Bug: #1735177
Change-Id: Id2165a07995ab706d4a327f7340dccee7799c7b6
This patch implements the spec of creating volume from backup.
Change-Id: Icdc6c7606c43243a9e12d7a42df293b729f589e5
Partial-Implements: blueprint support-create-volume-from-backup
In v3 api-ref for restoring backup, the request contents are wrongly
described, it is mandatory to specify either the UUID or name of the
volume, Actually it's OK if you specify nothing.
The name parameter will work only if a new volume is created for restore.
Closes-Bug:#1732664
Change-Id: Ia6a9b99df0c7b83999a2e5ac9c945c91b284f807
Signed-off-by: Xiaojun Liao <xiaojunliao85@gmail.com>
There are some small mistakes in the api-v2 doc,
please see this bug description:1733148
Closes-Bug:#1733148
Change-Id: I3726159a23625a33415f23b971d6e6f47bd77846
The detailed information for a volume can include "volume_image_metadata"
in the case where the volume was created from an image, or in the case
where the volume was created from a snapshot of such a volume.
Update the API ref to include the field so we accurately represent
the code.
Change-Id: If5fcdefaa10bfb00e60aa4559d3282d3c6a53752
Closes-Bug: #1732763
I assume these were just typos, because 203 isn't an error response,
and for these APIs about the only error response you can get, besides
401 I guess, is a 403 for policy forbidding the user from making that
request. So this changes the various 203 to 403 error codes in the
API reference.
Change-Id: I377b4c11d04c84b00165aae00990c93c5d52e668
This patch mainly fixes the response parameters and examples for
the show/list/create group snapshots APIs.
Change-Id: If160ffdd7301337eac9353faffb72a9f069882c4
This patch adds support for display count info
in volume, backup and snapshot's list&detail APIs
since microversion 3.45, for instance:
1. /v3/{project_id}/volumes?with_count=True
2. /v3/{project_id}/volumes/detail?with_count=True
Depends-On: 1c8fe0ade43da925c5b810ef0cd27817f1c11c7b
Change-Id: I2e92b27c36357120fcf0ec5917c6484441c946a8
Implements: bp add-amount-info-in-list-api
This patch adds v3 api-ref for the following volume type API:
Update specific extra specs assigned to a volume type.
Change-Id: Ib8622870d53cbdc249aa465ce62ed45dea2b4089
The volume transfer accept and create API missed the api response,
this change is to add them for both V2 and V3.
Closes-bug: #1723867
Change-Id: I4f8005633ed1eb53ab08b3493cdc97d44103dafa
This patch adds v3 api-ref for two APIs:
1. Show all extra specs assigned to a volume type
2. Show specific extra specs assigned to a volume type
Change-Id: Id5771ee7e52748374ae6a3167116589273000297
Reset a snapshot's status API Request Example was syntax error with comma, so
remove comma to syntax correct.
Change-Id: I8b2c249aaf0f9729bc35b80ecd6cd28bb34835c0
Close-bug: #1720487
Volume_type is a object containing all information
about volume_type but its definition is wrong on
API-ref side
- http://developer.openstack.org/api-ref/block-storage/v2/#volume-types-types
This commit correct that to understand the API clearly.
Change-Id: I3384ad2f01917d71b3dfab46ef21d7e5c44cc904
Closes-bug: 1659443
In v3 api-ref for updating extra specs of volume type, the request and
response contents are wrongly described, and also the HTTP method and
URL are not correct. This patch addes new api-ref for it.
Change-Id: I4263c25a0638a68d0d102c7966ebb77604c019fc
We had an extra section that had a useless index link and a link
to the search page. To make search easier to find, moved that up
to the top and got rid of the index link.
Change-Id: I65d7a8930b7bb7db2f994fc615ff621956397e83
In the sample json files, some examples of the provider value were
wrong and showed a key manager class instead of an encryptor name.
Other samples showed the legacy encryptor classes where the newer
os-brick encryptor shorthand names should be used instead.
I3eec91e221692177833909e0378116cea4966807 removes support for the
legacy provider class names, so it is important that the samples
reflect the updated shorthand names.
Change-Id: I1c3879a5d12a8c9802deeac1c6e24b57310588d5
In the file api-ref/source/v3/index.rst, it missed include
volumes-v3-snapshots-actions.inc, This change is to add it
and fix doc format error.
Change-Id: Ib6dc549f8bc8da5dfd64d0e390cd70b27cd63177
The attachments API is completely new in the 3.27 API so
that should be pointed out in the API reference. The only
wrinkle is the 'complete attachment' API which is new in 3.44.
Change-Id: Ia22ddbcd86ecd12d74f365ec3c72d0635ff3566c
Partial-Bug: #1716705
The v1 API has been deprecated for many releases now. We have not
been able to remove it due to SDKs and tooling being slow to
update. This is the latest attempt to see if it has been long
enough.
Change-Id: I03bf2db5bd7e2fdfb4f6032758ccaf2b348a82ba
In api-ref/source/v3/samples, some of JSON file contents does not
match the current v3 input or output, This patch is to update the
Request and Response JSON contents.
Change-Id: Ib6f0fcb9dc476f77b20cd780cfc6e8e1e425f4e1
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
During the initial migration of the api-ref docs, there were
several parameter definitions pulled over that are not actually
used anywhere in the docs.
It may be that some of these _should_ be referenced, but at
least as of right now they are not. Rather than carrying them
around on the chance that they could be used down the road, we
should just clean them out for now.
Change-Id: Ic9018608b00705c80df05243647f5c81124610df
Some request details provided information about the other
JSON value while others didn't. To make things consistent
and to make sure API consumers understand how the requests
need to be structured, this adds missing instances. It also
reorders some parameter lists to be a little more logical,
so even though we can't show the nested nature of some of
these, it at least doesn't show inner values before outer
ones.
This also corrects many errors seen while going through
the API ref. This is by no means exhaustive, and is already
somewhat out of the scope for this patch, so it is expected
that there are some (many) cases that are not addressed by
this patch. Those will be fixed with ongoing effort in
future patches.
Partial-bug: #1713517
Change-Id: I30964ba8d829778fd01174d639d44ba07e4b77a6
