@necessarylion/adonis-autoswagger 0.0.21 → 0.0.22

package/dist/auto_swagger.js

@@ -379,6 +379,7 @@ class AutoSwagger {
                     in: 'query',
                     name: key,
                     required: required.includes(key),
+                    description: data.description,
                     schema: data,
                 });
             }

package/dist/parsers/validator_parser.js

@@ -109,6 +109,8 @@ class ValidatorParser {
             const field = property["fieldName"];
             if (type === "object") {
                 obj[field] = { type: "object", ...this.#parseSchema(property, refs) };
+                if (meta.description)
+                    obj[field].description = meta.description;
             }
             else {
                 // if array
@@ -123,24 +125,26 @@ class ValidatorParser {
                         };
                     }
                     else {
-                        const meta = this.#getMetaFromValidations(property["each"]["validations"], refs);
+                        const itemMeta = this.#getMetaFromValidations(property["each"]["validations"], refs);
                         const subType = this.#getType(property["each"]["subtype"]);
                         obj[field] = {
                             type: "array",
                             items: {
-                                type: this.#getType(property["each"]["type"]),
-                                ...meta,
+                                type: this.#getType(property["each"]["type"], property["each"]["subtype"]),
+                                ...itemMeta,
                                 format: subType === 'multipartFile' ? 'binary' : undefined,
-                                example: meta.example ??
-                                    meta.minimum ??
+                                example: itemMeta.example ??
+                                    itemMeta.minimum ??
                                     this.exampleGenerator.exampleByType(subType),
                             },
                         };
                     }
+                    if (meta.description)
+                        obj[field].description = meta.description;
                 }
                 else {
                     obj[field] = {
-                        type: this.#getType(type),
+                        type: this.#getType(type, property["subtype"]),
                         example: meta.example ??
                             meta.minimum ??
                             this.exampleGenerator.exampleByType("number"),
@@ -156,15 +160,22 @@ class ValidatorParser {
             result["required"] = required;
         return result;
     }
-    #getType(type) {
+    #getType(type, subtype) {
         if (type == "literal") {
-            return "string";
+            // vine says "literal" for every plain value and keeps the real type in subtype
+            return subtype === "number" || subtype === "boolean" ? subtype : "string";
         }
         return type;
     }
     #getMetaFromValidations(validations, refs) {
         let meta = {};
         for (const validation of validations) {
+            if (refs[validation["ruleFnId"]].options?.description) {
+                meta = {
+                    ...meta,
+                    description: refs[validation["ruleFnId"]].options.description,
+                };
+            }
             if (refs[validation["ruleFnId"]].options?.example) {
                 meta = {
                     ...meta,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@necessarylion/adonis-autoswagger",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "Auto-Generate swagger docs for AdonisJS",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",