fix: pass default openapi object to any case

Ticket: DX-2582

This commit passes the defaultOpenAPIObject to the any case. This allows for us to not drop the jsdoc information on t.any types.

It is valid openapi to have descriptions and other metadata on any types: https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type

From the following slack thread: https://bitgo.slack.com/archives/C057BHBRG4B/p1765481932730759

\# Test
Tested in `entity-validation`:
```
$ > diff test.json test2.json
3123,3137c3123,3125
<                   "frontPhoto": {
<                     "description": "Front photo of the identity document",
<                     "example": "\"passport-front.jpg\"",
<                     "format": "binary"
<                   },
<                   "backPhoto": {
<                     "description": "Back photo of the identity document",
<                     "example": "\"drivers-license-back.png\"",
<                     "format": "binary"
<                   },
<                   "proofOfResidency": {
<                     "description": "Proof of residency",
<                     "example": "\"rental-lease.pdf\"",
<                     "format": "binary"
<                   }
---
>                   "frontPhoto": {},
>                   "backPhoto": {},
>                   "proofOfResidency": {}
3264,3278c3252,3254
<                   "frontPhoto": {
<                     "description": "Front photo of the identity document",
<                     "example": "\"passport-front.jpg\"",
<                     "format": "binary"
<                   },
<                   "backPhoto": {
<                     "description": "Back photo of the identity document",
<                     "example": "\"drivers-license-back.png\"",
<                     "format": "binary"
<                   },
<                   "proofOfResidency": {
<                     "description": "Proof of residency",
<                     "example": "\"rental-lease.pdf\"",
<                     "format": "binary"
<                   }
---
>                   "frontPhoto": {},
>                   "backPhoto": {},
>                   "proofOfResidency": {}
```

Author: starfy84

packages/openapi-generator/src/openapi.ts

