Merge pull request #789 from BitGo/DX-458-parse-fields

feat(openapi-generator): parse `examples` and `default` in apiSpec as the schema type
BitGo · Jun 7, 2024 · 26fed46 · 26fed46
2 parents 8eb75bf + ad98b73
commit 26fed46
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/packages/openapi-generator/src/openapi.ts b/packages/openapi-generator/src/openapi.ts
@@ -133,6 +133,25 @@ function schemaToOpenAPI(
     }
   };
 
+  /**
+   *  This function will return the field value parsed as the type of the schema. i.e. if the schema is a number, it will return the field as a JS number.
+   *
+   * @param schema A schema object
+   * @param fieldValue The value to parse
+   * @returns the parsed value
+   */
+  const parseField = (schema: Schema, fieldValue: string): any => {
+    if (schema.type === 'number' || schema.type === 'integer') {
+      return Number(fieldValue);
+    } else if (schema.type === 'boolean') {
+      return fieldValue === 'true';
+    } else if (schema.type === 'null') {
+      return null;
+    } else {
+      return fieldValue;
+    }
+  };
+
   function buildDefaultOpenAPIObject(schema: Schema): OpenAPIV3.SchemaObject {
     const defaultValue = getTagName(schema, 'default');
     const example = getTagName(schema, 'example');
@@ -157,10 +176,10 @@ function schemaToOpenAPI(
     const description = schema.comment?.description;
 
     const defaultOpenAPIObject = {
-      ...(defaultValue ? { default: defaultValue } : {}),
+      ...(defaultValue ? { default: parseField(schema, defaultValue) } : {}),
       ...(deprecated ? { deprecated: true } : {}),
       ...(description ? { description } : {}),
-      ...(example ? { example } : {}),
+      ...(example ? { example: parseField(schema, example) } : {}),
       ...(maxLength ? { maxLength: Number(maxLength) } : {}),
       ...(minLength ? { minLength: Number(minLength) } : {}),
       ...(pattern ? { pattern } : {}),

diff --git a/packages/openapi-generator/test/openapi.test.ts b/packages/openapi-generator/test/openapi.test.ts
@@ -2119,7 +2119,7 @@ testCase('route with descriptions, patterns, and examples', ROUTE_WITH_DESCRIPTI
                   foo: {
                     type: 'number',
                     description: 'foo description',
-                    example: '12345',
+                    example: 12345,
                     pattern: '^[1-9][0-9]{4}$'
                   },
                   child: {