Open source · API & Integration

API Deprecation Scanner

Find deprecated endpoints and consumers before a version is removed.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Read a versioned OpenAPI document and a consumer usage inventory, and link the deprecated operations to the consumers actually calling them — with the announced removal date and the documented replacement.

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-deprecation-scanner.mjs --root examples/clean --now 2026-06-05T00:00:00Z

Read the result

One finding per (deprecated operation, consumer) pair, located at the operation in the document, with the consumer, its call count and its last observation in the evidence, and the migration target in the suggestion. Nothing is aggregated away — the question a deprecation scan has to answer is "who do I have to talk to", and a count does not answer it.

Scope

It cannot conclude that nothing calls an operation. It can conclude that no consumer in the inventory called it during the declared window. A consumer absent from the inventory is unknown, not safe. That is why the coverage block is required, why it is validated as strictly as the usage, and why any shortfall in it is an error that makes the run incomplete rather than a quiet pass.