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

Nobody has claimed this yet.

Assessment

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

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.

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?

Dominant language
TypeScript
Stars
727
Forks
276
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apollographql/federation

All issues in apollographql/federation

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.