Adjusting implementation to keep type first and preserving most snapshots.

RobinTail · RobinTail · commit fa8dd6f89c74 · 2025-04-26T18:58:43.000+02:00
diff --git a/example/example.documentation.yaml b/example/example.documentation.yaml
@@ -16,8 +16,8 @@ paths:
           required: true
           description: a numeric string containing the id of the user
           schema:
-            description: a numeric string containing the id of the user
             type: string
+            description: a numeric string containing the id of the user
             format: regex
             pattern: \d+
       responses:
@@ -85,8 +85,8 @@ paths:
           required: true
           description: numeric string
           schema:
-            description: numeric string
             type: string
+            description: numeric string
             format: regex
             pattern: \d+
       responses:
@@ -578,9 +578,9 @@ paths:
           required: false
           description: for testing error response
           schema:
+            type: string
             deprecated: true
             description: for testing error response
-            type: string
       responses:
         "200":
           description: GET /v1/events/stream Positive response
diff --git a/express-zod-api/src/documentation-helpers.ts b/express-zod-api/src/documentation-helpers.ts
@@ -211,18 +211,19 @@ const ensureCompliance = ({
   ...rest
 }: JSONSchema.BaseSchema): SchemaObject | ReferenceObject => {
   if ($ref) return { $ref };
-  return {
+  const valid: SchemaObject = {
     type: Array.isArray(type)
       ? type.filter(isSupportedType)
       : type && isSupportedType(type)
         ? type
         : undefined,
-    allOf: allOf && allOf.map(ensureCompliance),
-    oneOf: oneOf && oneOf.map(ensureCompliance),
-    anyOf: anyOf && anyOf.map(ensureCompliance),
-    not: not && ensureCompliance(not),
     ...rest,
   };
+  if (allOf) valid.allOf = allOf.map(ensureCompliance);
+  if (oneOf) valid.oneOf = oneOf.map(ensureCompliance);
+  if (anyOf) valid.anyOf = anyOf.map(ensureCompliance);
+  if (not) valid.not = ensureCompliance(not);
+  return valid;
 };
 
 export const onDateIn: Overrider = ({ jsonSchema }, ctx) => {
diff --git a/express-zod-api/tests/__snapshots__/documentation.spec.ts.snap b/express-zod-api/tests/__snapshots__/documentation.spec.ts.snap
@@ -610,9 +610,9 @@ paths:
           required: true
           description: GET /v1/getSomething Parameter
           schema:
+            type: array
             minItems: 1
             maxItems: 3
-            type: array
             items:
               type: integer
               exclusiveMaximum: 9007199254740991
@@ -708,6 +708,8 @@ paths:
         content:
           application/json:
             schema:
+              discriminator:
+                propertyName: type
               anyOf:
                 - type: object
                   properties:
@@ -727,8 +729,6 @@ paths:
                   required:
                     - type
                     - b
-              discriminator:
-                propertyName: type
         required: true
       responses:
         "200":
@@ -2405,8 +2405,8 @@ paths:
           required: true
           description: YYYY-MM-DDTHH:mm:ss.sssZ
           schema:
-            description: YYYY-MM-DDTHH:mm:ss.sssZ
             type: string
+            description: YYYY-MM-DDTHH:mm:ss.sssZ
             format: date-time
             pattern: ^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?)?Z?$
             externalDocs:
@@ -2818,8 +2818,8 @@ paths:
           required: true
           description: GET /v1/getSomething Parameter
           schema:
-            minItems: 1
             type: array
+            minItems: 1
             items:
               type: string
       responses:
@@ -3076,8 +3076,8 @@ paths:
           required: true
           description: GET /v1/getSomething Parameter
           schema:
-            deprecated: true
             type: string
+            deprecated: true
       responses:
         "200":
           description: GET /v1/getSomething Positive response
@@ -3282,9 +3282,9 @@ paths:
 components:
   schemas:
     GetHrisEmployeesParameterCursor:
+      type: string
       description: An optional cursor string used for pagination. This can be
         retrieved from the \`next\` property of the previous page response.
-      type: string
     GetHrisEmployeesPositiveResponse:
       type: object
       properties:
@@ -3706,8 +3706,8 @@ paths:
           required: true
           description: here is the test
           schema:
-            description: here is the test
             type: string
+            description: here is the test
       responses:
         "200":
           description: GET /v1/getSomething Positive response
