22 Commits

Author SHA1 Message Date
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
Goutham Pacha Ravi
271214a051 Update Share types api-ref
Was missing a query parameter (is_public)
and some information on an existing query
parameter (extra-specs)

Change-Id: Ib70e08c963cf1f583ab6d5fbae6a69aa3593980a
Closes-Bug: #1816486
2020-08-06 17:06:21 -07:00
haixin
01e89ae26b Add update share-type API to Share Types
Currently, only the name and description and public access of share-type
is set when the share-type is created, and not allowed to be edited
after the share-type is created. We can only set extra spec for share-type.
But not name or description or public access for share-type.

Co-Authored-By: Brin Zhang <zhangbailin@inspur.com>
APIImpact

Implements: blueprint update-share-type-name-or-description
Change-Id: I4c7bdd601d48b40c01639b5089d4bff259a7b3af
2019-09-10 14:43:07 -07: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
Zuul
3abfbef591 Merge "Retrieve is_default value to fix empty display in CLI" 2018-07-24 19:31:55 +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
d3d7e4c69a Api-ref: change fix `extra-spec-key` key in path
TrivialFix:
In the API Unset an extra spec:
/v2/{tenant_id}/types/{share_type_id}/extra_specs/{extra-spec-key}
the key extra-spec-key should be in path, but it is in body, this
is to fix this.

Change-Id: Ia6f01a6bca369ca4b922a45e8e6ece4f583528c7
2018-07-16 14:10:10 +08:00
Zuul
fdd6f34599 Merge "Support filter search for share type API" 2018-04-21 10:12:28 +00:00
junboli
d80596b508 Support filter search for share type API
Add support for extra_specs filter search in type list API.

Change-Id: I43fbef2a32489f2064586a3674eb34329f3503c4
Implements: blueprint support-filter-search-for-share-type
2018-03-25 18:19:38 +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
junboli
ee11996bf9 Api-ref: add show details for share type
Add missing show details for a specified share type
in api ref.

Change-Id: Iffa5cdcb86d9d9d34950fd7e7365b1608f8716bf
2017-12-31 16:12:06 +08:00
junboli
17ed3e0455 Update docs to fix broken links
We still left lots of broken links in the docs, this change is
to fix them.

Change-Id: I4965489974ffa24e62f04fc1c995d1c7017e1291
2017-12-04 16:58:47 +08:00
zhongjun
470e76d6b3 Add 'description' in share type API Doc
Add attr 'description' in list/create share
type API Doc.

Depends-On: I39705acbfca812b66d74fbd2fee228a7a85bc2d8
Change-Id: I49705acbfca812b66d74fbd2fee228a7a85bc2d7
Partial-Bug: #1724183
2017-11-23 11:13:57 +08:00
junboli
d88ab3cfa2 [Api-ref] update parameters for share types api
1. update share types params
2. correct sample json datas

Closes-bug: #1733753
Change-Id: I804b657cf7b189c25f09864e79a74f76a99252bb
2017-11-22 16:01:09 +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
junboli
dd82e8f28b doc migration: update the doc link address
Update the doc link brought by the doc migration.

Change-Id: I6000856c22dbc47a1349d061927a47405ba0d66c
2017-08-28 16:38:05 +08:00
yfzhao
c408401864 Fix wrong links
Some docs links have changed. We should update the wrong links in our codes.

Closes-Bug #1710106

Change-Id: I2704fbf947564dcfe5871d38080bf6c8fcc43837
2017-08-11 16:44:28 +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
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