Documenting QoS default policy extension

Closes-Bug: #1733386

Change-Id: I49bce4014a79de3a0d4f8e481a010c0903948532
Signed-off-by: Michal Kelner Mishali <mkelnermishal@vmware.com>

api-ref/source/v2/parameters.yaml

@@ -3353,6 +3353,18 @@ qos_dscp_marking_rule-id:
   in: body
   required: true
   type: string
+qos_is_default:
+  description: |
+    If ``true``, the QoS ``policy`` is the default policy.
+  in: body
+  required: true
+  type: boolean
+qos_is_default-request:
+  description: |
+    If ``true``, the QoS ``policy`` is the default policy.
+  in: body
+  required: false
+  type: boolean
 qos_minimum_bandwidth_rule-id:
   description: |
     The ID of the QoS minimum bandwidth rule.

api-ref/source/v2/qos.inc

@@ -90,6 +90,13 @@ QoS policies (qos)
 
 Lists, creates, deletes, shows information for, and updates QoS policies.
 
+QoS default extension
+=====================
+The QoS default extension (``qos-default``) allows a per project
+default QoS policy by adding the ``is_default`` attribute
+to ``policy`` resources.
+
+
 List QoS policies
 =================
 
@@ -128,6 +135,7 @@ Response Parameters
    - revision_number: revision_number
    - shared: qos-shared
    - id: qos_policy_id
+   - is_default: qos_is_default
    - rules: qos-rules
    - name: name
 
@@ -169,6 +177,7 @@ Request
    - tenant_id: project_id-request
    - project_id: project_id-request
    - shared: qos-shared-request
+   - is_default: qos_is_default-request
    - name: qos_policy-name
 
 Request Example
@@ -190,6 +199,7 @@ Response Parameters
    - shared: qos-shared
    - rules: qos-rules
    - id: qos_policy_id
+   - is_default: qos_is_default
    - name: name
 
 Response Example
@@ -229,6 +239,7 @@ Response Parameters
    - shared: qos-shared
    - rules: qos-rules
    - id: qos_policy_id
+   - is_default: qos_is_default
    - name: name
 
 Response Example
@@ -259,6 +270,7 @@ Request
    - policy_id: qos-policy-id-path
    - policy: policy
    - description: description-request
+   - is_default: qos_is_default-request
    - shared: qos-shared-request
    - name: qos_policy-name
 
@@ -280,6 +292,7 @@ Response Parameters
    - revision_number: revision_number
    - shared: qos-shared
    - id: qos_policy_id
+   - is_default: qos_is_default
    - rules: qos-rules
    - name: name
 

api-ref/source/v2/samples/qos/policies-list-response.json

@@ -4,6 +4,7 @@
             "project_id": "8d4c70a21fed4aeba121a1a429ba0d04",
             "tenant_id": "8d4c70a21fed4aeba121a1a429ba0d04",
             "id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
+            "is_default": false,
             "name": "10Mbit",
             "description": "This policy limits the ports to 10Mbit max.",
             "revision_number": 3,

api-ref/source/v2/samples/qos/policy-create-response.json

@@ -4,6 +4,7 @@
         "description": "This policy limits the ports to 10Mbit max.",
         "rules": [],
         "id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
+        "is_default": false,
         "project_id": "8d4c70a21fed4aeba121a1a429ba0d04",
         "revision_number": 1,
         "tenant_id": "8d4c70a21fed4aeba121a1a429ba0d04",

api-ref/source/v2/samples/qos/policy-show-response.json

@@ -3,6 +3,7 @@
         "project_id": "8d4c70a21fed4aeba121a1a429ba0d04",
         "tenant_id": "8d4c70a21fed4aeba121a1a429ba0d04",
         "id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
+        "is_default": false,
         "name": "10Mbit",
         "description": "This policy limits the ports to 10Mbit max.",
         "revision_number": 3,

api-ref/source/v2/samples/qos/policy-update-response.json

@@ -3,6 +3,7 @@
         "name": "10Mbit",
         "description": "This policy limits the ports to 10Mbit max.",
         "id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
+        "is_default": false,
         "project_id": "8d4c70a21fed4aeba121a1a429ba0d04",
         "revision_number": 3,
         "tenant_id": "8d4c70a21fed4aeba121a1a429ba0d04",