Skip to content

GraphQL docs warn about immediate breaking changes

Luke Duncalfe requested to merge ld-docs-graphql-breaking-change-warning into master

What does this MR do?

This MR adds to the client-facing GraphQL docs a new WARNING:

While all attempts are made to follow the deprecation and removal process, GitLab may occassionally make immediate breaking changes to the GraphQL API to patch critical security or performance concerns and where the deprecation process would be considered to pose significant risk.

We currently do not have any plans to make immediate breaking changes, but it is important to add this warning now so in a future scenario where GitLab needs to make an immediate breaking change for important security or performance reasons that at least this warning has been documented for some time.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Luke Duncalfe

Merge request reports