Remove pool group from zaqar for api-ref

Co-Authored-By: wanghao<sxmatch1986@gmail.com>
Change-Id: I81c0cc322e89260cb8803de9f3c0afb58ed75532
Implement: blueprint remove-pool-group-from-zaqar

api-ref/source/flavors.inc

@@ -42,9 +42,18 @@ Response Parameters
   - flavors: flavors
   - links: flavor_links
 
+Response Example
+----------------
+NOTE: Suggest config pool_list in stead of pool_group from the
+beginning of Queens.
+
+.. literalinclude:: samples/flavor-list-response-new.json
+   :language: javascript
+
 
 Response Example
 ----------------
+NOTE: Remove pool_group in Rocky release and use pool_list instead for pool
 
 .. literalinclude:: samples/flavor-list-response.json
    :language: javascript
@@ -80,9 +89,20 @@ Request Parameters
 
   - flavor_name: flavor_name_path
   - pool_group: flavor_pool_group
+  - pool_list: flavor_pool_list
 
 Request Example
 ---------------
+NOTE: Suggest config pool_list in stead of pool_group from the
+beginning of Queens.
+
+.. literalinclude:: samples/flavor-create-request-new.json
+   :language: javascript
+
+
+Request Example
+---------------
+NOTE: Remove pool_group in Rocky release and use pool_list instead for pool
 
 .. literalinclude:: samples/flavor-create-request.json
    :language: javascript
@@ -116,10 +136,29 @@ Request Parameters
 
   - flavor_name: flavor_name_path
   - pool_group: flavor_pool_group
+  - pool_list: flavor_pool_list
+
+Request Example
+---------------
+NOTE: Suggest config pool_list in stead of pool_group from the
+beginning of Queens.
+
+.. literalinclude:: samples/flavor-update-request-new.json
+   :language: javascript
+
+
+Response Example
+----------------
+NOTE: Suggest config pool_list in stead of pool_group from the
+beginning of Queens.
+
+.. literalinclude:: samples/flavor-update-response-new.json
+   :language: javascript
 
 
 Request Example
 ---------------
+NOTE: Remove pool_group in Rocky release and use pool_list instead for pool
 
 .. literalinclude:: samples/flavor-update-request.json
    :language: javascript
@@ -127,6 +166,7 @@ Request Example
 
 Response Example
 ----------------
+NOTE: Remove pool_group in Rocky release and use pool_list instead for pool
 
 .. literalinclude:: samples/flavor-update-response.json
    :language: javascript
@@ -164,10 +204,21 @@ Response Parameters
   - name: flavor_name
   - capabilities: capabilities
   - pool_group: flavor_pool_group
+  - pool_list: flavor_pool_list
   - href: flavor_href
 
 Response Example
 ----------------
+NOTE: Suggest config pool_list in stead of pool_group from the
+beginning of Queens.
+
+.. literalinclude:: samples/flavor-show-response-new.json
+   :language: javascript
+
+
+Response Example
+----------------
+NOTE: Remove pool_group in Rocky release and use pool_list instead for pool
 
 .. literalinclude:: samples/flavor-show-response.json
    :language: javascript

api-ref/source/parameters.yaml

@@ -265,6 +265,16 @@ flavor_pool_group:
   description: |
     The ``pool_group`` attribute specifies the name of the pool group
     this flavor sits on top of.
+    NOTE: Remove pool_group in Rocky release and use pool_list instead
+    for flavor.
+
+flavor_pool_list:
+  type: list
+  in: body
+  description: |
+    A list of pools in the flavor.
+    NOTE: Suggest config pool_list in stead of pool_group from the
+    beginning of Queens.
 
 flavors:
   type: list
@@ -305,6 +315,16 @@ operation_status:
     indicate if the actions was successful or not. Ref may contain the
     information if the succeeded is False, otherwise it's null.
 
+pool_flavor:
+  type: string
+  in: body
+  required: false
+  description: |
+    The ``flavor`` attribute specifies a tag to given to more than one pool
+    so that it keeps user remind the purpose/capabilities of all pools that
+    falls under that flavor.
+    NOTE: Suggest config flavor in stead of group from the beginning of queen.
+
 pool_group:
   type: string
   in: body
@@ -313,6 +333,7 @@ pool_group:
     The ``group`` attribute specifies a tag to given to more than one pool
     so that it keeps user remind the purpose/capabilities of all pools that
     falls under that group.
