Skip to content

Add "handling errors" section to FE graphql docs

Tom Quirk requested to merge graphql-fe-error-handling-docs into master

What does this MR do?

Adds a section "Handling errors" to the frontend GraphQL guide, which briefly describes the possible errors in GraphQL mutations and how we should handle them (greatly inspired by @alexkalderimis's description in #30780 (closed)).

Why?

Even though we are still in the process of maturing the way we handle errors in GraphQL (#30780 (closed)), we should provide some guidance for the current state of things in the meantime (this point was raised in !23491 (comment 279772596))

Related issues

Author's checklist

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

  • Optional: 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.

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 🤖 GitLab Bot 🤖

Merge request reports

Loading