Merge "Fix the mistake of lbaas api-ref"

2018-09-20 22:11:22 +00:00 · 2018-09-20 22:11:22 +00:00 · 0cea7b9deb
parent 157c507f70 2c98c01e99
commit 0cea7b9deb
15 changed files with 98 additions and 99 deletions
--- a/api-ref/source/v2/lbaas-v2.inc
+++ b/api-ref/source/v2/lbaas-v2.inc
@ -797,20 +797,16 @@ Response Parameters
   - pools: pools-obj
   - admin_state_up: admin_state_up
   - description: description
-   - healthmonitors: healthmonitors-response
-   - healthmonitors_status: healthmonitors_status
+   - listeners: listeners
+   - session_persistence: pool-session_persistence
+   - healthmonitor_id: healthmonitor-id
   - id: pool-id-response
   - lb_algorithm: lb_algorithm
   - members: members
   - name: name
   - project_id: project_id
   - protocol: protocol-response
-   - provider: loadbalancer-provider
-   - status: pool-status
-   - status_description: status_description
-   - subnet_id: pool-subnet_id
   - tenant_id: project_id
-   - vip_id: vip_id

 Response Example
 ----------------
@ -887,10 +883,10 @@ Request
   - description: description-request
   - lb_algorithm: lb_algorithm
   - listener_id: listener-id-response
+   - session_persistence: pool-session_persistence-request
   - name: name
   - project_id: project_id-request
   - protocol: protocol
-   - subnet_id: pool-subnet_id
   - tenant_id: project_id-request

 Request Example
@ -907,20 +903,16 @@ Response Parameters
   - pool: pool
   - admin_state_up: admin_state_up
   - description: description
-   - healthmonitors: healthmonitors-response
-   - healthmonitors_status: healthmonitors_status
+   - healthmonitor_id: healthmonitor-id
   - id: pool-id-response
   - lb_algorithm: lb_algorithm
+   - listeners: listeners
+   - session_persistence: pool-session_persistence
   - members: members
   - name: name
   - project_id: project_id
   - protocol: protocol-response
-   - provider: loadbalancer-provider
-   - status: pool-status
-   - status_description: status_description
-   - subnet_id: pool-subnet_id
   - tenant_id: project_id
-   - vip_id: vip_id

 Response Example
 ----------------
@ -963,20 +955,16 @@ Response Parameters
   - pool: pool
   - admin_state_up: admin_state_up
   - description: description
-   - healthmonitors: healthmonitors-response
-   - healthmonitors_status: healthmonitors_status
+   - healthmonitor_id: healthmonitor-id
   - lb_algorithm: lb_algorithm
+   - listeners: listeners
+   - session_persistence: pool-session_persistence
   - members: members
   - id: pool-id-response
   - name: name
-   - status: pool-status
-   - status_description: status_description
   - project_id: project_id
   - protocol: protocol-response
-   - provider: loadbalancer-provider
-   - subnet_id: pool-subnet_id
   - tenant_id: project_id
-   - vip_id: vip_id

 Response Example
 ----------------
@ -1019,6 +1007,7 @@ Request
   - description: description-request
   - lb_algorithm: lb_algorithm
   - name: name
+   - session_persistence: pool-session_persistence-request

 Request Example
 ---------------
@ -1034,20 +1023,16 @@ Response Parameters
   - pool: pool
   - admin_state_up: admin_state_up
   - description: description
-   - healthmonitors: healthmonitors-response
-   - healthmonitors_status: healthmonitors_status
+   - healthmonitor_id: healthmonitor-id
   - id: pool-id-response
   - lb_algorithm: lb_algorithm
+   - listeners: listeners
+   - session_persistence: pool-session_persistence
   - members: members
   - name: name
-   - status: pool-status
-   - status_description: status_description
   - project_id: project_id
   - protocol: protocol-response
-   - provider: loadbalancer-provider
-   - subnet_id: pool-subnet_id
   - tenant_id: project_id
