Skip to content

Update customer GraphQL doc of deprecation process

What does this MR do?

This MR updates our customer-facing GraphQL documentation to describe the new deprecation/removal process for the GraphQL API.

With this change, the GraphQL API will no longer allow the removal of items on X.6 releases, instead on major releases only. This brings it into line with the wider GitLab breaking changes process:

Identify if deprecating the feature creates a breaking change. If so, you will need to wait until a XX.0 major release for removal.

We retain the existing process of requiring GraphQL schema to be deprecated for at least 6-months before allowing it to be removed (now, only in a major release).

Related issues

#345970 (closed)

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"type::feature"
  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Luke Duncalfe

Merge request reports