apollographql / apollographql/federation

Suggestion: provide examples in docs for how to push changes to enums across subgraphs (and avoid composition errors)

Open Beginner friendly
#3,418 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
725
Forks
276
Avg merge
1h 47m
Merged PRs (30d)
1

Description

specifically this scenario: https://github.com/apollographql/federation/blame/ba3175ec0fe450bdb3902b4893ff75c4f782d8b3/docs/source/schema-design/federated-schemas/reference/composition-rules.mdx#L442

it's unclear to readers how they would add a new enum without breaking composition. is there something we can link to?

Contributor guide

Open the contributing guide

Research direction

Start with the enum guidance around line 442 of docs/source/schema-design/federated-schemas/reference/composition-rules.mdx and review the linked blame context. Add a clear example or link explaining how to introduce enum values across subgraphs without composition errors; the documentation is done when readers can follow the scenario safely.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.