-   - vip_id: vip_id

 Response Example
 ----------------
@ -1419,6 +1404,7 @@ Response Parameters
   - http_method: http_method
   - id: healthmonitor-id
   - max_retries: max_retries
+   - name: name
   - pools: pools
   - project_id: project_id
   - tenant_id: project_id
@ -1507,6 +1493,7 @@ Request
   - expected_codes: expected_codes
   - http_method: http_method
   - max_retries: max_retries
+   - name: name
   - pool_id: pool_id-request
   - project_id: project_id
   - tenant_id: project_id
@ -1532,6 +1519,7 @@ Response Parameters
   - http_method: http_method
   - id: healthmonitor-id
   - max_retries: max_retries
+   - name: name
   - pools: pools
   - project_id: project_id
   - tenant_id: project_id
@ -1581,6 +1569,7 @@ Response Parameters
   - expected_codes: expected_codes-response
   - http_method: http_method
   - max_retries: max_retries
+   - name: name
   - id: healthmonitor-id
   - pools: pools
   - project_id: project_id
@ -1626,6 +1615,7 @@ Request
   - expected_codes: expected_codes
   - http_method: http_method
   - max_retries: max_retries
+   - name: name
   - timeout: timeout
   - url_path: url_path

@ -1646,6 +1636,7 @@ Response Parameters
   - expected_codes: expected_codes-response
   - http_method: http_method
   - max_retries: max_retries
+   - name: name
   - id: healthmonitor-id
   - pools: pools
   - project_id: project_id
--- a/api-ref/source/v2/parameters.yaml
+++ b/api-ref/source/v2/parameters.yaml
@ -4218,6 +4218,20 @@ pool-id-response:
  in: body
  required: true
  type: string
+pool-session_persistence:
+  description: |
+    A JSON object specifying the session persistence for the pool
+    or ``null`` for no session persistence. Default is ``null``.
+  in: body
+  required: true
+  type: object
+pool-session_persistence-request:
+  description: |
+    A JSON object specifying the session persistence for the pool
+    or ``null`` for no session persistence. Default is ``null``.
+  in: body
+  required: false
+  type: object
 pool-status:
  description: |
    The status of the pool. Indicates whether the
