From eac27c40d9d47b18aef83c94dc31c8da354b592e Mon Sep 17 00:00:00 2001 From: zhongjun Date: Thu, 17 Aug 2017 16:36:19 +0800 Subject: [PATCH] [doc] Move Experimental APIs description to a common place Change-Id: I41695632d48f7cbcbe008867671f8196b5543c93 --- api-ref/source/consistency-group-snapshots.inc | 8 +++----- api-ref/source/consistency-groups.inc | 8 +++----- api-ref/source/experimental.inc | 14 ++++++++++++++ api-ref/source/index.rst | 1 + api-ref/source/share-migration.inc | 15 ++++++--------- 5 files changed, 27 insertions(+), 19 deletions(-) create mode 100644 api-ref/source/experimental.inc diff --git a/api-ref/source/consistency-group-snapshots.inc b/api-ref/source/consistency-group-snapshots.inc index 9ff33e617f..7183ef7f3a 100644 --- a/api-ref/source/consistency-group-snapshots.inc +++ b/api-ref/source/consistency-group-snapshots.inc @@ -23,11 +23,9 @@ actions to other roles. .. note:: - Consistency group snapshot APIs are part of an ``experimental`` feature - introduced in version 2.4. The APIs may change or be removed in further - 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. + Consistency group snapshot APIs are part of the `experimental APIs + `_. Consistency group snapshot APIs were removed in 2.31 API version. They were replaced with 'share groups' APIs. diff --git a/api-ref/source/consistency-groups.inc b/api-ref/source/consistency-groups.inc index 6678bed76b..99d4d3a515 100644 --- a/api-ref/source/consistency-groups.inc +++ b/api-ref/source/consistency-groups.inc @@ -18,11 +18,9 @@ other roles. .. note:: - Consistency groups APIs are part of an ``experimental`` feature introduced - in version 2.4. The APIs may change or be removed in further 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. + Consistency groups APIs are part of the `experimental APIs + `_. Consistency group APIs were removed in 2.31 API version. They were replaced with 'share groups' APIs. diff --git a/api-ref/source/experimental.inc b/api-ref/source/experimental.inc new file mode 100644 index 0000000000..13d06d5726 --- /dev/null +++ b/api-ref/source/experimental.inc @@ -0,0 +1,14 @@ +.. -*- rst -*- + +================= +Experimental APIs +================= + +.. important:: + + The following APIs are part of the `experimental feature `_ 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. diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 290173eaa2..93a70dc245 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -33,6 +33,7 @@ Shared File Systems API (EXPERIMENTAL) .. rest_expand_all:: +.. include:: experimental.inc .. include:: share-migration.inc .. include:: consistency-groups.inc .. include:: consistency-group-snapshots.inc diff --git a/api-ref/source/share-migration.inc b/api-ref/source/share-migration.inc index f4ba525591..5692ba03e7 100644 --- a/api-ref/source/share-migration.inc +++ b/api-ref/source/share-migration.inc @@ -1,8 +1,8 @@ .. -*- rst -*- -=============== -Share Migration -=============== +================================ +Share Migration (Since API v2.5) +================================ 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. @@ -15,12 +15,9 @@ Possible use cases for data migration include: .. note:: - Share Migration APIs are part an the ``experimental`` feature - introduced in version 2.5. The APIs may change or be removed in further - versions of the Shared File Systems API. The changes are - documented within each API below. All experimental APIs require the - ``X-OpenStack-Manila-API-Experimental: True`` header to be - sent in the requests. + Share Migration APIs are part of the `experimental APIs + `_ . Migrate share (versions 2.5 to 2.14)