openstack
/
neutron-lib
Code Issues Proposed changes

api-ref: add description to security group rules 

Adds the description request/response parameter as
applicable to core resources (see defect).

Change-Id: I36f8a15ef6b01e558255d542b31da837af5646b0
Partial-Bug: #1553653
This commit is contained in:
Boden R 2017-01-31 14:31:14 -07:00
parent cf72bd10e6
commit 51170849fd
5 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1290,7 +1290,7 @@ expected_codes:
- A single value, such as ``200``
- A list, such as ``200, 202``
- A range, such as ``200-204``
The default is 200.
in: body
required: false

3
api-ref/source/v2/samples/security-groups/security-group-rule-create-response.json
View File

@ -10,6 +10,7 @@
"remote_ip_prefix": null,
"security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
}
}

12
api-ref/source/v2/samples/security-groups/security-group-rules-list-response.json
View File

@ -11,7 +11,8 @@
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
},
{
"direction": "egress",
@ -24,7 +25,8 @@
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
},
{
"direction": "ingress",
@ -37,7 +39,8 @@
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
},
{
"direction": "ingress",
@ -50,7 +53,8 @@
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
}
]
}

12
api-ref/source/v2/samples/security-groups/security-group-show-response.json
View File

@ -15,7 +15,8 @@
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
},
{
"direction": "egress",
@ -28,7 +29,8 @@
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
},
{
"direction": "ingress",
@ -41,7 +43,8 @@
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
},
{
"direction": "ingress",
@ -54,7 +57,8 @@
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"description": ""
}
],
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",

12
api-ref/source/v2/security-group-rules.inc
View File

@ -52,6 +52,7 @@ Response Parameters
- port_range_min: port_range_min
- remote_ip_prefix: remote_ip_prefix
- id: security_group_rule-id
- description: description
Response Example
----------------
@ -81,9 +82,10 @@ Request
- protocol: protocol
- ethertype: ethertype
- port_range_max: port_range_max
- security_group_id: security_group_rule-security_group_id
- security_group_id: security_group_rule-security_group_id
- port_range_min: port_range_min
- remote_ip_prefix: remote_ip_prefix
- description: description-request
Request Example
---------------
@ -102,12 +104,13 @@ Response Parameters
- protocol: protocol
- ethertype: ethertype
- port_range_max: port_range_max
- security_group_id: security_group_rule-security_group_id
- security_group_id: security_group_rule-security_group_id
- tenant_id: project_id
- project_id: project_id
- port_range_min: port_range_min
- remote_ip_prefix: remote_ip_prefix
- id: security_group_rule-id
- description: description
Response Example
----------------
@ -149,12 +152,13 @@ Response Parameters
- protocol: protocol
- ethertype: ethertype
- port_range_max: port_range_max
- security_group_id: security_group_rule-security_group_id
- tenant_id: project_id
- security_group_id: security_group_rule-security_group_id
- tenant_id: project_id
- project_id: project_id
- port_range_min: port_range_min
- remote_ip_prefix: remote_ip_prefix
- id: security_group_rule-id
- description: description
Response Example
----------------