Commit Graph

27 Commits

Author SHA1 Message Date
Kiran Pawar 3a2d220f8a Update Share backup APIs and add api ref
- Follow up change to fix suggestions from earlier pull request i.e.
  https://review.opendev.org/c/openstack/manila/+/343980 .
- Add API-ref docs
- Rename column availability_zone to availability_zone_id in
  share_backups table.

Implement: blueprint share-backup
Closes-bug: #2031311
Change-Id: Ice01ab7892b1eb52b3202f2c79957977f73f3aca
2023-08-25 13:15:05 +00:00
Goutham Pacha Ravi f641577d8a Resource Locks: Support for share deletion lock
Add CRUD APIs for resource locks with support
for preventing deletion of shares (applies to
soft-deletions and unmanage operations as well).

Change-Id: I146bc09e4e8a39797e22458ff6860346e11e592e
Implements: bp/allow-locking-shares-against-deletion
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2023-08-18 10:47:25 -07:00
ashrod98 3497062d49 [DOC] Add Snapshot Metadata Documentation
Change-Id: Ic1aafb1b746ea11cfd103bb98d0d6d02a215bf1d
2023-08-11 17:43:55 +00:00
renanv 8931cdc17f [DOC] Add api reference to share network subnet metadata
Add the api reference to the feature merged in Antelope release cycle
2023.1 share network subnet metadata

Change-Id: I8143c2652dc9024e3fed5e1ea60b16c86de0a5f2
Closes-bug: #2008028
2023-04-11 14:58:40 -03:00
haixin b4a0fd9af0 Update micversion to 2.77, support share transfer between project
user can create a transfer for a share. will return transfer id
and auth_key. another user can use transfer_id and auth_key to
accept this share. salt of transfer and auth_key compute crypt_hash
by sha1. then compare with crypt_hash in db.

APIImpact
DocImpact

Partially-Implements: blueprint transfer-share-between-project

Change-Id: I8facf9112a6b09e6b7aed9956c0a87fb5f1fc31f
2023-02-17 16:05:01 +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
Zuul ad4315eb36 Merge "Add api reference for share server migration" 2021-04-07 11:33:44 +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 256c18d6c2 Add api reference for share server migration
Add documentation to the share server migration APIs introduced
during Victoria release.

Partial-bug: #1897903

Change-Id: I13d13c38a3869929bbfdf8083529a597d7982a16
2021-01-06 09:04:23 -03:00
silvacarloss 136a89937c Update share replicas export location API ref
Moves the share replica export location API reference out of the
experimental features documentation.

Change-Id: I16cbad169d0c4f89428f17a317840750966d240f
2020-11-06 09:05:36 -03:00
Zuul 6a05a2d922 Merge "Update api-ref for share groups graduation" 2020-09-22 20:16:34 +00:00
silvacarloss 05d696c48b Update share replicas api-ref
Moves the share replicas API session out of the experimental
features documentation session.

Change-Id: I19031e0c3db3b0f678b3055d21161e7c5bb52ea7
2020-09-21 16:14:24 +00: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
silvacarloss de62a36e3f Add api-ref for share network subnets
This patch updates the API reference to fit into the changes that
were done in order to implement share networks with multiple
subnets.

Change-Id: I667a26cbf9ea93509718b71dadc8fb304fbca855
Partial-Bug: #1843953
2020-08-06 21:58:37 +00:00
zhongjun2 22656d097c Add api ref for access rule metadata feature
Partially-implements: bp metadata-for-access-rule
Change-Id: Icbac8ec427e23f6a781a7d3e682fe4852fa16179
2019-02-14 17:15:31 -08:00
Goutham Pacha Ravi 53918308c8 Separate APIs for share & replica export locations
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
2019-01-07 01:51:16 -08:00
junboli cc4afb9aad Add docs for quota_class_set API
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
2018-02-27 10:10:40 +08:00
zhongjun cd77c128b0 Add API document for share group [3/3]
This patch adds a new API document for share group snapshot.

Partial-Bug: 1724716
Change-Id: I832d264eb220027aad32937dc64a6ca428ee55a4
2017-11-02 16:38:16 +00:00
zhongjun 3da1c7d4fb Add API document for share group [2/3]
This patch adds a new API document for share group

Partial-Bug: 1724716
Change-Id: I852d264eb120027aad32997dc64a6ca128ee55a3
2017-11-02 16:35:11 +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
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
Jenkins 0e3ad3917d Merge "[doc] Move Experimental APIs description to a common place" 2017-09-18 03:04:15 +00:00
zhongjun c60f1fca88 [doc] Add API document for snapshot instances
This patch adds a new API document for snapshot instances.

Change-Id: Ia0cc534e0bfb2ca5e495e575e27e9911c746690b
2017-09-12 05:15:10 +00:00
zhongjun 514c1a05a1 Add API document for share replica
This patch adds a new API document for share replica.

Change-Id: Ia0cc534e0bfb2ca4e485e575e27e9911c746691b
2017-09-07 01:05:08 +00:00
zhongjun eac27c40d9 [doc] Move Experimental APIs description to a common place
Change-Id: I41695632d48f7cbcbe008867671f8196b5543c93
2017-09-04 09:25:14 +00:00
Alex Meade dd630c3929 User Messages
For quite some time, OpenStack services have wanted to be able to send
messages to API end users (by user I do not mean the operator, but the
user that is interacting with the client).

This patch implements basic user messages with the following APIs.
GET /messages
GET /messages/<message_id>
DELETE /messages/<message_id>

Implements the basic /messages resource and tempest tests
The patch is aligned with related cinder patch where possible:
I8a635a07ed6ff93ccb71df8c404c927d1ecef005

DocImpact
APIImpact

Needed-By: I5ffb840a271c518f62ee1accfd8e20a97f45594d
Needed-By: I9ce096eebda3249687268e361b7141dea4032b57
Needed-By: Ic7d25a144905a39c56ababe8bd666b01bc0d0aef

Partially-implements: blueprint user-messages
Co-Authored-By: Jan Provaznik <jprovazn@redhat.com>
Change-Id: Ia0cc524e0bfb2ca5e495e575e17e9911c746690b
2017-07-13 13:05:57 +02: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