Skip to content

fix: resolve $ref in docs.json for OpenAPI routes coverage check #3572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
curquiza wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: resolve $ref in docs.json for OpenAPI routes coverage check #3572

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02a7f21
fix: resolve $ref in docs.json so routes coverage check works with na…
curquiza May 5, 2026
d80f94b
Acoid circular ref
curquiza May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 32 additions & 3 deletions scripts/check-openapi-routes-coverage.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*/

import { readFileSync } from "fs";
import { resolve } from "path";
import { resolve, dirname } from "path";

const OPENAPI_PATH = resolve(
process.cwd(),
Expand Down Expand Up @@ -92,9 +92,38 @@ function normalizeRoute(route) {
});
}

// --- Resolve $ref pointers in a JSON object (one level deep, relative to baseDir) ---
function resolveRefs(obj, baseDir, refStack = new Set()) {
if (Array.isArray(obj)) {
return obj.map((item) => resolveRefs(item, baseDir, refStack));
}
if (typeof obj === "object" && obj !== null) {
if (typeof obj["$ref"] === "string") {
const refPath = resolve(baseDir, obj["$ref"]);
if (refStack.has(refPath)) {
throw new Error(
`Circular $ref detected: ${[...refStack].join(" -> ")} -> ${refPath}`
);
}
const refContent = JSON.parse(readFileSync(refPath, "utf8"));
refStack.add(refPath);
const resolved = resolveRefs(refContent, dirname(refPath), refStack);
refStack.delete(refPath);
return resolved;
}
const result = {};
for (const [key, value] of Object.entries(obj)) {
result[key] = resolveRefs(value, baseDir, refStack);
}
return result;
}
return obj;
}
Comment thread
curquiza marked this conversation as resolved.

// --- Main ---
const spec = JSON.parse(readFileSync(OPENAPI_PATH, "utf8"));
const docsJson = JSON.parse(readFileSync(DOCS_JSON_PATH, "utf8"));
const rawDocsJson = JSON.parse(readFileSync(DOCS_JSON_PATH, "utf8"));
const docsJson = resolveRefs(rawDocsJson, dirname(DOCS_JSON_PATH));

const openapiRoutes = getOpenapiRoutes(spec);
const docsJsonRoutes = getDocsJsonRoutes(docsJson);
Expand Down Expand Up @@ -146,7 +175,7 @@ if (extra.length > 0) {
}

if (missing.length === 0 && extra.length === 0) {
console.log("✓ All OpenAPI routes are covered in docs.json and vice versa.");
console.log("✓ All OpenAPI routes are covered in docs.json (and referenced files) and vice versa.");
}

if (missing.length > 0) {
Expand Down
Loading