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>
Share network list API referece was missing some filter parametes.
Add the missing parameters so users can be aware of all the options
available to query share networks.
Closes-Bug: #1945711
Change-Id: I21b4f48d0c41f052aca1d7dcd0f1b640cfa3084a
Updates the API reference to fit into the changes merged in the
add/update security service in share networks feature.
Change-Id: Id7dd45dc23c41c1ade28b042f87b216142b8a062
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>
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>
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
Only 'project_id' in the path is required,
other parameters are not required
Partial-Bug: #1760644
Change-Id: I8f5735f8b828f33c95139e5a963f56b5b6e9105a
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
When administrarots query snapshots, share networks, or security
services, they may set ``all_tenants`` to true to get records for all
OpenStack projects.
Change-Id: Ia208dec102295f1021ce5c4da88397e7946c8dba
1. Share snapshot state must be ``available`` or ``error``.
2. Share network must not be in use by any shares or share groups.
Change-Id: I4bc81ed3677c8d65059b47b22aec2edbecf2c55f
The attributes "gateway" and "mtu" are already added in Shared File
Systems API since version 2.18 and 2.20. This patch provides description
about them in response parameters, and adds them to response examples.
Change-Id: I55e3a04453a9edd20b5ca4e1627ae8c3ae5601cc
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
* Change description parameter 'required' attr value
from true to false.
* Add neutron_net_id and neutron_subnet_id in share
network update API request parameter.
Closes-bug: #1727145
Change-Id: Iedde7a2a674a60e760b47d5eb2973f42d79223d1
Nova network was deprecated in Newton and is no longer supported for
regular deployments in Ocata [1].
Complete the removal of nova network support from manila begun in [2]
by removing support for ''nova_net_id`` in the share networks API,
by removing the corresponding column from the share networks DB model,
and by removing the nova network plugins themselves. Unit tests for
share network api views were refactored to remove redundancy while
extending coverage to the new microversion introduced with this patch
and maintaining full coverage of earlier microversions.
APIImpact
DocImpact
UpgradeImpact
Partially-implements: bp remove-nova-net-plugin
[1] http://docs.openstack.org/releasenotes/nova/unreleased.html
[2] I846b760fa7c01f7f86768399a2bfad9ced7e57cd
Change-Id: I8b9a559fbea61979f01737ed1dc272276c4f1269
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
Zuul