Versioning

The Pushrail API is at v1. There is no version prefix on the URL, every path is the v1 path. A future v2 will introduce a /v2/ prefix and v1 will remain available for at least 12 months after v2 GA.

What changes without a version bump

• Adding new optional fields to request bodies.
• Adding new fields to response bodies.
• Adding new endpoints.
• Adding new enum values to fields documented as open-ended.

What requires a version bump

• Removing or renaming fields.
• Changing field types or semantics.
• Tightening validation that was previously accepted.
• Removing endpoints.

Watch the changelog for any deprecations. Deprecations are announced at least 90 days before removal.