Skip to content

Docs for using flags with GraphQL field values

Luke Duncalfe requested to merge ld-graphql-docs-feature-flag-field-value into master

What does this MR do?

This MR introduces documentation guidance for using feature flags when a developer wishes to toggle the return value of a field.

This method of toggling has some advantages over the existing feature_flag property:

  • The schema remains stable (no risk of causing queries to fail)
  • It allows a developer to use actor-based gates if they wish

It has some disadvantages:

  • It doesn't automatically append the description with a notice of the feature flag, and relies on a developer to change the description manually.

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