openstack
/
neutron-lib
Code Issues Proposed changes

Modify API response information in API documents 

The result is different from API document about 'qos-policy-show',
bandwidth and DSCP description in rules list not in policy

Change-Id: I1d857f5061f4fc7a58ed13766016d04ff6d315eb
Closes-Bug: #1643121
This commit is contained in:
QunyingRan 2016-11-22 18:10:02 +08:00
parent a7294a863e
commit 1152f9d4c3
13 changed files with 42 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/v2/parameters.yaml
View File

@ -3658,6 +3658,12 @@ routers:
in: body
required: true
type: array
rules:
description: |
A set of zero or more policy rules.
in: body
required: false
type: array
security_group:
description: |
A ``security_group`` object.

12
api-ref/source/v2/qos.inc
View File

@ -133,18 +133,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- max_kbps: max_kbps
- bandwidth_limit_rules: bandwidth_limit_rules
- description: description
- policy_id: policy_id
- tenant_id: project_id
- project_id: project_id
- dscp_marking_rules: dscp_marking_rules
- policies: policies
- shared: shared
- dscp_mark: dscp_mark
- id: id
- max_burst_kbps: max_burst_kbps
- rules: rules
- name: name
Response Example
@ -393,18 +389,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- max_kbps: max_kbps
- bandwidth_limit_rules: bandwidth_limit_rules
- description: description
- policy_id: policy_id
- tenant_id: project_id
- project_id: project_id
- dscp_marking_rules: dscp_marking_rules
- policy: policy
- shared: shared
- dscp_mark: dscp_mark
- rules: rules
- id: id
- max_burst_kbps: max_burst_kbps
- name: name
Response Example

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

@ -1,8 +1,7 @@
{
"bandwidth_limit_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"max_kbps": "10000",
"max_burst_kbps": "0"
"max_kbps": 10000,
"max_burst_kbps": 0
}
}

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

@ -1,8 +1,7 @@
{
"bandwidth_limit_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"max_kbps": "10000",
"max_burst_kbps": "0"
"max_kbps": 10000,
"max_burst_kbps": 0
}
}

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

@ -1,8 +1,7 @@
{
"bandwidth_limit_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"max_kbps": "10000",
"max_burst_kbps": "0"
"max_kbps": 10000,
"max_burst_kbps": 0
}
}

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

@ -2,9 +2,8 @@
"bandwidth_limit_rules": [
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"max_kbps": "10000",
"max_burst_kbps": "0"
"max_kbps": 10000,
"max_burst_kbps": 0
}
]
}

3
api-ref/source/v2/samples/qos/dscp_marking_rule-create-response.json
View File

@ -1,7 +1,6 @@
{
"dscp_marking_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
"dscp_mark": 26
}
}

3
api-ref/source/v2/samples/qos/dscp_marking_rule-show-response.json
View File

@ -1,7 +1,6 @@
{
"dscp_marking_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
"dscp_mark": 26
}
}

3
api-ref/source/v2/samples/qos/dscp_marking_rule-update-response.json
View File

@ -1,7 +1,6 @@
{
"dscp_marking_rule": {
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "16"
"dscp_mark": 16
}
}

3
api-ref/source/v2/samples/qos/dscp_marking_rules-list-response.json
View File

@ -2,8 +2,7 @@
"dscp_marking_rules": [
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
"dscp_mark": 26
}
]
}

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

@ -7,20 +7,20 @@
"name": "10Mbit",
"description": "This policy limits the ports to 10Mbit max.",
"shared": false,
"bandwidth_limit_rules": [
"rules": [
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"max_kbps": "10000",
"max_burst_kbps": "0"
}
],
"dscp_marking_rules": [
"max_kbps": 10000,
"type": "bandwidth_limit",
"id": "b1866696-032a-4228-857f-846075f63487",
"max_burst_kbps": 0,
"qos_policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4"
},
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
}
"dscp_mark": 20,
"type": "dscp_marking",
"id": "d9c021d5-5433-4d7c-8bfa-69cca486aac8",
"qos_policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4"
},
]
}
]

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

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

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

@ -6,19 +6,19 @@
"name": "10Mbit",
"description": "This policy limits the ports to 10Mbit max.",
"shared": false,
"bandwidth_limit_rules": [
"rules": [
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"max_kbps": "10000",
"max_burst_kbps": "0"
}
],
"dscp_marking_rules": [
"qos_policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"max_kbps": 10000,
"max_burst_kbps": 0,
"type": "bandwidth_limit"
},
{
"id": "5f126d84-551a-4dcf-bb01-0e9c0df0c794",
"policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": "26"
"qos_policy_id": "46ebaec0-0570-43ac-82f6-60d2b03168c4",
"dscp_mark": 26,
"type": "dscp_marking"
}
]
}