Skip to content

Docs: Add argument validation to GraphQL Styleguide

Luke Duncalfe requested to merge ld-graphql-docs-ready into master

What does this MR do?

This MR came out of this discussion !24027 (diffs, comment 289095528).

Sometimes GraphQL mutations and resolvers may accept a number of optional arguments but still want to validate that at least one of the optional arguments were given. This change adds to the GraphQL style guide a new section to do with validating arguments. It mentions that we can use the #ready? method for the situation of needing to validate across multiple arguments.

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