- Clarify the difference between PUT and POST
on the /shares/<ID>/metadata URL
- Add ref for API to retrieve a single metadata
item
- Add more notes regarding API behavior
Partial-Bug: #1760644
Change-Id: Ic976e0436584b86938c96db571022e96b4592d1f
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
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
This will show other versions of the doc, too.
Change-Id: I2f8e4fec3aa48b91d6ab636504ecc90553a4b802
The pools API responses have evolved quite a bit, and
the current state must be reflected in our docs.
Change-Id: I43fb5617911abdab45cce4352dc3377b5b10badf
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
- 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
This patch updates the manila api-ref adding content to the
manage/unmanage of share servers with DHSS=True feature.
Partial-Bug: #1818758
Change-Id: Ia63762df5cfb2c4b47cf59186ceb571b4c79c31b
Clarify the usage of these APIs wrt DHSS=True/False
drivers.
Partial-Bug: #1818758
Partial-Bug: #1760644
Change-Id: I0fb239a44dee5b2c8da1d469ae761e780d14b4b2
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
Users of replicated shares expect to see primary
export locations when viewing information regarding
the share. Because we collate exports of all replicas
within the export locations APIs, it becomes hard for
users to discern which exports belong to the primary
share. For secondary replicas, users would also need
additional information (availability zone, state of the
replication) to work with.
Introduce micro-version 2.47 from which the export locations
API (GET /v2/{tenant_id}/shares/{share_id}/export_locations)
no longer provides export locations of non-active share
replicas. A new API has been introduced to provide export
location details for share replicas, both active and non-active.
(GET /v2/{tenant_id}/share-replicas/{share_replica_id}/export-locations)
The new API provides the replica's state and availability zone
in addition to the export location information.
APIImpact
Implements: bp export-locations-az
Change-Id: I0a1d9dd00b4c13ac01988e30ca2b7d7ce4a747d1
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
Add missing updated parameter in the version api.
besides, change media-types parameter in body and
required.
Change-Id: Ib0123f16a969ecc98f5dccd2a03eab621e02d8c8
Add MANILA_TEMPEST_MIN_API_MICROVERSION and
MANILA_TEMPEST_MAX_API_MICROVERSION to the ci
post_test_hook. These options default to
the values specified in the api_version_request.py
file.
Also add the API Version History to the api-ref.
Change-Id: I21b3a705986216afb0ce73ca1f92571dda757408
Closes-Bug: #1781671
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
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
Document both the share status that allows deletion and
dependencies of the share that prevent share deletion.
Change-Id: I5f076112e66a2d50394639dce50390d8cfb4922b
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
Allows to configure in which organizational unit the share ends up
APIImpact
Change-Id: I70fd4e0ea7898e85dff59a927b3cb086d5e408ac
Needed-By: I77d87c8e6f98054f2f02bc4202c14314ff321964
Partial-Bug: #1696669
Add support for extra_specs filter search in type list API.
Change-Id: I43fbef2a32489f2064586a3674eb34329f3503c4
Implements: blueprint support-filter-search-for-share-type
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
We have implemented quota-classes-show and quota-classes-update
api, but no api-ref is documented. This patch is to add api-ref
in the docs.
Change-Id: I275ee4fe048607a49368c4f985c055ab3a3bbfb6
Closes-bug: #1751683
