sync-api-docs

To keep OpenAPI specs in sync with code, you compare server endpoints and SDK interfaces against your documentation. This detects drift by classifying changes as new, changed, unchanged, or removed, and prompts for updates.

API documentation drifts when server endpoints and SDK interfaces evolve through added or changed routes and schemas, but the OpenAPI specs and SDK manuals are not updated. Synchronizing docs detects this drift by comparing code against the documentation.

To detect removed or changed endpoints in OpenAPI documentation, compare your current server endpoint definitions and SDK interfaces against the existing docs. The comparison classifies changes as new, changed, unchanged, or removed and reports a summary.

You can update SDK manuals and OpenAPI specs by running an automated alignment workflow that compares code against docs. After detecting and classifying changes, it prompts for confirmation before applying updates to the documentation.

Yes, the documentation sync tool works with TypeScript SDKs and Rust servers by reading SDK interfaces from TypeScript source files and endpoint definitions from Rust HTTP server crates, comparing them against OpenAPI and SDK manual documentation.