GraphQL: document unified revinclude syntax - #41
Merged
Conversation
Document the new module.graphql.revinclude-syntax setting and the unified `_revinclude(path: ...)` field added in HealthSamurai/sansara#8232 (part of GraphQL topics issue HealthSamurai/sansara#8181). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the new unified revinclude GraphQL syntax shipped in HealthSamurai/sansara#8232 (part of the GraphQL topics issue HealthSamurai/sansara#8181).
The
### Revincludessection ofdocs/api/graphql-api.mdpreviously covered only the classicfield-per-pathstyle (<sourceType>_as_<path>). This adds a subsection covering:module.graphql.revinclude-syntax(BOX_MODULE_GRAPHQL_REVINCLUDE_SYNTAX),field-per-path(default) vs.unified_revinclude(path: "<ResourceType>.<element>")field, with a single-target example and a multi-target (aliased) example400error behavior for an invalid resource type / empty pathunifiedmode does not yet accept search args on the included resourcesVerification
All example queries were run against a local Aidbox
edgebuild (commit35612ac03f, which includes #8232) withBOX_MODULE_GRAPHQL_REVINCLUDE_SYNTAX=unifiedand confirmed to return the documented results.Note
The auto-generated settings reference (
all-settings) will pick upmodule.graphql.revinclude-syntaxseparately once thegen-docjob runs — that is currently blocked by an expiredHS_ROBOT_DOCUMENTATIONGitHub token and is out of scope for this hand-written page.🤖 Generated with Claude Code