openstack/manila
Code Issues Proposed changes

Merge "[doc] Move Experimental APIs description to a common place"

Browse Source
This commit is contained in:
Jenkins 2017-09-18 03:04:15 +00:00 committed by Gerrit Code Review
commit 0e3ad3917d
5 changed files with 27 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/source/consistency-group-snapshots.inc
View File

@ -23,11 +23,9 @@ actions to other roles.
.. note:: .. note::
Consistency group snapshot APIs are part of an ``experimental`` feature Consistency group snapshot APIs are part of the `experimental APIs
introduced in version 2.4. The APIs may change or be removed in further <http://developer.openstack.org/api-ref/shared-file-systems/
versions of the Shared File Systems API. All experimental APIs #experimental-apis>`_.
require the ``X-OpenStack-Manila-API-Experimental: True`` header to be
sent in the requests.
Consistency group snapshot APIs were removed in 2.31 API version. They Consistency group snapshot APIs were removed in 2.31 API version. They
were replaced with 'share groups' APIs. were replaced with 'share groups' APIs.

8
api-ref/source/consistency-groups.inc
View File

@ -18,11 +18,9 @@ other roles.
.. note:: .. note::
Consistency groups APIs are part of an ``experimental`` feature introduced Consistency groups APIs are part of the `experimental APIs
in version 2.4. The APIs may change or be removed in further versions <http://developer.openstack.org/api-ref/shared-file-systems/
of the Shared File Systems API. All experimental APIs require the #experimental-apis>`_.
``X-OpenStack-Manila-API-Experimental: True`` header to be sent in the
requests.
Consistency group APIs were removed in 2.31 API version. They were Consistency group APIs were removed in 2.31 API version. They were
replaced with 'share groups' APIs. replaced with 'share groups' APIs.

14
api-ref/source/experimental.inc Normal file
View File

@ -0,0 +1,14 @@
.. -*- rst -*-
=================
Experimental APIs
=================
.. important::
The following APIs are part of the `experimental feature <https://docs.
openstack.org/manila/latest/contributor/experimental_apis.html>`_ introduced
in version 2.4. The APIs may change or be removed in future versions of the
Shared File Systems API. All experimental APIs require the
``X-OpenStack-Manila-API-Experimental: True`` header to be sent in the
requests.

1
api-ref/source/index.rst
View File

@ -34,6 +34,7 @@ Shared File Systems API (EXPERIMENTAL)
.. rest_expand_all:: .. rest_expand_all::
.. include:: experimental.inc
.. include:: share-migration.inc .. include:: share-migration.inc
.. include:: consistency-groups.inc .. include:: consistency-groups.inc
.. include:: consistency-group-snapshots.inc .. include:: consistency-group-snapshots.inc

15
api-ref/source/share-migration.inc
View File

@ -1,8 +1,8 @@
.. -*- rst -*- .. -*- rst -*-
=============== ================================
Share Migration Share Migration (Since API v2.5)
=============== ================================
As an administrator, you can migrate a share with its data from one As an administrator, you can migrate a share with its data from one
location to another in a manner that is transparent to users and workloads. location to another in a manner that is transparent to users and workloads.
@ -15,12 +15,9 @@ Possible use cases for data migration include:
.. note:: .. note::
Share Migration APIs are part an the ``experimental`` feature Share Migration APIs are part of the `experimental APIs
introduced in version 2.5. The APIs may change or be removed in further <http://developer.openstack.org/api-ref/shared-file-systems/
versions of the Shared File Systems API. The changes are #experimental-apis>`_ .
documented within each API below. All experimental APIs require the
``X-OpenStack-Manila-API-Experimental: True`` header to be
sent in the requests.
Migrate share (versions 2.5 to 2.14) Migrate share (versions 2.5 to 2.14)