Docs: Add argument validation to GraphQL Styleguide
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
-
Follow the Documentation Guidelines and Style Guide. - [-] If applicable, update the permissions table.
- [-] Link docs to and from the higher-level index page, plus other related docs where helpful.
-
Apply the documentation label.
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
-
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. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