@@ -100,17 +100,14 @@ export function schemaToOpenAPI(
         return {
           type: 'object',
           ...defaultOpenAPIObject,
-          properties: Object.entries(schema.properties).reduce(
-            (acc, [name, prop]) => {
-              const innerSchema = schemaToOpenAPI(prop);
-              if (innerSchema === undefined) {
-                return acc;
-              }
+          properties: Object.entries(schema.properties).reduce((acc, [name, prop]) => {
+            const innerSchema = schemaToOpenAPI(prop);
+            if (innerSchema === undefined) {
+              return acc;
+            }
 
-              return { ...acc, [name]: innerSchema };
-            },
-            {} as Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject>,
-          ),
+            return { ...acc, [name]: innerSchema };
+          }, {} as Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject>),
           ...(schema.required.length > 0 ? { required: schema.required } : {}),
         };
       case 'intersection':
@@ -234,7 +231,7 @@ export function schemaToOpenAPI(
       case 'undefined':
         return undefined;
       case 'any':
-        return {};
+        return { ...defaultOpenAPIObject };
       default:
         return {};
     }
@@ -429,60 +426,48 @@ export function convertRoutesToOpenAPI(
   routes: Route[],
   schemas: Record<string, Schema>,
 ): OpenAPIV3.Document {
-  const paths = routes.reduce(
-    (acc, route) => {
-      const [path, method, pathItem] = routeToOpenAPI(route);
-      let pathObject = acc[path] ?? {};
-      pathObject[method] = pathItem;
-      return { ...acc, [path]: pathObject };
-    },
-    {} as Record<string, Record<string, OpenAPIV3.PathItemObject>>,
-  );
-
-  const openapiSchemas = Object.entries(schemas).reduce(
-    (acc, [name, schema]) => {
-      const openapiSchema = schemaToOpenAPI(schema);
-      if (openapiSchema === undefined) {
-        return acc;
-      } else if ('$ref' in openapiSchema) {
-        return {
-          ...acc,
-          [name]: {
-            allOf: [{ title: name }, openapiSchema],
-          },
-        };
-      } else {
-        return {
-          ...acc,
-          [name]: {
-            title: name,
-            ...openapiSchema,
-          },
-        };
-      }
-    },
-    {} as Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject>,
-  );
+  const paths = routes.reduce((acc, route) => {
+    const [path, method, pathItem] = routeToOpenAPI(route);
+    let pathObject = acc[path] ?? {};
+    pathObject[method] = pathItem;
+    return { ...acc, [path]: pathObject };
+  }, {} as Record<string, Record<string, OpenAPIV3.PathItemObject>>);
+
+  const openapiSchemas = Object.entries(schemas).reduce((acc, [name, schema]) => {
+    const openapiSchema = schemaToOpenAPI(schema);
+    if (openapiSchema === undefined) {
+      return acc;
+    } else if ('$ref' in openapiSchema) {
+      return {
+        ...acc,
+        [name]: {
+          allOf: [{ title: name }, openapiSchema],
+        },
+      };
+    } else {
+      return {
+        ...acc,
+        [name]: {
+          title: name,
+          ...openapiSchema,
+        },
+      };
+    }
+  }, {} as Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject>);
 
   const sortedPaths = Object.keys(paths)
     .sort((a, b) => a.localeCompare(b))
-    .reduce(
-      (acc, key) => {
-        const sortedMethods = Object.keys(paths[key]!)
-          .sort((a, b) => a.localeCompare(b))
-          .reduce(
-            (methodAcc, methodKey) => {
-              methodAcc[methodKey] = paths[key]![methodKey]!;
-              return methodAcc;
-            },
-            {} as Record<string, OpenAPIV3.PathItemObject>,
-          );
-
-        acc[key] = sortedMethods;
-        return acc;
-      },
-      {} as Record<string, OpenAPIV3.PathItemObject>,
-    );
+    .reduce((acc, key) => {
+      const sortedMethods = Object.keys(paths[key]!)
+        .sort((a, b) => a.localeCompare(b))
+        .reduce((methodAcc, methodKey) => {
+          methodAcc[methodKey] = paths[key]![methodKey]!;
+          return methodAcc;
+        }, {} as Record<string, OpenAPIV3.PathItemObject>);
+
+      acc[key] = sortedMethods;
+      return acc;
+    }, {} as Record<string, OpenAPIV3.PathItemObject>);
 
   return {
     openapi: '3.0.3',

packages/openapi-generator/test/openapi/jsdoc.test.ts

@@ -1232,3 +1232,131 @@ testCase(
     },
   },
 );
+
+const ROUTE_WITH_ANY_AND_DESCRIPTION = `
+import * as t from 'io-ts';
+import * as h from '@api-ts/io-ts-http';
+
+/**
+ * A simple route
+ *
+ * @operationId api.v1.test
+ * @tag Test Routes
+ */
+export const route = h.httpRoute({
+  path: '/foo',
+  method: 'GET',
+  request: h.httpRequest({}),
+  response: {
+    200: {
+      /**
+       * Test description
+       */
+      test: t.any
+    }
+  },
+});
+`;
+
+testCase('route with example object', ROUTE_WITH_ANY_AND_DESCRIPTION, {
+  openapi: '3.0.3',
+  info: {
+    title: 'Test',
+    version: '1.0.0',
+  },
+  paths: {
+    '/foo': {
+      get: {
+        summary: 'A simple route',
+        operationId: 'api.v1.test',
+        tags: ['Test Routes'],
+        parameters: [],
+        responses: {
+          200: {
+            description: 'OK',
+            content: {
+              'application/json': {
+                schema: {
+                  type: 'object',
+                  properties: {
+                    test: {
+                      description: 'Test description',
+                    },
+                  },
+                  required: ['test'],
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  components: {
+    schemas: {},
+  },
+});
+
+const ROUTE_WITH_ANY_AND_FORMAT = `
+import * as t from 'io-ts';
+import * as h from '@api-ts/io-ts-http';
+
+/**
+ * A simple route
+ *
+ * @operationId api.v1.test
+ * @tag Test Routes
+ */
+export const route = h.httpRoute({
+  path: '/foo',
+  method: 'GET',
+  request: h.httpRequest({}),
+  response: {
+    200: {
+      /**
+       * @format binary
+       */
+      test: t.any
+    }
+  },
+});
+`;
+
+testCase('route with example object', ROUTE_WITH_ANY_AND_FORMAT, {
+  openapi: '3.0.3',
+  info: {
+    title: 'Test',
+    version: '1.0.0',
+  },
+  paths: {
+    '/foo': {
+      get: {
+        summary: 'A simple route',
+        operationId: 'api.v1.test',
+        tags: ['Test Routes'],
+        parameters: [],
+        responses: {
+          200: {
+            description: 'OK',
+            content: {
+              'application/json': {
+                schema: {
+                  type: 'object',
+                  properties: {
+                    test: {
+                      format: 'binary',
+                    },
+                  },
+                  required: ['test'],
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  components: {
+    schemas: {},
+  },
+});