Docuemntation: definitions deduplication fix.

RobinTail · RobinTail · commit 0066ac0ea490 · 2025-05-25T17:07:45.000+02:00
diff --git a/express-zod-api/src/documentation-helpers.ts b/express-zod-api/src/documentation-helpers.ts
@@ -55,7 +55,7 @@ import wellKnownHeaders from "./well-known-headers.json";
 
 interface ReqResCommons {
   makeRef: (
-    key: object,
+    key: object | string,
     subject: SchemaObject | ReferenceObject,
     name?: string,
   ) => ReferenceObject;
@@ -406,8 +406,12 @@ const fixReferences = (
       if (isReferenceObject(entry) && !entry.$ref.startsWith("#/components")) {
         const actualName = entry.$ref.split("/").pop()!;
         const depiction = defs[actualName];
-        if (depiction)
-          entry.$ref = ctx.makeRef(depiction, ensureCompliance(depiction)).$ref;
+        if (depiction) {
+          entry.$ref = ctx.makeRef(
+            depiction.id || JSON.stringify(depiction), // id is unique, serialization here is safe
+            ensureCompliance(depiction),
+          ).$ref;
+        }
         continue;
       }
       stack.push(...R.values(entry));
diff --git a/express-zod-api/src/documentation.ts b/express-zod-api/src/documentation.ts
@@ -86,10 +86,10 @@ interface DocumentationParams {
 export class Documentation extends OpenApiBuilder {
   readonly #lastSecuritySchemaIds = new Map<SecuritySchemeType, number>();
   readonly #lastOperationIdSuffixes = new Map<string, number>();
-  readonly #references = new Map<object, string>();
+  readonly #references = new Map<object | string, string>();
 
   #makeRef(
-    key: object,
+    key: object | string,
     subject: SchemaObject | ReferenceObject,
     name = this.#references.get(key),
   ): ReferenceObject {
