Complete the api-ref of security group rule

Adding the correct path of examples in security
group rules api-ref.

Change-Id: I9b7ee5d6da7837901089861d0252f9792a817ce4
This commit is contained in:
ghanshyam 2018-07-04 12:31:43 +03:00 committed by ghanshyam
parent 34956bea4b
commit 917d8a41a2
2 changed files with 17 additions and 15 deletions

View File

@ -1,6 +1,4 @@
.. -*- rst -*-
.. needs:example_verification
.. needs:body_verification
================================================================
Rules for security group (os-security-group-rules) (DEPRECATED)
@ -46,11 +44,10 @@ Request
- cidr: secgroup_rule_cidr
- group_id: group_id
.. TODO(sdague): we currently have no samples here
**Example Create security group rule: JSON request**
**Example Create security group rule: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-group-rules/security-group-rule-create-req.json
:language: javascript
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-rules-post-req.json
:language: javascript
Response
--------
@ -66,18 +63,17 @@ The ``ip_range`` is empty if ``cidr`` was not provided on the request.
- from_port: from_port
- to_port: to_port
- ip_range: secgroup_rule_ip_range
- cidr: secgroup_rule_cidr
- ip_range.cidr: secgroup_rule_cidr
- id: secgroup_rule_id
- group: group
- parent_group_id: parent_group_id
- name: name
- tenant_id: secgroup_tenant_id_body
- group: group
- group.name: name_sec_group_optional
- group.tenant_id: secgroup_tenant_id_body
.. TODO(sdague): we currently have no samples here
**Example Create security group rule: JSON response**
**Example Create security group rule: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-group-rules/security-group-rule-create-resp.json
:language: javascript
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-rules-post-resp.json
:language: javascript
Delete Security Group Rule
==========================

View File

@ -4467,6 +4467,12 @@ name:
in: body
required: true
type: string
name_sec_group_optional:
description: |
The security group name.
in: body
required: false
type: string
name_server_group:
description: |
The name of the server group.
@ -5463,7 +5469,7 @@ secgroup_tenant_id_body:
description: |
The UUID of the tenant that owns this security group.
in: body
required: true
required: false
type: string
security_group:
description: |