From fb7ac9b8bf442c60de77139f3ec81266dcdaaf51 Mon Sep 17 00:00:00 2001
From: lijunbo <lijunbo@fiberhome.com>
Date: Tue, 24 Jul 2018 23:05:37 +0800
Subject: [PATCH] Api-ref: Add min_version in the API parameters

TrivialFix:

Change-Id: Idc29bb1744e4760f72be706c03eb6451465d5d59
Closes-bug: #1614955
---
 api-ref/source/parameters.yaml | 48 +++++++++++++++++++---------------
 1 file changed, 27 insertions(+), 21 deletions(-)

diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index ab59060da5..b740dd910d 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -383,10 +383,11 @@ share_server_id_query:
   type: string
 share_type_id_2:
   description: |
-    (Since API v2.6) The UUID of the share type.
+    The UUID of the share type.
   in: query
   required: false
   type: string
+  min_version: 2.6
 share_type_query:
   description: |
     The share type name or UUID. Allows filtering back end pools based
@@ -648,10 +649,11 @@ allow_access:
   type: object
 availability_zone:
   description: |
-    (Since API v2.1) The availability zone.
+    The availability zone.
   in: body
   required: false
   type: string
+  min_version: 2.1
 availability_zone_1:
   description: |
     The availability zone.
@@ -1460,11 +1462,11 @@ group_specs_required:
   type: object
 has_replicas:
   description: |
-    (Since API v2.11) Indicates whether a share has
-    replicas or not.
+    Indicates whether a share has replicas or not.
   in: body
   required: true
   type: boolean
+  min_version: 2.11
 host_1:
   description: |
     The share host name.
@@ -1607,12 +1609,13 @@ is_admin_only:
   type: boolean
 is_public:
   description: |
-    (Since API v2.8) The level of visibility for the
-    share. Set to ``true`` to make share public. Set to ``false`` to
-    make it private. Default value is ``false``.
+    The level of visibility for the share. Set to ``true`` to make
+    share public. Set to ``false`` to make it private. Default value
+    is ``false``.
   in: body
   required: false
   type: boolean
+  min_version: 2.8
 link_1:
   description: |
     The share links
@@ -2249,12 +2252,13 @@ remaining:
   type: integer
 replica_state:
   description: |
-    (Since API v2.11) The share replica state. Has
-    set value only when replication is used. List of possible values:
-    ``active``, ``in_sync``, ``out_of_sync``, and ``error``.
+    The share replica state. Has set value only when replication
+    is used. List of possible values: ``active``, ``in_sync``,
+    ``out_of_sync``, and ``error``.
   in: body
   required: true
   type: string
+  min_version: 2.11
 replication_type:
   description: |
     The share replication type.
@@ -3050,11 +3054,12 @@ share_type:
   type: string
 share_type_1:
   description: |
-    (Since API v2.6) The UUID of the share type.  In
-    minor versions, this parameter is a share type name, as a string.
+    The UUID of the share type.  In minor versions, this parameter is
+    a share type name, as a string.
   in: body
   required: true
   type: string
+  min_version: 2.6
 share_type_2:
   description: |
     The share type name.
@@ -3091,12 +3096,13 @@ share_type_id_body:
   type: string
 share_type_name:
   description: |
-    (Since API v2.6) The share type name.  Minor
-    versions support only the ``share_type`` parameter where the share
-    type name is expected.
+    The share type name.  Minor versions support only the
+    ``share_type`` parameter where the share type name is
+    expected.
   in: body
   required: true
   type: string
+  min_version: 2.6
 share_types:
   description: |
     A list of one or more share type IDs.
@@ -3359,12 +3365,12 @@ snapshot_status_request:
   type: string
 snapshot_support:
   description: |
-    (Since API v2.2) An extra specification that
-    filters back ends by whether they do or do not support share
-    snapshots.
+    An extra specification that filters back ends by whether
+    they do or do not support share snapshots.
   in: body
   required: true
   type: boolean
+  min_version: 2.2
 snapshot_support_1:
   description: |
     An extra specification that filters back ends by
@@ -3521,9 +3527,8 @@ storage_protocol:
   type: string
 task_state:
   description: |
-    (Since API v2.5) For the share migration, the
-    migration task state.  A valid value is ``null``,
-    ``migration_starting``, ``migration_error``,
+    For the share migration, the migration task state.  A valid
+    value is ``null``, ``migration_starting``, ``migration_error``,
     ``migration_success``, ``migration_completing``, or ``migrating``.
     The ``task_state`` is ``null`` unless the share is migrated from
     one back-end to another. For details, see ``os-migrate_share``
@@ -3531,6 +3536,7 @@ task_state:
   in: body
   required: true
   type: string
+  min_version: 2.5
 timestamp:
   description: |
     The date and time stamp when the API request was issued.