API Deprecation Process

Administrate strives to avoid making changes to our APIs that could impact the function of tools or software built upon the platform. However, as our services evolve, such changes may occasionally be unavoidable.

The Administrate GraphQL API does not use versioning. Instead, it utilizes the native functionality in GraphQL to cover any additions, removals, or changes of functionality. Specifically,

• the declaration of fields to be fetched, allowing additions without affecting clients and

• deprecation flags, to inform developers that functionality is scheduled for removal.

Additionally, we push this information to our users, integrators, and partners via our developer release notes, to ensure advance knowledge of key dates by which action may be required in order to avoid potential issues.

Where an item is to scheduled be removed it will be marked for deprecation in our developer documentation, with a removal date at least 3 calendar months from the point of the release containing the marker, alongside guidance to any alternatives.

The dated deprecation notice is then included in our developer release notes until the date of its removal, at which point there will be a release line item confirming that the removal has been completed and the function is no longer available.

For the entire duration during which an item is marked as deprecated, it will continue to operate in the same manner as before the deprecation.