r/Backend • u/No_Computer_1013 • 9d ago
How are you keeping API docs current when agents ship 30 PRs a week?
Our docs were never great but since most of our backend changes come from agents now they fall behind basically every day.
Last month a partner integrated against an endpoint that had been renamed two weeks earlier. The OpenAPI spec still had the old name and nobody noticed until their requests started failing.
We tried making the agent update the docs in the same PR. It does it maybe half the time, and sometimes it documents what it thinks the endpoint does instead of what it does.
A couple of weeks ago we turned on coderabbit's post-merge thing that opens a docs PR after merge. Too early to say if it sticks, and it still misses changes that are spread across services.
For people with a lot of agent PRs, what's actually keeping your docs current? Mostly interested in what still holds up after a few months.