--- a/api-ref/source/v2/samples/lbaas/healthmonitor-create-request.json
+++ b/api-ref/source/v2/samples/lbaas/healthmonitor-create-request.json
@ -2,7 +2,7 @@
    "healthmonitor": {
        "pool_id": "74aa2010-a59f-4d35-a436-60a6da882819",
        "admin_state_up": true,
-        "delay": "1",
+        "delay": 1,
        "expected_codes": "200,201,202",
        "http_method": "GET",
        "max_retries": 5,
--- a/api-ref/source/v2/samples/lbaas/healthmonitor-create-response.json
+++ b/api-ref/source/v2/samples/lbaas/healthmonitor-create-response.json
@ -6,6 +6,7 @@
        "delay": 1,
        "expected_codes": "200,201,202",
        "max_retries": 5,
+        "name": "healthmonitor1",
        "http_method": "GET",
        "timeout": 1,
        "pools": [],
--- a/api-ref/source/v2/samples/lbaas/healthmonitor-show-response.json
+++ b/api-ref/source/v2/samples/lbaas/healthmonitor-show-response.json
@ -6,13 +6,12 @@
        "delay": 1,
        "expected_codes": "200,201,202",
        "max_retries": 5,
+        "name": "healthmonitor1",
        "http_method": "GET",
        "timeout": 1,
        "pools": [
            {
-                "status": "ACTIVE",
-                "status_description": null,
-                "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+                "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
            }
        ],
        "url_path": "/index.html",
--- a/api-ref/source/v2/samples/lbaas/healthmonitor-update-request.json
+++ b/api-ref/source/v2/samples/lbaas/healthmonitor-update-request.json
@ -1,10 +1,11 @@
 {
    "healthmonitor": {
        "admin_state_up": false,
-        "delay": "2",
+        "delay": 2,
        "expected_codes": "200",
        "http_method": "POST",
        "max_retries": 2,
+        "name": "healthmonitor1",
        "timeout": 2,
        "url_path": "/page.html"
    }
--- a/api-ref/source/v2/samples/lbaas/healthmonitor-update-response.json
+++ b/api-ref/source/v2/samples/lbaas/healthmonitor-update-response.json
@ -6,13 +6,12 @@
        "delay": 2,
        "expected_codes": "200",
        "max_retries": 2,
+        "name": "healthmonitor1",
        "http_method": "POST",
        "timeout": 2,
        "pools": [
            {
-                "status": "ACTIVE",
-                "status_description": null,
-                "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+                "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
            }
        ],
        "url_path": "/page.html",
--- a/api-ref/source/v2/samples/lbaas/healthmonitors-list-response.json
+++ b/api-ref/source/v2/samples/lbaas/healthmonitors-list-response.json
@ -7,13 +7,12 @@
            "delay": 1,
            "expected_codes": "200,201,202",
            "max_retries": 5,
+            "name": "healthmonitor1",
            "http_method": "GET",
            "timeout": 1,
            "pools": [
                {
-                    "status": "ACTIVE",
-                    "status_description": null,
-                    "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+                    "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
                }
            ],
            "url_path": "/index.html",
--- a/api-ref/source/v2/samples/lbaas/listener-create-request.json
+++ b/api-ref/source/v2/samples/lbaas/listener-create-request.json
@ -6,7 +6,7 @@
        "loadbalancer_id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c",
        "name": "listener1",
        "protocol": "HTTP",
-        "protocol_port": "80",
+        "protocol_port": 80,
        "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
        "sni_container_refs": [
            "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
--- a/api-ref/source/v2/samples/lbaas/pool-create-request.json
+++ b/api-ref/source/v2/samples/lbaas/pool-create-request.json
@ -3,9 +3,12 @@
        "admin_state_up": true,
        "description": "simple pool",
        "lb_algorithm": "ROUND_ROBIN",
+        "session_persistence": {
+            "cookie_name": "Cookie",
+            "type": "APP_COOKIE"
+        },
        "name": "my-pool",
        "protocol": "HTTP",
-        "subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d",
        "listener_id": "39de4d56-d663-46e5-85a1-5b9d5fa17829"
    }
 }
--- a/api-ref/source/v2/samples/lbaas/pool-create-response.json
+++ b/api-ref/source/v2/samples/lbaas/pool-create-response.json
@ -1,20 +1,23 @@
 {
    "pool": {
-        "status": "PENDING_CREATE",
        "lb_algorithm": "ROUND_ROBIN",
        "protocol": "HTTP",
        "description": "simple pool",
-        "healthmonitors": [],
+        "healthmonitor_id": null,
        "members": [],
-        "status_description": null,
+        "session_persistence": {
+            "cookie_name": "Cookie",
+            "type": "APP_COOKIE"
+        },
+        "listeners": [
+            {
+                "id": "39de4d56-d663-46e5-85a1-5b9d5fa17829"
+            }
+        ],
        "id": "af95e0ce-8a26-4f29-9524-db41e7769c73",
-        "vip_id": null,
        "name": "my-pool",
        "admin_state_up": true,
-        "subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d",
        "project_id": "eabfefa3fd1740a88a47ad98e132d238",
-        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
-        "healthmonitors_status": [],
-        "provider": "haproxy"
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238"
    }
 }
--- a/api-ref/source/v2/samples/lbaas/pool-show-response.json
+++ b/api-ref/source/v2/samples/lbaas/pool-show-response.json
@ -1,30 +1,25 @@
 {
    "pool": {
-        "status": "ACTIVE",
        "lb_algorithm": "ROUND_ROBIN",
        "protocol": "HTTP",
        "description": "",
-        "healthmonitors": [
-            "b7633ade-24dc-4d72-8475-06aa22be5412"
-        ],
+        "healthmonitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
        "members": [
            "cf024846-7516-4e3a-b0fb-6590322c836f"
        ],
-        "status_description": null,
-        "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
-        "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
-        "name": "pool1",
-        "admin_state_up": true,
-        "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
-        "project_id": "eabfefa3fd1740a88a47ad98e132d238",
-        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
-        "healthmonitors_status": [
+        "session_persistence": {
+            "cookie_name": "Cookie1",
+            "type": "APP_COOKIE"
+        },
+        "listeners": [
            {
-                "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
-                "status": "ACTIVE",
-                "status_description": null
+                "id": "023f2e34-7806-443b-bfae-16c324569a3d"
            }
        ],
-        "provider": "haproxy"
+        "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
+        "name": "pool1",
+        "admin_state_up": true,
+        "project_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238"
    }
 }
--- a/api-ref/source/v2/samples/lbaas/pool-update-response.json
+++ b/api-ref/source/v2/samples/lbaas/pool-update-response.json
@ -1,30 +1,25 @@
 {
    "pool": {
-        "status": "PENDING_UPDATE",
        "lb_algorithm": "ROUND_ROBIN",
        "protocol": "HTTP",
        "description": "",
-        "healthmonitors": [
-            "b7633ade-24dc-4d72-8475-06aa22be5412"
-        ],
+        "healthmonitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
        "members": [
            "cf024846-7516-4e3a-b0fb-6590322c836f"
        ],
-        "status_description": null,
-        "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
-        "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
-        "name": "SuperPool",
-        "admin_state_up": true,
-        "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
-        "project_id": "eabfefa3fd1740a88a47ad98e132d238",
-        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
-        "healthmonitors_status": [
+        "session_persistence": {
+            "cookie_name": null,
+            "type": "SOURCE_IP"
+        },
+        "listeners": [
            {
-                "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
-                "status": "ACTIVE",
-                "status_description": null
+                "id": "023f2e34-7806-443b-bfae-16c324569a3d"
            }
        ],
-        "provider": "haproxy"
+        "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
+        "name": "SuperPool",
+        "admin_state_up": true,
+        "project_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238"
    }
 }
--- a/api-ref/source/v2/samples/lbaas/pools-list-response.json
+++ b/api-ref/source/v2/samples/lbaas/pools-list-response.json
@ -1,32 +1,27 @@
 {
    "pools": [
        {
-            "status": "ACTIVE",
            "lb_algorithm": "ROUND_ROBIN",
            "protocol": "HTTP",
            "description": "",
-            "healthmonitors": [
-                "b7633ade-24dc-4d72-8475-06aa22be5412"
+            "healthmonitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
+            "session_persistence": {
+                "cookie_name": null,
+                "type": "SOURCE_IP"
+            },
+            "listeners": [
+                {
+                    "id": "023f2e34-7806-443b-bfae-16c324569a3d"
+                }
            ],
            "members": [
                "cf024846-7516-4e3a-b0fb-6590322c836f"
            ],
-            "status_description": null,
            "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
-            "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
            "name": "pool1",
            "admin_state_up": true,
-            "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
            "project_id": "eabfefa3fd1740a88a47ad98e132d238",
-            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
-            "healthmonitors_status": [
-                {
-                    "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
-                    "status": "ACTIVE",
-                    "status_description": null
-                }
-            ],
-            "provider": "haproxy"
+            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238"
        }
    ]
 }
--- a/api-ref/source/v2/samples/lbaas/pools-list-response2.json
+++ b/api-ref/source/v2/samples/lbaas/pools-list-response2.json
@ -11,6 +11,10 @@
                    "id": "35cb8516-1173-4035-8dae-0dae3453f37f"
                }
            ],
+            "session_persistence": {
+                "cookie_name": null,
+                "type": "SOURCE_IP"
+            },
            "members": [],
            "name": "pool1",
            "protocol": "HTTP",