Commit Graph

14 Commits

Author SHA1 Message Date
Zuul ab5ffd0efc Merge "Fix headings in the API ref" 2022-05-12 13:20:58 +00:00
zhu.boxiang 8faa968ed5 DOC: fix the uri for share group types
1. Use group-specs instead of group_specs for share group type.
2. Use access instead of share_type_access for share group types.

Change-Id: Ie5ac1b927ca4a01269f1c255cee52bdf2ebf7c69
2022-04-21 17:28:10 +08: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
Victoria Martinez de la Cruz 3a1e23801f Support group specs search for share group type API
Add support for group_specs filter search in share group type list API.

Implements: blueprint support-group-spec-search-share-group-type-api
Change-Id: I10caed1d524614a74a75e8f856b0579ab11dc4b5
2021-12-09 17:26:11 +00: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 a5112a3f10 Update api-ref for share groups graduation
Moves the share group APIs documentation out of the experimental
session.

Closes-Bug: #1659025
Change-Id: Ib1970c34b6068fa7ef4f09027817c647091d6668
2020-09-21 15:43:14 +00:00
Goutham Pacha Ravi e5582cc5a6 [api-ref] Use relative links and fix grammar
When referring to documents that are published
from the same folder, we can use relative links.

Change-Id: I431e20713e1b91be3bf9fa2f57a9c9b88519d6b4
2019-07-22 12:50:43 -07:00
Andreas Jaeger 7916986e64 Update api-ref location
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
2019-07-22 19:15:50 +02: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
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
Goutham Pacha Ravi 41d243c394 [doc][api-ref] Fix annotation and missing parameters
- 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
2019-03-27 20:09:29 +00:00
lijunbo cf677f2603 Retrieve is_default value to fix empty display in CLI
This bug is from path[1], when we use manila client to create
a share type or share group type, the is_default value is always
empty, so add the is_default value when we create each share type
or share group type.

Closes-bug: #1743941
[1] Ib264d8422fe57701f990cbbf7ea5d1e90b8b0008

Change-Id: Ia8bcb632591fc0b5438847b22ec59c2039ecf5f1
2018-07-24 12:00:58 +08: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
zhongjun 9f2f05ffc4 Add API document for share group [1/3]
This patch adds a new API document for share group type.

Partial-Bug: 1724716
Change-Id: I852d264eb120027aad32997dc64a6ca428ee55a4
2017-10-31 10:06:34 +00:00