Skip to content

[GraphQL] Improve documentation regarding mutation errors conventions"

Alex Kalderimis requested to merge ajk-be-imutation-errors-conventions into master

What does this MR do?

This MR updates the documentation for developers regarding mutations and what errors they should return, and how they should be returned. This describes our current philosophy as discussed here and implemented in the frontend here

Related issues

#32084 (closed)

Author's checklist (required)

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. Reviewed by:

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