+    NOTE: Remove group in Rocky release and use flavor instead for pool.
 
 pool_href:
   type: string

api-ref/source/pools.inc

@@ -43,9 +43,17 @@ Response Parameters
   - pools: pools
   - links: pool_links
 
+Response Example
+----------------
+NOTE: Suggest config flavor in stead of group from the beginning of Queens.
+
+.. literalinclude:: samples/pool-list-response-new.json
+   :language: javascript
+
 
 Response Example
 ----------------
+NOTE: Remove group in Rocky release and use flavor instead for pool
 
 .. literalinclude:: samples/pool-list-response.json
    :language: javascript
@@ -83,10 +91,20 @@ Request Parameters
   - weight: pool_weight
   - uri: pool_uri
   - group: pool_group
+  - flavor: pool_flavor
   - options: pool_options
 
 Request Example
 ---------------
+NOTE: Suggest config flavor in stead of group from the beginning of Queens.
+
+.. literalinclude:: samples/pool-create-request-new.json
+   :language: javascript
+
+
+Request Example
+---------------
+NOTE: Remove group in Rocky release and use flavor instead for pool
 
 .. literalinclude:: samples/pool-create-request.json
    :language: javascript
@@ -121,11 +139,28 @@ Request Parameters
   - weight: pool_weight
   - uri: pool_uri
   - group: pool_group
+  - flavor: pool_flavor
   - options: pool_options
 
+Request Example
+---------------
+NOTE: Suggest config flavor in stead of group from the beginning of Queens.
+
+.. literalinclude:: samples/pool-update-request-new.json
+   :language: javascript
+
+
+Response Example
+----------------
+NOTE: Suggest config flavor in stead of group from the beginning of Queens.
+
+.. literalinclude:: samples/pool-update-response-new.json
+   :language: javascript
+
 
 Request Example
 ---------------
+NOTE: Remove group in Rocky release and use flavor instead for pool
 
 .. literalinclude:: samples/pool-update-request.json
    :language: javascript
@@ -133,6 +168,7 @@ Request Example
 
 Response Example
 ----------------
+NOTE: Remove group in Rocky release and use flavor instead for pool
 
 .. literalinclude:: samples/pool-update-response.json
    :language: javascript
@@ -169,10 +205,20 @@ Response Parameters
   - weight: pool_weight
   - uri: pool_uri
   - group: pool_group
+  - flavor: pool_flavor
   - href: pool_href
 
 Response Example
 ----------------
+NOTE: Suggest config flavor in stead of group from the beginning of Queens.
+
+.. literalinclude:: samples/pool-show-response-new.json
+   :language: javascript
+
+
+Response Example
+----------------
+NOTE: Remove group in Rocky release and use flavor instead for pool
 
 .. literalinclude:: samples/pool-show-response.json
    :language: javascript

api-ref/source/samples/flavor-create-request-new.json

@@ -0,0 +1,3 @@
+{
+    "pool_list": "[testpool1, testpool2]"
+}

api-ref/source/samples/flavor-list-response-new.json

@@ -0,0 +1,24 @@
+{
+  "flavors": [
+    {
+      "href": "/v2/flavors/test_flavor1",
+      "pool_group": "",
+      "pool_list": "[testpool1, testpool2]",
+      "name": "test_flavor1",
+      "pool": "testgroup"
+    },
+    {
+      "href": "/v2/flavors/test_flavor2",
+      "pool_group": "",
+      "pool_list": "[testpool3, testpool4]",
+      "name": "test_flavor2",
+      "pool": "testgroup"
+    }
+  ],
+  "links": [
+    {
+      "href": "/v2/flavors?marker=test_flavor2",
+      "rel": "next"
+    }
+  ]
+}

api-ref/source/samples/flavor-list-response.json

@@ -3,12 +3,14 @@
     {
       "href": "/v2/flavors/test_flavor1",
       "pool_group": "testgroup",
+      "pool_list": "",
       "name": "test_flavor1",
       "pool": "testgroup"
     },
     {
       "href": "/v2/flavors/test_flavor2",
       "pool_group": "testgroup",
+      "pool_list": "",
       "name": "test_flavor2",
       "pool": "testgroup"
     }

api-ref/source/samples/flavor-show-response-new.json

