Notify GraphQL users of deprecated schema
Problem
(Credit: @Andysoiron).
The GraphQL API is subject to breaking schema changes after a deprecation cycle. Users of the GraphQL API currently need to make themselves familiar with deprecation announcements. They also need to be aware of whether a particular deprecation affects them.
If they fail to update their queries in time, their queries and mutations will generally error.
This leads to:
- Outages of 3rd party apps.
- A degraded experience of the API.
- Lower adoption of the API and a poorer ecosystem around GitLab.
Proposal
We would like to proactively alert users of the GraphQL API when they use deprecated schema in queries and mutations.
An API consumer could elect to be notified after n number of uses of a deprecated schema item through:
- Their user account settings.
- By registering an App and sending the App ID in their queries and mutations.
Notification could be according to their regular notification settings (To-do / email).
2. Would account for scenarios where 3rd party app developers should be notified as the ones to take action, rather than the individual users.