api-ref: Fix parameters in server-security-groups

Change-Id: Ie8dc3252603ce77910e1addb67cdc8844369dfca Implements: blueprint api-ref-in-rst-pike Closes-Bug: #1699732
Centrinix · Jul 10, 2017 · 3f96ec6 · 3f96ec6
1 parent dcea3ff
commit 3f96ec6
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/api-ref/source/os-security-groups.inc b/api-ref/source/os-security-groups.inc
@@ -43,7 +43,7 @@ Response
 
   - security_groups: security_groups
   - description: description
-  - id: id
+  - id: security_group_id_body
   - name: name
   - rules: rules
   - tenant_id: tenant_id_body
@@ -86,7 +86,7 @@ Response
 
   - security_group: security_group
   - description: description
-  - id: id
+  - id: security_group_id_body
   - name: name
   - rules: rules
   - tenant_id: tenant_id_body
@@ -122,7 +122,7 @@ Response
 
   - security_group: security_group
   - description: description
-  - id: id
+  - id: security_group_id_body
   - name: name
   - rules: rules
   - tenant_id: tenant_id_body
@@ -165,7 +165,7 @@ Response
 
   - security_group: security_group
   - description: description
-  - id: id
+  - id: security_group_id_body
   - name: name
   - rules: rules
   - tenant_id: tenant_id_body

diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
@@ -2927,12 +2927,6 @@ hypervisors:
   in: body
   required: true
   type: array
-id:
-  description: |
-    The security group name or UUID.
-  in: body
-  required: true
-  type: string
 image:
   description: |
     The UUID and links for the image for your server instance. The ``image`` object
@@ -4565,7 +4559,7 @@ revertResize:
   type: none
 rules:
   description: |
-    A security group rules object.
+    The list of security group rules.
   in: body
   required: true
   type: array
@@ -4629,6 +4623,12 @@ security_group_default_rules:
   in: body
   required: true
   type: array
+security_group_id_body:
+  description: |
+    The ID of the security group.
+  in: body
+  required: true
+  type: string
 security_group_rule:
   description: |
     A ``security_group_rule`` object.
@@ -4676,7 +4676,7 @@ security_groups:
   type: array
 security_groups_obj:
   description: |
-    Security groups object.
+    One or more security groups objects.
   in: body
   required: true
   type: array

diff --git a/api-ref/source/server-security-groups.inc b/api-ref/source/server-security-groups.inc
@@ -29,9 +29,9 @@ Response
 
 .. rest_parameters:: parameters.yaml
 
-  - security_groups: security_groups
+  - security_groups: security_groups_obj
   - description: description
-  - id: id
+  - id: security_group_id_body
   - name: name
   - rules: rules
   - tenant_id: tenant_id_body