Commit Graph

14 Commits

Author SHA1 Message Date
Goutham Pacha Ravi 95b44453b5 [DOC] Replace references to policy.json
The override file now supports yaml format. While
JSON formatting is absolutely fine, the file suffix
".json" will confuse our tooling.

Change-Id: I01ce4ab3e879a8dbbc7377997f7e497f15c9b15e
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2022-07-05 15:11:25 +00:00
Goutham Pacha Ravi 88cec4f2c5 Fix headings in the API ref
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>
2022-03-25 01:56:30 +05:30
silvacarloss 40da25f286 Add api-ref for security service update
Updates the API reference to fit into the changes merged in the
add/update security service in share networks feature.

Change-Id: Id7dd45dc23c41c1ade28b042f87b216142b8a062
2021-12-06 19:07:13 -03:00
Zuul 50401393c7 Merge "[api-ref] Fix incorrect parameters" 2021-03-23 01:34:21 +00:00
Goutham Pacha Ravi 2eab5de885 [api-ref] Fix incorrect parameters
Some of the response parameters for the
/shares APIs were either incorrect or
out of date. These inconsistencies
were discovered by Ashley Rodriguez
when working on the openstacksdk
integration for these APIs.

Change-Id: I475a7e4df2ee6924699b97c196f1958d4885c01d
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-02-12 18:17:24 -08:00
Goutham Pacha Ravi de29398128 [doc] remove project_id from api endpoints
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>
2021-02-09 21:59:07 -08:00
silvacarloss de62a36e3f Add api-ref for share network subnets
This patch updates the API reference to fit into the changes that
were done in order to implement share networks with multiple
subnets.

Change-Id: I667a26cbf9ea93509718b71dadc8fb304fbca855
Partial-Bug: #1843953
2020-08-06 21:58:37 +00:00
Goutham Pacha Ravi f185ff0f44 [api-ref] De-duplicate date and time parameters
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
2019-04-04 15:59:32 +00:00
Thomas Bechtold d7140ffe09 [api-ref] Replace "tenant" terminology with "project"
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
2019-04-04 08:58:01 -07:00
silvacarloss 3fe22863db Add api-ref for manage/unmanage with DHSS=True
This patch updates the manila api-ref adding content to the
manage/unmanage of share servers with DHSS=True feature.

Partial-Bug: #1818758
Change-Id: Ia63762df5cfb2c4b47cf59186ceb571b4c79c31b
2019-03-27 11:45:38 -07:00
Maurice Schreiber a84423a1be
[api-ref] Added share servers show and corrected path to details
Change-Id: Idc0fbd9f786b50dd4899258337aa5bcb61c4ab0a
Closes-Bug: #1795604
2018-11-20 11:34:27 +01:00
junboli acf8c99e9b Use rest_status_code for api-ref response codes
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
2018-03-24 01:07:16 +00:00
liuyamin c47fa9829f [Api-ref] Delete the duplicate tenant arguments in parameters.yaml
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
2017-09-09 13:22:58 -04:00
Daniel Gonzalez 3e86e3deac Migrate API reference into tree
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
2016-07-25 15:55:00 +00:00