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:
@@ -1290,7 +1290,7 @@ expected_codes:
|
|||||||
- A single value, such as ``200``
|
- A single value, such as ``200``
|
||||||
- A list, such as ``200, 202``
|
- A list, such as ``200, 202``
|
||||||
- A range, such as ``200-204``
|
- A range, such as ``200-204``
|
||||||
|
|
||||||
The default is 200.
|
The default is 200.
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
|
@@ -10,6 +10,7 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a",
|
"security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -11,7 +11,8 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"direction": "egress",
|
"direction": "egress",
|
||||||
@@ -24,7 +25,8 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"direction": "ingress",
|
"direction": "ingress",
|
||||||
@@ -37,7 +39,8 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"direction": "ingress",
|
"direction": "ingress",
|
||||||
@@ -50,7 +53,8 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
@@ -15,7 +15,8 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"direction": "egress",
|
"direction": "egress",
|
||||||
@@ -28,7 +29,8 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"direction": "ingress",
|
"direction": "ingress",
|
||||||
@@ -41,7 +43,8 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"direction": "ingress",
|
"direction": "ingress",
|
||||||
@@ -54,7 +57,8 @@
|
|||||||
"remote_ip_prefix": null,
|
"remote_ip_prefix": null,
|
||||||
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
|
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
"description": ""
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
"project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
|
||||||
|
@@ -52,6 +52,7 @@ Response Parameters
|
|||||||
- port_range_min: port_range_min
|
- port_range_min: port_range_min
|
||||||
- remote_ip_prefix: remote_ip_prefix
|
- remote_ip_prefix: remote_ip_prefix
|
||||||
- id: security_group_rule-id
|
- id: security_group_rule-id
|
||||||
|
- description: description
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
@@ -81,9 +82,10 @@ Request
|
|||||||
- protocol: protocol
|
- protocol: protocol
|
||||||
- ethertype: ethertype
|
- ethertype: ethertype
|
||||||
- port_range_max: port_range_max
|
- 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
|
- port_range_min: port_range_min
|
||||||
- remote_ip_prefix: remote_ip_prefix
|
- remote_ip_prefix: remote_ip_prefix
|
||||||
|
- description: description-request
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@@ -102,12 +104,13 @@ Response Parameters
|
|||||||
- protocol: protocol
|
- protocol: protocol
|
||||||
- ethertype: ethertype
|
- ethertype: ethertype
|
||||||
- port_range_max: port_range_max
|
- 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
|
- tenant_id: project_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- port_range_min: port_range_min
|
- port_range_min: port_range_min
|
||||||
- remote_ip_prefix: remote_ip_prefix
|
- remote_ip_prefix: remote_ip_prefix
|
||||||
- id: security_group_rule-id
|
- id: security_group_rule-id
|
||||||
|
- description: description
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
@@ -149,12 +152,13 @@ Response Parameters
|
|||||||
- protocol: protocol
|
- protocol: protocol
|
||||||
- ethertype: ethertype
|
- ethertype: ethertype
|
||||||
- port_range_max: port_range_max
|
- 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
|
- tenant_id: project_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- port_range_min: port_range_min
|
- port_range_min: port_range_min
|
||||||
- remote_ip_prefix: remote_ip_prefix
|
- remote_ip_prefix: remote_ip_prefix
|
||||||
- id: security_group_rule-id
|
- id: security_group_rule-id
|
||||||
|
- description: description
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
Reference in New Issue
Block a user