Add API reference for portgroup's mode and properties

Partial-Bug: #1618754
Change-Id: Icf8386715b49c17e153dd397dbcb30d3cd26824a

api-ref/source/baremetal-api-v1-nodes-portgroups.inc

@@ -89,6 +89,8 @@ Response
     - standalone_ports_supported: standalone_ports_supported
     - internal_info: portgroup_internal_info
     - extra: extra
+    - mode: portgroup_mode
+    - properties: portgroup_properties
     - ports: pg_ports
     - created_at: created_at
     - updated_at: updated_at

api-ref/source/baremetal-api-v1-portgroups.inc

@@ -99,6 +99,8 @@ Response
     - standalone_ports_supported: standalone_ports_supported
     - internal_info: portgroup_internal_info
     - extra: extra
+    - mode: portgroup_mode
+    - properties: portgroup_properties
     - created_at: created_at
     - updated_at: updated_at
     - links: links
@@ -146,6 +148,8 @@ Response
     - standalone_ports_supported: standalone_ports_supported
     - internal_info: portgroup_internal_info
     - extra: extra
+    - mode: portgroup_mode
+    - properties: portgroup_properties
     - created_at: created_at
     - updated_at: updated_at
     - links: links
@@ -188,6 +192,8 @@ Response
     - standalone_ports_supported: standalone_ports_supported
     - internal_info: portgroup_internal_info
     - extra: extra
+    - mode: portgroup_mode
+    - properties: portgroup_properties
     - created_at: created_at
     - updated_at: updated_at
     - links: links
@@ -237,6 +243,8 @@ Response
     - standalone_ports_supported: standalone_ports_supported
     - internal_info: portgroup_internal_info
     - extra: extra
+    - mode: portgroup_mode
+    - properties: portgroup_properties
     - created_at: created_at
     - updated_at: updated_at
     - links: links

api-ref/source/parameters.yaml

@@ -583,6 +583,16 @@ portgroup_internal_info:
   in: body
   required: true
   type: JSON
+portgroup_mode:
+  description: |
+    Mode of the port group. For possible values, refer to
+    https://www.kernel.org/doc/Documentation/networking/bonding.txt. If not
+    specified in a request to create a port group, it will be set to the value
+    of the ``[DEFAULT]default_portgroup_mode`` configuration option. When set,
+    can not be removed from the port group. Added in API microversion 1.26.
+  in: body
+  required: true
+  type: string
 portgroup_name:
   description: |
     Human-readable identifier for the Portgroup resource. May be undefined.
@@ -590,6 +600,13 @@ portgroup_name:
   in: body
   required: false
   type: string
+portgroup_properties:
+  description: |
+    Key/value properties related to the port group's configuration.
+    Added in API microversion 1.26.
+  in: body
+  required: true
+  type: JSON
 portgroup_uuid:
   description: |
     UUID of the Portgroup this resource belongs to. Added in API microversion 1.23.

api-ref/source/samples/node-portgroup-detail-response.json

@@ -15,6 +15,7 @@
           "rel": "bookmark"
         }
       ],
+      "mode": "active-backup",
       "name": "test_portgroup",
       "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
       "ports": [
@@ -27,6 +28,7 @@
           "rel": "bookmark"
         }
       ],
+      "properties": {},
       "standalone_ports_supported": true,
       "updated_at": "2016-11-04T17:46:09+00:00",
       "uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a"

api-ref/source/samples/portgroup-create-response.json

@@ -13,6 +13,7 @@
       "rel": "bookmark"
     }
   ],
+  "mode": "active-backup",
   "name": "test_portgroup",
   "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
   "ports": [
@@ -25,6 +26,7 @@
       "rel": "bookmark"
     }
   ],
+  "properties": {},
   "standalone_ports_supported": true,
   "updated_at": null,
   "uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a"

api-ref/source/samples/portgroup-list-detail-response.json

@@ -15,6 +15,7 @@
           "rel": "bookmark"
         }
       ],
+      "mode": "active-backup",
       "name": "test_portgroup",
       "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
       "ports": [
@@ -27,6 +28,7 @@
           "rel": "bookmark"
         }
       ],
+      "properties": {},
       "standalone_ports_supported": true,
       "updated_at": null,
       "uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a"

api-ref/source/samples/portgroup-update-response.json

@@ -13,6 +13,7 @@
       "rel": "bookmark"
     }
   ],
+  "mode": "active-backup",
   "name": "test_portgroup",
   "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
   "ports": [
@@ -25,6 +26,7 @@
       "rel": "bookmark"
     }
   ],
+  "properties": {},
   "standalone_ports_supported": true,
   "updated_at": "2016-11-04T17:46:09+00:00",
   "uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a"