From 917d8a41a23860f4e04397340e6d049b6b179af1 Mon Sep 17 00:00:00 2001 From: ghanshyam Date: Wed, 4 Jul 2018 12:31:43 +0300 Subject: [PATCH] Complete the api-ref of security group rule Adding the correct path of examples in security group rules api-ref. Change-Id: I9b7ee5d6da7837901089861d0252f9792a817ce4 --- api-ref/source/os-security-group-rules.inc | 24 +++++++++------------- api-ref/source/parameters.yaml | 8 +++++++- 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/api-ref/source/os-security-group-rules.inc b/api-ref/source/os-security-group-rules.inc index 5b7437c0c145..09b9956c2107 100644 --- a/api-ref/source/os-security-group-rules.inc +++ b/api-ref/source/os-security-group-rules.inc @@ -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 ========================== diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index f129505115c6..10a82679305f 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -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: |