openstackdocstheme's custom styling doesn't display (h1)
headings in the body of the API ref. To work-around this
problem, demote the section headers and increase
the display level of the toctree.
Change-Id: I18b6ab44b62c4f17d854e5d32b4aef546992c79a
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
As of API version 2.60, a project_id is no
longer needed in the API URLs.
Fix the docs to indicate that.
Also fix up a few quota parameters that use
project_id in a different place in the API path.
Change-Id: I24b32c8521805a7d67d512d36d644c0f07c532ea
Implements: bp remove-project-id-from-urls
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
Implemented several improvements to share migration in documentation
according to https://review.opendev.org/#/c/406305/
Summary of changes:
- Add driver-assisted mandatory parameters.
- Removed previous API documentation because support for them isn't
there anymore after the backwards incompatible changes were
made via https://review.opendev.org/#/c/406305/.
- Add force-host-assisted migration.
Change-Id: I6d446b4037a3a9991e375f0a8bfb1f6edce09c1f
Closes-Bug: #1658230
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that the location API location /shared-file-system and not
/shared-file-systems.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: I86f50af83be699fa7e0fb064abb20324e2d87b86
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
In the parameters.yaml file, the description of tenant_id_path is the
same as tenant_id_1, so delete the parameter tenant_id_1.
Change-Id: If4f738f6e32823f196b8ffe224bda3945ab97717
The API Documentation team has requires [1] that
projects maintain their api-reference in-tree and
build it to the developer.openstack.org website.
This version of the API reference uses os-api-ref
and compiles API documentation close to that of
the OpenStack compute service (nova).
Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com>
[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
Implements: bp move-manila-api-reference-in-tree
Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
Goutham Pacha Ravi