Commit Graph

8 Commits

Author SHA1 Message Date
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
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
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
804b81226c [Doc] Delete consistency group in doc
Since consistency group APIs were removed in 2.31 API version.
Now we delete consistency group description in docs.

Change-Id: I6499ae6c98d9489a257bb20febd6c1ddb9e17b12
2017-09-18 11:29:57 +08:00
Goutham Pacha Ravi
6274c20b78 [api-ref] Fix missing parameters in api-ref
The new version of api-ref raises warnings to indicate
missing parameters. Nothing like an amber alert around
feature freeze.

[1] http://lists.openstack.org/pipermail/openstack-dev/2017-January/110606.html

Change-Id: Ieeb018ef4f42ddb8e4271048b385ae679392c59c
Closes-Bug: #1658494
2017-01-23 02:25:31 +00:00
zhongjun
d5643c75f5 Add share_type filter support to pool_list
Administrators intend to get the pool's information filtered
by share type(actually filtered by share_type's *extra_spec*)
more directly.
The blueprint is to add a filter key 'share_type' to cover
this situation.

APIImpact
Implements: blueprint pool-list-by-share-type
Change-Id: Ifd64bb84d03a02aa0a118cc42e1d1b373c439884
2016-12-09 09:59:34 +08:00
Ha Van Tu
6e906bacd9 [api-ref] Refactor Manila scheduler stats API
This patch makes the scheduler stats API reference more readable
and maintainable.

Change-Id: I78aeb7e273abc86922de2e69e4c6b0a2e75d0c1c
2016-11-29 10:19:37 +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