Many resources in manila have user-defined
names and descriptions. All of them have the
same restrictions that apply, so represent them
as the fewest parameters needed.
Having common parameters is easier to maintain in
the documentation.
Change-Id: Ib175e8d78e4240bf40d87a47af2459ac520fb24a
Partial-Bug: #1760644
Many APIs present information when the resource
in question was 'created_at' and 'updated_at'.
Having common parameters is easier to maintain in
the documentation since the description is the same
across the board.
Change-Id: Ia5d4ac399fe0d7983c61f5c5e0245d0987e97d6a
Partial-Bug: #1760644
Nowadays "project" and "project_id" are used instead of "tenant" in
the OpenStack world. See [1] and [2].
- Replace "tenant_id" in the API paths to "project_id"
- For most manila resources, the "project_id" in an API response body
refers to the project that owns the resource. So, create a unified
parameter and share that across the APIs.
- Fix path variable names, and their order
- Fix usage of "UUID" to refer to project and user IDs
- Fix query parameters
[1] https://docs.openstack.org/operations-guide/ops-projects-users.html
[2] https://developer.openstack.org/api-ref/identity/v3/index.html#projects
Partial-Bug: #1760644
Co-Authored-By: Goutham Pacha Ravi <gouthampravi@gmail.com>
Change-Id: I64e4ef8ad258d07c7d80d11a4d015c4b82156722
- Call out the maximum API version in Stein (2.49)
- Add parameter 'cast_rules_to_readonly' to share instance API ref
- Remove parameters 'export_location' and 'export_locations' from
share instance API ref.
- Add "min_version" and "max_version" annotations on parameters
where missing.
- Add "versionadded" annotation to APIs
- Add "DEPRECATED" annotation to deprecated APIs along with
a warning message.
Identical changes to the manage/unmanage APIs are handled
in https://review.openstack.org/#/c/647973/
Partial-Bug: #1760644
Change-Id: I5342cc26d1cbeea8ca3d55868e0f69d525333421
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: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