@@ -0,0 +1,13 @@
+{
+  "href": "/v2/flavors/testflavor",
+  "capabilities": [
+    "FIFO",
+    "CLAIMS",
+    "DURABILITY",
+    "AOD",
+    "HIGH_THROUGHPUT"
+  ],
+  "pool_group": "",
+  "pool_list": "[testpool1, testpool2]"
+  "name": "testflavor"
+}

api-ref/source/samples/flavor-show-response.json

@@ -8,5 +8,6 @@
     "HIGH_THROUGHPUT"
   ],
   "pool_group": "testgroup",
+  "pool_list": ""
   "name": "testflavor"
 }

api-ref/source/samples/flavor-update-request-new.json

@@ -0,0 +1,3 @@
+{
+    "pool_list": "[testpool1, testpool3]"
+}

api-ref/source/samples/flavor-update-response-new.json

@@ -0,0 +1,12 @@
+{
+  "href": "/v2/flavors/testflavor",
+  "pool_list": "[testpool1, testpool3]",
+  "name": "testflavor",
+  "capabilities": [
+    "FIFO",
+    "CLAIMS",
+    "DURABILITY",
+    "AOD",
+    "HIGH_THROUGHPUT"
+  ]
+}

api-ref/source/samples/pool-create-request-new.json

@@ -0,0 +1,8 @@
+{
+    "weight": 100,
+    "uri": "mongodb://127.0.0.1:27017",
+    "options":{
+        "max_retry_sleep": 1
+    },
+    "flavor": "poolflavor"
+}

api-ref/source/samples/pool-list-response-new.json

@@ -0,0 +1,26 @@
+{
+  "pools": [
+    {
+      "href": "/v2/pools/test_pool1",
+      "group": "",
+      "flavor": "poolflavor",
+      "name": "test_pool1",
+      "weight": 60,
+      "uri": "mongodb://192.168.1.10:27017"
+    },
+    {
+      "href": "/v2/pools/test_pool2",
+      "group": "",
+      "flavor": "poolflavor",
+      "name": "test_pool2",
+      "weight": 40,
+      "uri": "mongodb://192.168.1.20:27017"
+    }
+  ],
+  "links": [
+    {
+      "href": "/v2/pools?marker=test_pool2",
+      "rel": "next"
+    }
+  ]
+}

api-ref/source/samples/pool-list-response.json

@@ -3,6 +3,7 @@
     {
       "href": "/v2/pools/test_pool1",
       "group": "poolgroup",
+      "flavor": "",
       "name": "test_pool1",
       "weight": 60,
       "uri": "mongodb://192.168.1.10:27017"
@@ -10,6 +11,7 @@
     {
       "href": "/v2/pools/test_pool2",
       "group": "poolgroup",
+      "flavor": "",
       "name": "test_pool2",
       "weight": 40,
       "uri": "mongodb://192.168.1.20:27017"

api-ref/source/samples/pool-show-response-new.json

@@ -0,0 +1,8 @@
+{
+  "href": "/v2/pools/test_pool",
+  "group": "",
+  "flavor": "testpoolflavor",
+  "name": "test_pool",
+  "weight": 100,
+  "uri": "mongodb://127.0.0.1:27017"
+}

api-ref/source/samples/pool-show-response.json

@@ -1,6 +1,7 @@
 {
   "href": "/v2/pools/test_pool",
   "group": "testpoolgroup",
+  "flavor": "",
   "name": "test_pool",
   "weight": 100,
   "uri": "mongodb://127.0.0.1:27017"

api-ref/source/samples/pool-update-request-new.json

@@ -0,0 +1,8 @@
+{
+    "weight": 60,
+    "uri": "mongodb://127.0.0.1:27017",
+    "options":{
+        "max_retry_sleep": 1
+    },
+    "flavor": "newpoolflavor"
+}

api-ref/source/samples/pool-update-response-new.json

@@ -0,0 +1,8 @@
+{
+  "href": "/v2/pools/test_pool",
+  "group": "",
+  "flavor": "newpoolflavor",
+  "name": "test_pool",
+  "weight": 60,
+  "uri": "mongodb://127.0.0.1:27017"
+}

releasenotes/notes/remove_pool_group_from_zaqar-f8eafeed21779959.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Since we have introduced the 'pool_list' instead of pool_group in Queens,
+    Now we will update the APIs to suggest users use new argument.