docs: add supergraph yaml info #2493
Draft
Conversation
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
✅ Docs preview readyThe preview is ready to be viewed. View the preview File Changes 0 new, 1 changed, 0 removedBuild ID: 3671dafe8bc7e6cf1226237a URL: https://www.apollographql.com/docs/deploy-preview/3671dafe8bc7e6cf1226237a |
Meschreiber
commented
Apr 14, 2025
Meschreiber
commented
Apr 14, 2025
| @@ -57,41 +57,9 @@ You can also pass config via stdin: | |||
| cat ./supergraph.yaml | rover supergraph compose --config - | |||
| ``` | |||
|
|
|||
| ### From a Studio variant | |||
There was a problem hiding this comment.
Moved this section down since I feel explaining the supergraph.yaml takes precedence
Meschreiber
commented
Apr 14, 2025
| ### YAML configuration file | ||
|
|
||
| The supergraph configuration file (often referred to as `supergraph.yaml`) includes configuration options for each of your [subgraphs](/federation/building-supergraphs/subgraphs-overview/). The following example file configures a supergraph with two subgraphs (`films` and `people`): | ||
| The supergraph configuration file (often referred to as `supergraph.yaml`) includes configuration options for each of your subgraphs. The following example file configures a supergraph with two subgraphs (`films` and `people`): |
There was a problem hiding this comment.
Better to use hover text (which includes a learn more link) rather than peppering links everywhere.
Meschreiber
commented
Apr 14, 2025
| @@ -136,44 +103,22 @@ subgraphs: | |||
| subgraph: actors | |||
| ``` | |||
|
|
|||
| #### Variable expansion | |||
| #### Subgraph configuration fields | |||
There was a problem hiding this comment.
@gocamille , could you please review this new section to make sure it captures what you were describing?
Meschreiber
commented
Apr 14, 2025
| @@ -219,6 +164,73 @@ In some cases, you might want Rover to skip updating its composition library to | |||
|
|
|||
| In these cases, you can pass the `--skip-update` flag to `rover supergraph compose`. If you provide this flag, your `supergraph.yaml` file must specify a `federation_version` (which is recommended regardless). | |||
|
|
|||
| ### Composition output format | |||
There was a problem hiding this comment.
These sections are untouched, just moved from above. (Disappointed in you GH diffing)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explain options in
supergraph.yaml