Merge "Add info about direction in QoS bandwidth limit rule"

api-ref/source/v2/parameters.yaml

@@ -4377,6 +4377,44 @@ psk:
   in: body
   required: true
   type: string
+qos-rule-direction:
+  description: |
+    The direction of the traffic to which the QoS
+    rule is applied, as seen from the point of view
+    of the ``port``.
+    Valid values are ``egress`` and ``ingress``.
+    Default value is ``egress``.
+  in: body
+  required: false
+  type: string
+qos-rule-direction-response:
+  description: |
+    The direction of the traffic to which the QoS
+    rule is applied, as seen from the point of view
+    of the ``port``.
+    Valid values are ``egress`` and ``ingress``.
+    Default value is ``egress``.
+  in: body
+  required: true
+  type: string
+qos-rule-direction-update:
+  description: |
+    The direction of the traffic to which the QoS
+    rule is applied, as seen from the point of view
+    of the ``port``.
+    Valid values are ``egress`` and ``ingress``.
+  in: body
+  required: false
+  type: string
+qos-rule-direction-update-response:
+  description: |
+    The direction of the traffic to which the QoS
+    rule is applied, as seen from the point of view
+    of the ``port``.
+    Valid values are ``egress`` and ``ingress``.
+  in: body
+  required: true
+  type: string
 qos-rule-type:
   description: |
     The type of QoS rule.

api-ref/source/v2/qos.inc

@@ -278,6 +278,7 @@ Response Parameters
    - max_kbps: max_kbps-response
    - id: qos_bandwidth_limit_rule-id
    - max_burst_kbps: max_burst_kbps-response
+   - direction: qos-rule-direction-response
 
 Response Example
 ----------------
@@ -305,6 +306,7 @@ Request
    - bandwidth_limit_rule: bandwidth_limit_rule
    - max_kbps: max_kbps
    - max_burst_kbps: max_burst_kbps
+   - direction: qos-rule-direction
 
 Request Example
 ---------------
@@ -321,6 +323,7 @@ Response Parameters
    - max_kbps: max_kbps-response
    - id: qos_bandwidth_limit_rule-id
    - max_burst_kbps: max_burst_kbps-response
+   - direction: qos-rule-direction-response
 
 Response Example
 ----------------
@@ -356,6 +359,7 @@ Response Parameters
    - max_kbps: max_kbps-response
    - id: qos_bandwidth_limit_rule-id
    - max_burst_kbps: max_burst_kbps-response
+   - direction: qos-rule-direction-response
 
 Response Example
 ----------------
@@ -387,6 +391,7 @@ Request
    - bandwidth_limit_rule: bandwidth_limit_rule
    - max_kbps: max_kbps
    - max_burst_kbps: max_burst_kbps
+   - direction: qos-rule-direction-update
 
 Request Example
 ---------------
@@ -403,6 +408,7 @@ Response Parameters
    - max_kbps: max_kbps-response
    - id: qos_bandwidth_limit_rule-id
    - max_burst_kbps: max_burst_kbps-response
+   - direction: qos-rule-direction-update-response
 
 Response Example
 ----------------

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

@@ -2,6 +2,7 @@
     "bandwidth_limit_rule": {
         "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
         "max_kbps": 10000,
-        "max_burst_kbps": 0
+        "max_burst_kbps": 0,
+        "direction": "egress"
     }
 }

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

@@ -2,6 +2,7 @@
     "bandwidth_limit_rule": {
         "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
         "max_kbps": 10000,
-        "max_burst_kbps": 0
+        "max_burst_kbps": 0,
+        "direction": "egress"
     }
 }

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

@@ -2,6 +2,7 @@
     "bandwidth_limit_rule": {
         "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
         "max_kbps": 10000,
-        "max_burst_kbps": 0
+        "max_burst_kbps": 0,
+        "direction": "egress"
     }
 }

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

@@ -3,7 +3,8 @@
         {
             "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
             "max_kbps": 10000,
-            "max_burst_kbps": 0
+            "max_burst_kbps": 0,
+            "direction": "egress"
         }
     ]
 }