fix: missing description

plantain-00 · Jan 29, 2022 · 6113ddd · 6113ddd
1 parent 6274df7
commit 6113ddd
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/demo/cases.swagger.json b/demo/cases.swagger.json
@@ -56,7 +56,8 @@
               "minimum": 1,
               "default": 2,
               "description": "pet id"
-            }
+            },
+            "description": "pet id"
           },
           {
             "name": "sortType",

diff --git a/src/parser.ts b/src/parser.ts
@@ -1608,13 +1608,13 @@ export class Parser {
         }
       } else if (jsDoc.name === 'default') {
         type.default = JSON.parse(this.getJsDocComment(jsDoc.comment))
+      } else if (jsDoc.name === 'title') {
+        type.title = jsDoc.comment
+      } else if (jsDoc.name === 'description') {
+        type.description = jsDoc.comment
       }
     } else if (jsDoc.name === 'uniqueItems') {
       type.uniqueItems = true
-    } else if (jsDoc.name === 'title') {
-      type.title = jsDoc.comment
-    } else if (jsDoc.name === 'description') {
-      type.description = jsDoc.comment
     }
   }
 

diff --git a/src/swagger-doc-generator.ts b/src/swagger-doc-generator.ts
@@ -26,6 +26,7 @@ export function generateSwaggerDoc(context: Context, swaggerBase?: Record<string
             in: useFormData ? 'formData' : parameter.in,
             schema: useFormData ? undefined : schema,
             type: useFormData ? schema.type : undefined,
+            description: useFormData ? undefined : parameter.type.description,
           }
         }),
         summary: typeDeclaration.summary,