[Azintar]

Summary

Automates the README endpoint table generation using "openapi.yaml" as the single source of truth.

Changes

• Added markers around the generated endpoint table in the README.
• Integrated endpoint table generation into "openapi:gen".
• Added a CI check to detect differences between generated and committed documentation.
• Ensured the generated table stays synchronized with the OpenAPI specification.

Closes #275.

[Miracle656]

This does not parse on its own branch. Merged alone against current main, tsc --noEmit gives 72 errors, and the first few are syntax rather than types:

src/api/rest.ts(140,9):    error TS1128: Declaration or statement expected
src/api/rest.ts(146,14):   error TS1005: ';' expected
src/api/rest.ts(152,5):    error TS1109: Expression expected
src/api/schemas.ts(32,2):  error TS1109: Expression expected

TS1128 and TS1109 mean the file cannot be read as TypeScript at all — a brace or bracket is unbalanced somewhere above line 140. The other 68 errors are almost certainly downstream of that; fix the syntax and most will go.

I would look for a conflict resolution that kept both sides of a block, or an editor save that lost a closing brace. src/api/rest.ts is the most-edited file in this repository right now — nearly every open PR touches it — so it is the easiest place for that to happen and the hardest place to notice.

Separating process health from data health is a genuinely useful distinction and I want it: "the process is up" and "the data is current" answer different questions, and conflating them is how a service looks healthy while serving stale prices. Please get npx tsc --noEmit clean locally and re-request.

[Miracle656]

Merged into main (8c49b5a).

First, a heads-up about this PR's identity. It is titled "feat(status): separate process health from data health", but the branch now contains the README drift guard — scripts/generate-readme.ts --check, a readme:check script, a CI step, and a changeset named readme-endpoint-table-in-openapi-gen. Nothing about /status is in it. I reviewed and merged what is actually on the branch, because what is on the branch is good. If the status work still exists somewhere, it will need a fresh PR — and it is still worth doing. "The process is up" and "the data is current" answer different questions, and conflating them is how a service looks healthy while serving stale prices.

On the content itself

This is the right version of the guard, and it landed on the generator that actually shipped. #475 put scripts/generate-readme.ts on main; your --check goes on top of it cleanly, rather than forking a second generator the way #589 would have. I closed #589 as superseded just before this.

Two things you got right that are easy to get wrong:

CRLF normalisation before comparing. Every other generated-artifact guard in this repo byte-compares, and an identical table with Windows line endings has been reported as drift here before — someone then "fixes" a file that was never wrong. Normalising first is the correct call and worth copying into the other guards.

Chaining openapi:gen into the README generator. That is why the failure message can name one command. Changing what openapi:gen does is a small surprise, but it removes the failure mode where someone regenerates the spec, forgets the README, and CI catches it one step later. Net better, and the README paragraph documents it.

I verified the guard actually bites rather than trusting it: edited a row by hand → exit 1; restored → exit 0.

One fix on merge

The drift test did:

committed.replace('| GET | `/tvl` |', '| GET | `/tvl-renamed` |')

/tvl stopped existing when 97c50bf moved every documented route under /v1, so the replace matched nothing, edited came out identical to committed, and the test failed on its own expect(edited).not.toBe(committed) guard. Pointed at /v1/tvl with a comment explaining why that assertion is there — it is the line that stops this test passing vacuously, and it did its job.

tsc clean, 1,730 tests pass.

https://claude.ai/code/session_01USgemLt4Rnz4SGB1Srf3GB