Deprecation & versioning

Greyfinch's GraphQL API, unlike many REST APIs, does not typically use versioning due to its evolving nature. As our product develops, our API must also adapt; however, we are committed to handling breaking changes and deprecations with great care, recognizing that developers rely on our API for building applications and integrations.

To manage deprecations, we will use the @deprecated directive to mark elements in the schema and provide clear warnings, detailing the timeline for their phase-out and eventual removal. Although GraphQL is built to evolve without the need for versioning, we acknowledge that significant changes that could impact existing clients may occasionally necessitate a new API version, though we plan to do this only as a last resort.