Empty swagger response description is actually fine

luckymarmot · Dec 7, 2017 · d896613 · d896613
1 parent 6642994
commit d896613
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 15 deletions.
diff --git a/src/serializers/swagger/v2.0/Serializer.js b/src/serializers/swagger/v2.0/Serializer.js
@@ -463,18 +463,12 @@ methods.getSchemaFromResponse = (response) => {
  * @returns {SwaggerResponseObject} the corresponding swagger response object.
  */
 methods.convertResponseRecordToResponseObject = (store, { key, value }) => {
-  const response = {}
-
-  if (value.get('description')) {
-    response.description = value.get('description')
-  }
-  else {
-    response.description = 'no description was provided for this response'
+  const response = {
+    description: value.get('description') || '',
+    headers: methods.getHeadersFromResponse(store, value),
+    schema: methods.getSchemaFromResponse(value),
   }
 
-  response.headers = methods.getHeadersFromResponse(store, value)
-  response.schema = methods.getSchemaFromResponse(value)
-
   return {
     key,
     value: response

diff --git a/src/serializers/swagger/v2.0/__tests__/Serializer.spec.js b/src/serializers/swagger/v2.0/__tests__/Serializer.spec.js
@@ -653,7 +653,7 @@ describe('serializers/swagger/v2.0/Serializer.js', () => {
       }
 
       const expectedValue = {
-        description: 'no description was provided for this response',
+        description: '',
         headers: {
           userId: { type: 'string' },
           petId: { type: 'number' }

diff --git a/testing/e2e/internal-swagger2/test-case-1/output.json b/testing/e2e/internal-swagger2/test-case-1/output.json
@@ -67,7 +67,7 @@
         ],
         "responses": {
           "200": {
-            "description": "no description was provided for this response",
+            "description": "",
             "schema": {
               "$ref": "#/definitions/AnotherEntry"
             }
@@ -81,7 +81,7 @@
         ],
         "responses": {
           "200": {
-            "description": "no description was provided for this response",
+            "description": "",
             "schema": {
               "type": "object"
             }
@@ -142,7 +142,7 @@
         ],
         "responses": {
           "200": {
-            "description": "no description was provided for this response",
+            "description": "",
             "schema": {
               "$ref": "#/definitions/SongsLib.Song"
             }
@@ -768,4 +768,4 @@
       "description": "This trait can be used to apply an access token query parameter\nto any resources or HTTP methods.\n"
     }
   ]
-}
+}