Skip to content

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Reference Freshness Checker

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.

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

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 TOOL_ID and evaluateReference for direct use. See schema, rules and limits.

About

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

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages