From 8f4338506ee84fd9224fc7a04cc78b1a4f9a409e Mon Sep 17 00:00:00 2001
From: Boden R <bodenvmw@gmail.com>
Date: Tue, 31 Jan 2017 14:42:00 -0700
Subject: [PATCH] api-ref: add description to security groups

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

Change-Id: Ica654402a109c8c08a70d0d306e9f05f8e881306
Partial-Bug: #1553653
---
 .../security-group-create-response.json              |  8 +++++---
 .../security-groups-list-response.json               | 12 ++++++++----
 api-ref/source/v2/security-groups.inc                |  6 +++---
 3 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/api-ref/source/v2/samples/security-groups/security-group-create-response.json b/api-ref/source/v2/samples/security-groups/security-group-create-response.json
index 19f3134..1c33ce1 100644
--- a/api-ref/source/v2/samples/security-groups/security-group-create-response.json
+++ b/api-ref/source/v2/samples/security-groups/security-group-create-response.json
@@ -15,7 +15,8 @@
                 "remote_ip_prefix": null,
                 "security_group_id": "2076db17-a522-4506-91de-c6dd8e837028",
                 "project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
-                "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
+                "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
+                "description": ""
             },
             {
                 "direction": "egress",
@@ -27,8 +28,9 @@
                 "remote_group_id": null,
                 "remote_ip_prefix": null,
                 "security_group_id": "2076db17-a522-4506-91de-c6dd8e837028",
-                "project_id": "e4f50856753b4dc6afee5fa6b9b6c550"
-                "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
+                "project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
+                "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
+                "description": ""
             }
         ],
         "project_id": "e4f50856753b4dc6afee5fa6b9b6c550",
diff --git a/api-ref/source/v2/samples/security-groups/security-groups-list-response.json b/api-ref/source/v2/samples/security-groups/security-groups-list-response.json
index 9c112f2..6479fb8 100644
--- a/api-ref/source/v2/samples/security-groups/security-groups-list-response.json
+++ b/api-ref/source/v2/samples/security-groups/security-groups-list-response.json
@@ -16,7 +16,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",
@@ -29,7 +30,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",
@@ -42,7 +44,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",
@@ -55,7 +58,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",
diff --git a/api-ref/source/v2/security-groups.inc b/api-ref/source/v2/security-groups.inc
index 5b7c9ed..960f705 100644
--- a/api-ref/source/v2/security-groups.inc
+++ b/api-ref/source/v2/security-groups.inc
@@ -74,8 +74,8 @@ Request
 
    - security_group: security_group
    - tenant_id: project_id
-   - project_id: project_id 
-   - description: description
+   - project_id: project_id
+   - description: description-request
    - name: name
 
 Request Example
@@ -168,7 +168,7 @@ Request
 
    - security_group_id: security_group-id-path
    - security_group: security_group
-   - description: description
+   - description: description-request
    - name: name
 
 Request Example