Removing overrides for any (#2559)

RobinTail · web-flow · commit e3984ed588f3 · 2025-04-21T11:39:56.000+02:00
Unnecessary complication
diff --git a/example/example.documentation.yaml b/example/example.documentation.yaml
@@ -472,8 +472,7 @@ paths:
                         type: object
                         propertyNames:
                           type: string
-                        additionalProperties:
-                          format: any
+                        additionalProperties: {}
                     required:
                       - name
                       - size
diff --git a/express-zod-api/src/documentation-helpers.ts b/express-zod-api/src/documentation-helpers.ts
@@ -101,8 +101,6 @@ const onDefault: Overrider = ({ zodSchema, jsonSchema }) =>
     globalRegistry.get(zodSchema)?.[metaSymbol]?.defaultLabel ??
     jsonSchema.default);
 
-const onAny: Overrider = ({ jsonSchema }) => (jsonSchema.format = "any");
-
 const onUpload: Overrider = ({ jsonSchema }, ctx) => {
   if (ctx.isResponse)
     throw new DocumentationError("Please use ez.upload() only for input.", ctx);
@@ -280,8 +278,6 @@ const onPipeline: Overrider = ({ zodSchema, jsonSchema }, ctx) => {
           Object.assign(jsonSchema, {
             type: targetType as "number" | "string" | "boolean",
           });
-        } else {
-          onAny({ zodSchema, jsonSchema }, ctx);
         }
       }
     }
@@ -415,7 +411,6 @@ const overrides: Partial<Record<FirstPartyKind | ProprietaryBrand, Overrider>> =
   {
     nullable: onNullable,
     default: onDefault,
-    any: onAny,
     union: onUnion,
     bigint: onBigInt,
     intersection: onIntersection,
diff --git a/express-zod-api/tests/__snapshots__/documentation-helpers.spec.ts.snap b/express-zod-api/tests/__snapshots__/documentation-helpers.spec.ts.snap
@@ -1,10 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`Documentation helpers > depictAny() > should set format:any 1`] = `
-{
-  "format": "any",
-}
-`;
+exports[`Documentation helpers > depictAny() > should set format:any 1`] = `{}`;
 
 exports[`Documentation helpers > depictArray() > should reflect min/max/exact length of the array 0 1`] = `
 {
@@ -677,17 +673,9 @@ exports[`Documentation helpers > depictPipeline > should depict as 'string (prep
 }
 `;
 
-exports[`Documentation helpers > depictPipeline > should handle edge cases 0 1`] = `
-{
-  "format": "any",
-}
-`;
+exports[`Documentation helpers > depictPipeline > should handle edge cases 0 1`] = `{}`;
 
-exports[`Documentation helpers > depictPipeline > should handle edge cases 1 1`] = `
-{
-  "format": "any",
-}
-`;
+exports[`Documentation helpers > depictPipeline > should handle edge cases 1 1`] = `{}`;
 
 exports[`Documentation helpers > depictRaw() > should depict the raw property 1`] = `
 {
@@ -770,9 +758,7 @@ exports[`Documentation helpers > depictRecord() > should set properties+required
 
 exports[`Documentation helpers > depictRecord() > should set properties+required or additionalProperties props 5 1`] = `
 {
-  "additionalProperties": {
-    "format": "any",
-  },
+  "additionalProperties": {},
   "propertyNames": {
     "type": "string",
   },
@@ -1327,9 +1313,7 @@ exports[`Documentation helpers > depictUnion() > should wrap next depicters in o
   "anyOf": [
     {
       "properties": {
-        "data": {
-          "format": "any",
-        },
+        "data": {},
         "status": {
           "const": "success",
         },
diff --git a/express-zod-api/tests/__snapshots__/documentation.spec.ts.snap b/express-zod-api/tests/__snapshots__/documentation.spec.ts.snap
@@ -746,8 +746,7 @@ paths:
                         properties:
                           status:
                             const: success
-                          data:
-                            format: any
+                          data: {}
                         required:
                           - status
                           - data
@@ -2058,8 +2057,7 @@ paths:
           in: query
           required: false
           description: GET /v1/getSomething Parameter
-          schema:
-            format: any
+          schema: {}
       responses:
         "200":
           description: GET /v1/getSomething Positive response
@@ -2073,8 +2071,7 @@ paths:
                   data:
                     type: object
                     properties:
-                      any:
-                        format: any
+                      any: {}
                     required:
                       - any
                 required:

Original file line number	Diff line number	Diff line change
`@@ -101,8 +101,6 @@ const onDefault: Overrider = ({ zodSchema, jsonSchema }) =>`
`101`	`101`	`globalRegistry.get(zodSchema)?.[metaSymbol]?.defaultLabel ??`
`102`	`102`	`jsonSchema.default);`
`103`	`103`
`104`		`-const onAny: Overrider = ({ jsonSchema }) => (jsonSchema.format = "any");`
`105`		`-`
`106`	`104`	`const onUpload: Overrider = ({ jsonSchema }, ctx) => {`
`107`	`105`	`if (ctx.isResponse)`
`108`	`106`	`throw new DocumentationError("Please use ez.upload() only for input.", ctx);`
`@@ -280,8 +278,6 @@ const onPipeline: Overrider = ({ zodSchema, jsonSchema }, ctx) => {`
`280`	`278`	`Object.assign(jsonSchema, {`
`281`	`279`	`type: targetType as "number" \| "string" \| "boolean",`
`282`	`280`	`});`
`283`		`- } else {`
`284`		`- onAny({ zodSchema, jsonSchema }, ctx);`
`285`	`281`	`}`
`286`	`282`	`}`
`287`	`283`	`}`
`@@ -415,7 +411,6 @@ const overrides: Partial<Record<FirstPartyKind \| ProprietaryBrand, Overrider>> =`
`415`	`411`	`{`
`416`	`412`	`nullable: onNullable,`
`417`	`413`	`default: onDefault,`
`418`		`- any: onAny,`
`419`	`414`	`union: onUnion,`
`420`	`415`	`bigint: onBigInt,`
`421`	`416`	`intersection: onIntersection,`