Prompt
Do I need to publish docs from Git when the API changes?
Latest observation
Oct 4, 2026
OpenAI APIWeb search: off
Not necessarily—but if your API changes in a way that affects users, you should update and publish the docs.
A practical rule:
- No docs change needed if the API change is internal or invisible to consumers.
- Docs should be updated if you:
- add/remove endpoints
- change request/response fields
- change auth or permissions
- change error codes
- change behavior, defaults, or deprecate something
If you keep docs in Git, it’s best to:
- commit the doc changes alongside the API change
- publish the docs when you release the API change
- version the docs if you support multiple API versions
If you want, I can suggest a simple workflow for keeping API docs synced with Git and releases.