§ Conventions
Versioning
Major versions live in the URL. Backwards-incompatible changes get a new path, not a flag.
Current version
v1 is the current major version. The base URL is https://livesofthesaintscalendar.com/api/v1. There is no date-based or header-based version pinning — if you're hitting /api/v1/, you're on v1.
What is considered breaking
- Removing a field from a successful response.
- Renaming a field, endpoint, or query parameter.
- Changing the type of an existing field.
- Changing the meaning of an error
codestring. - Tightening a rate limit on an active tier without notice.
What is NOT considered breaking
- Adding new endpoints.
- Adding new optional query parameters.
- Adding new fields to existing responses.
- Editorial corrections to data values (a saint's bio, a feast title, etc.).
- Improving error messages — code yourself against
error.code, noterror.message.
Deprecation policy
When v2 ships, v1 will be supported for at least 12 months. Sunset announcements go in the changelog and via email to every account with an active key.