13 Commits

Author SHA1 Message Date
Kiran Pawar
858939c190 Add 'default_ad_site' field to security service object
Allows to configure optional field 'default_ad_site' from version 2.76.
Restrict to make sure either server or 'default_at_site' provided, but
not both.

APIImpact
Relates-bug: #1988146

Change-Id: I8e21e9170eace134a51efed84de1ccc58eb7eaaa
2023-02-16 09:28:28 +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
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
shaoxj
2736d4adcc The parameters of 'list shares' are optional
Only 'project_id' in the path is required,
other parameters are not required

Partial-Bug: #1760644
Change-Id: I8f5735f8b828f33c95139e5a963f56b5b6e9105a
2019-04-04 19:03:38 +00:00
Goutham Pacha Ravi
5bf0337396 [api-ref] De-duplicate name and description parameters
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
2019-04-04 16:00:02 +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
Maurice Schreiber
192b4d128d NetApp ONTAP: allow multiple DNS IPs
The security service dns_ip parameter also takes a list of
comma separated DNS IPs for vserver dns configuration.
Allows HA setup, where DNS can be down for maintenance.

Change-Id: I1da99d0b44778d3ccaaff5871dfcb175b8cdbc02
2019-01-30 16:55:28 +00:00
shaoxj
cdf1470879 API: Add `all_tenants` parameter
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
2018-06-20 07:00:39 +00:00
Maurice Schreiber
1bd9a1e8f4 Add ou to security service
Allows to configure in which organizational unit the share ends up

APIImpact

Change-Id: I70fd4e0ea7898e85dff59a927b3cb086d5e408ac
Needed-By: I77d87c8e6f98054f2f02bc4202c14314ff321964
Partial-Bug: #1696669
2018-04-24 15:04:40 -07: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
Ha Van Tu
9152425f2f [api-ref] Refactor Manila security service API
This patch make security service api reference to be more readable
and maintainable.

Change-Id: I802f09baee7dda91999983947aca8406a57d445e
2016-09-28 09:30:10 +07: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