We use *.inc files extensively, especially in the api-ref, but these
files are not covered by default with our doc8 validation.
This adds support for those files and fixes a few issues that were
identified after enabling coverage.
Change-Id: I807823f3cb44274c3940db55e901d434304a09f5
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This patch adds support for transfer pagination.
Co-Authored-By: Yikun Jiang <yikunkero@gmail.com>
Closes-bug: #1814195
Change-Id: Idb04f783b2287b2b45d626131648b0005a232fbe
Add ``project_id`` to response body of list groups with detail and show
group detail APIs.
Depends-On: I190cc67a001ffce2a533480e6e39e26cd3f981df
Change-Id: I3bc34a30b02f8a1ec2c5fecbcde6bd369c8e4a76
Implements: blueprint add-project-id-to-group-response
Add a new microversion API to add source_project_id,
destination_project_id, accepted fields to the response of follow
APIs:
- Create a volume transfer
- Show volume transfer detail
- List volume transfer and detail
And the source_project_id will be recorded when a transfer is
created, the destination_project_id and accepted will be recorded
when a transfer is accepted.
Part of blueprint: improve-volume-transfer-records
Change-Id: I3d79f9a67a9aed7272871969e7c0942a1f396ea5
This patch adds Tests for the following :
1) API versions
2) API extensions
Change-Id: Ieaa1e2768c091b93c7afcbf04ec4a181cb021ec5
Partially-Implements: blueprint generating-sample-files
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
Add ``user_id`` to response body of list backup with detail and show
backup detail APIs. In this way, you can get the ``user_id`` in backup
list or show response, make the admin/user easy to manage backup file.
Blueprint: add-user-id-attribute-to-backup-response
Change-Id: I3ffb544ef3ee65276cee8b1e870d524fd0e57085
This patch adds the following functionality:
1) Base framework for test cases
2) Volume type tests
Change-Id: I0e51bcc8c634923ca6fcff99a9f40b786933caa5
Partially-Implements: blueprint generating-sample-files
The response 'status' of initialize connection is 200, and the
"connector" parameter is required in initialize/terminate connection
API request.
This patch try to fix these wrong content.
Change-Id: I9d8c7c951b03f10fa29e3b3cc107a17e37b0e2bc
This updates the encrypted volume type provider
parameter descriptions for the create and update
requests to note the two choices of 'luks' and 'plain'.
Since we don't want those choices in the response
parameter descriptions, the parameters have to be
broken down a bit in the parameters.yaml file to
be request/response and optional/required.
There are currently other supported values for the
encryption type provider, including the legacy
classpath values, but we want people using the
non-legacy values so only luks and plain are
documented here, and luks is marked as the
recommended choice over plain (dm-crypt).
Change-Id: I496d30ecf6390f51cdd8e547b7345b3da30e92de
Closes-Bug: #1803513
The backup create response json file exists but isn't linked
with the api-ref guide.
This patch adds the link to it.
Change-Id: Ib26670803ed57a23f282ac8f679db6e4957e8cc7
The parameters with name like example_1, example_2 ... etc. cause
confusion while updating the api-ref docs like the examples below:
https://review.openstack.org/#/c/609639/https://review.openstack.org/#/c/609611/
This patch does the following changes :
1) Replace numbering in the parameter with relevant names
2) Clean up unused parameters
Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
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
