From a40b46100f4e7e5955cde87593b529d4ec22e1ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C5=82awek=20Kap=C5=82o=C5=84ski?= Date: Sat, 24 Jun 2017 20:39:02 +0000 Subject: [PATCH] Update description of possible values in QoS rule types QoS backend drivers are using validators "type:range" and "type:values" to validate if given value is supported. Such possible values should be represented in different way when rule_type details are requested. This commit changes format of values which can be returned as result of such request. Change-Id: I460f7b2b265115120102e575d4040c0c5f5264f8 Partial-Bug: 1686035 --- ...-detailed-reporting-of-available-rules.rst | 38 +++++++++++++++++-- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/specs/pike/qos-detailed-reporting-of-available-rules.rst b/specs/pike/qos-detailed-reporting-of-available-rules.rst index 319894e7a..2b5d8674a 100644 --- a/specs/pike/qos-detailed-reporting-of-available-rules.rst +++ b/specs/pike/qos-detailed-reporting-of-available-rules.rst @@ -41,6 +41,18 @@ Request example:: The response is a dict with details for the supported rule type for each of the enabled backends. + +As parameter values can be returned: + +* list of supported values if driver uses "type:values" validator from + neutron-lib to validate this parameter +* dict with 'start' and 'end' value if driver uses "type:range" validator from + neutron-lib to validate this parameter. Both 'start' and 'end' values are + inclusive in the range. + +QoS rule types uses only "type:values" and "type:range" validators currently and +only those validators are supported by this spec. + This call should be available only for users with admin rights to not expose details about cloud infra to regular users. @@ -55,14 +67,23 @@ Response example:: "supported_parameters": [ { "parameter_name": "max_kbps", - "parameter_values": "*" + "parameter_type": "range", + "parameter_values": { + "start": 0, + "end": 1000 + } }, { "parameter_name": "max_burst_kbps", - "parameter_values": "*" + "parameter_type": "range", + "parameter_values": { + "start": 0, + "end": 1000 + } }, { "parameter_name": "direction", + "parameter_type": "choices", "parameter_values": ["ingress", "egress"] } ] @@ -72,14 +93,23 @@ Response example:: "supported_parameters": [ { "parameter_name": "max_kbps", - "parameter_values": "*" + "parameter_type": "range", + "parameter_values": { + "start": 0, + "end": 1000 + } }, { "parameter_name": "max_burst_kbps", - "parameter_values": "*" + "parameter_type": "range", + "parameter_values": { + "start": 0, + "end": 1000 + } }, { "parameter_name": "direction", + "parameter_type": "choices", "parameter_values": ["egress"] } ]