Skip to content

docs: add API versioning and compatibility section#124

Merged
anttiviljami merged 1 commit intomainfrom
docs/api-versioning-practices
Apr 30, 2026
Merged

docs: add API versioning and compatibility section#124
anttiviljami merged 1 commit intomainfrom
docs/api-versioning-practices

Conversation

@anttiviljami
Copy link
Copy Markdown
Member

Summary

  • Add API versioning and compatibility documentation to the API First page
  • Document backwards compatibility guarantees (no breaking changes, additive only)
  • Document 12-month deprecation notice period
  • Document minimum 2-year API support commitment
  • Note exceptions for security/regulatory requirements
  • Define what constitutes a breaking change
  • Add section on staying informed via changelog, OpenAPI specs, and release notes

Slack thread: https://epilot.slack.com/archives/C0ADDKKTLVD/p1777544140031679

Test plan

  • Verify docs build successfully
  • Review rendered output at /docs/architecture/api-first

🤖 Generated with Claude Opus 4.5

https://claude.ai/code/session_01HVZbXfysvdk6kjDbJvU7zj

Document epilot's API versioning practices including:
- Backwards compatibility guarantees (additive changes only)
- 12-month deprecation notice period
- Minimum 2-year API support commitment
- Exception handling for security/regulatory requirements
- Definition of breaking changes

https://claude.ai/code/session_01HVZbXfysvdk6kjDbJvU7zj

Co-authored-by: Claude <noreply@anthropic.com>
@anttiviljami anttiviljami merged commit 510e734 into main Apr 30, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant