Merge pull request #784 from BitGo/DX-447-add-min-max-support

feat: support `@minLength` and `@maxLength`
BitGo · Jun 6, 2024 · 026ebd8 · 026ebd8
2 parents 7b853d9 + 30a6a4c
commit 026ebd8
Show file tree

Hide file tree

Showing 2 changed files with 129 additions and 9 deletions.
diff --git a/packages/openapi-generator/src/openapi.ts b/packages/openapi-generator/src/openapi.ts
@@ -14,15 +14,7 @@ function schemaToOpenAPI(
   const createOpenAPIObject = (
     schema: Schema,
   ): OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | undefined => {
-    const description = schema.comment?.description;
-    const example = getTagName(schema, 'example');
-    const pattern = getTagName(schema, 'pattern');
-
-    const defaultOpenAPIObject = {
-      ...(description ? { description } : {}),
-      ...(example ? { example } : {}),
-      ...(pattern ? { pattern } : {}),
-    };
+    const defaultOpenAPIObject = buildDefaultOpenAPIObject(schema);
 
     switch (schema.type) {
       case 'boolean':
@@ -141,6 +133,23 @@ function schemaToOpenAPI(
     }
   };
 
+  function buildDefaultOpenAPIObject(schema: Schema): OpenAPIV3.SchemaObject {
+    const description = schema.comment?.description;
+    const example = getTagName(schema, 'example');
+    const maxLength = getTagName(schema, 'maxLength');
+    const minLength = getTagName(schema, 'minLength');
+    const pattern = getTagName(schema, 'pattern');
+
+    const defaultOpenAPIObject = {
+      ...(description ? { description } : {}),
+      ...(example ? { example } : {}),
+      ...(maxLength ? { maxLength: Number(maxLength) } : {}),
+      ...(minLength ? { minLength: Number(minLength) } : {}),
+      ...(pattern ? { pattern } : {}),
+    };
+    return defaultOpenAPIObject;
+  }
+
   const titleObject = schema.comment?.tags.find((t) => t.tag === 'title');
 
   let openAPIObject = createOpenAPIObject(schema);

diff --git a/packages/openapi-generator/test/openapi.test.ts b/packages/openapi-generator/test/openapi.test.ts
@@ -2326,3 +2326,114 @@ testCase('route with descriptions for references', ROUTE_WITH_DESCRIPTIONS_FOR_R
     }
   }
 });
+
+const ROUTE_WITH_MIN_AND_MAX_VALUES_FOR_STRINGS = `
+import * as t from 'io-ts';
+import * as h from '@api-ts/io-ts-http';
+
+/**
+ * A simple route with type descriptions for references
+ *
+ * @operationId api.v1.test
+ * @tag Test Routes
+ */
+export const route = h.httpRoute({
+  path: '/foo',
+  method: 'GET',
+  request: h.httpRequest({
+    query: {
+      bar: t.array(t.string),
+    },
+    body: {
+      /** 
+       * This is a foo description. 
+       * @minLength 5
+       * @maxLength 10
+       * @example "BitgoInc"
+      */
+      foo: t.string()
+    },
+  }),
+  response: {
+    200: {
+      test: t.string
+    }
+  },
+});
+`;
+
+testCase('route with min and max values for strings', ROUTE_WITH_MIN_AND_MAX_VALUES_FOR_STRINGS, {
+  openapi: '3.0.3',
+  info: {
+    title: 'Test',
+    version: '1.0.0'
+  },
+  paths: {
+    '/foo': {
+      get: {
+        summary: 'A simple route with type descriptions for references',
+        operationId: 'api.v1.test',
+        tags: [
+          'Test Routes'
+        ],
+        parameters: [
+          {
+            name: 'bar',
+            in: 'query',
+            required: true,
+            schema: {
+              type: 'array',
+              items: {
+                type: 'string'
+              }
+            }
+          }
+        ],
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  foo: {
+                    type: 'string',
+                    description: 'This is a foo description.',
+                    example: 'BitgoInc',
+                    minLength: 5,
+                    maxLength: 10
+                  }
+                },
+                required: [
+                  'foo'
+                ]
+              }
+            }
+          }
+        },
+        responses: {
+          '200': {
+            description: 'OK',
+            content: {
+              'application/json': {
+                schema: {
+                  type: 'object',
+                  properties: {
+                    test: {
+                      type: 'string'
+                    }
+                  },
+                  required: [
+                    'test'
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  components: {
+    schemas: {}
+  }
+});