Contact
Open source · Docs & Knowledge

API Reference Freshness Checker

Find API references whose examples or schemas differ from the shipped contract.

v1.0.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Compare a complete source/OpenAPI operation export with a complete reference export. Removed or changed parameters, missing sections and stale structured examples produce actionable findings. Explicitly illustrative pseudocode is excluded from example comparison. Offline, read-only Node.js 22+ tool with no dependencies.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+.

Run the checked-in example

node bin/api-reference-freshness-checker.mjs --root examples/pass --source source.json --reference reference.json
node bin/api-reference-freshness-checker.mjs --root examples/fail --source source.json --reference reference.json
npm run check

Read the result

The first command exits 0. The second exits 1 with parameter-removed; its source export no longer declares a parameter shown in the reference. Unknown, partial, malformed or over-limit evidence exits 2 as incomplete and never passes. src/index.mjs exports TOOLID and evaluateReference for direct use. See schema, rules and limits.