-
Notifications
You must be signed in to change notification settings - Fork 269
[do not merge] PR for docs CICD test #3271
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 11 commits
57c7fba
dbcaf55
a9805c5
764347c
07ea148
336690f
e0f7fdd
3439649
d310c15
c30acc6
db0e71c
7dae9a5
e615d50
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -7,98 +7,98 @@ redirectFrom: | |||||||||||||
| - /federation/federated-schemas/composition | ||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| In Apollo Federation, _composition_ is the process of combining a set of subgraph schemas into a supergraph schema: | ||||||||||||||
| In Apollo Federation, is the process of combining a set of subgraph schemas into a supergraph schema: | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The sentence is grammatically incomplete and unclear. It should state what 'is the process' refers to. Rephrased to clarify and improve readability.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The sentence is grammatically incorrect and missing a subject. Rephrased for clarity and proper sentence structure.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ```mermaid | ||||||||||||||
| graph TB; | ||||||||||||||
| serviceA[Subgraph<br/>schema<br/>A]; | ||||||||||||||
| serviceB[Subgraph<br/>schema<br/>B]; | ||||||||||||||
| serviceC[Subgraph<br/>schema<br/>C]; | ||||||||||||||
| composition[["🛠<br/>Composition "]]; | ||||||||||||||
| supergraph{{"Supergraph schema<br/>(A + B + C + routing machinery)"}}; | ||||||||||||||
| serviceA & serviceB & serviceC --> composition; | ||||||||||||||
| composition -- "(Composition succeeds)" --> supergraph; | ||||||||||||||
| class composition tertiary; | ||||||||||||||
| ``` | ||||||||||||||
| ```mermaid | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| graph TB; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| serviceA[Subgraph<br/>schema<br/>A]; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| serviceB[Subgraph<br/>schema<br/>B]; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| serviceC[Subgraph<br/>schema<br/>C]; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| composition[["🛠<br/>Composition "]]; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| supergraph{{"Supergraph schema<br/>(A + B + C + routing machinery)"}}; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| serviceA & serviceB & serviceC --> composition; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| composition -- "(Composition succeeds)" --> supergraph; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| class composition tertiary; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| ``` | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| The supergraph schema includes all of the type and field definitions from your subgraph schemas. It also includes metadata that enables your router to intelligently route incoming GraphQL operations across all of your different subgraphs. | ||||||||||||||
| The supergraph schema includes all of the type and field definitions from your subgraph schemas. It also includes metadata that enables your router to intelligently route incoming GraphQL operations across all of your different subgraphs. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove 'of the' for conciseness and improved readability. 'All type and field definitions' is more direct and idiomatic.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove unnecessary 'of the' for conciseness.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ## Supported methods | ||||||||||||||
| ## Supported methods | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper heading rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the heading is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| You can perform schema composition with any of the following methods: | ||||||||||||||
| You can perform schema composition with any of the following methods: | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the content is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ### Automatically with GraphOS | ||||||||||||||
| ### Automatically with GraphOS | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper heading rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the heading is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| Apollo GraphOS performs composition automatically whenever you publish a subgraph schema. | ||||||||||||||
| This enables your running router to dynamically fetch an updated supergraph schema from Apollo as soon as it's available: | ||||||||||||||
| Apollo GraphOS performs composition automatically whenever you publish a subgraph schema. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the content is correctly rendered.
Suggested change
|
||||||||||||||
| This enables your running router to dynamically fetch an updated supergraph schema from Apollo as soon as it's available: | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the content is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ```mermaid | ||||||||||||||
| graph LR; | ||||||||||||||
| subgraph "Your infrastructure" | ||||||||||||||
| serviceA[Products<br/>subgraph]; | ||||||||||||||
| serviceB[Reviews<br/>subgraph]; | ||||||||||||||
| gateway([Router]); | ||||||||||||||
| end | ||||||||||||||
| subgraph "GraphOS" | ||||||||||||||
| registry{{Schema Registry}}; | ||||||||||||||
| uplink{{Apollo<br/>Uplink}} | ||||||||||||||
| end | ||||||||||||||
| serviceA & serviceB -->|Publishes schema| registry; | ||||||||||||||
| registry -->|Updates config| uplink; | ||||||||||||||
| gateway -->|Polls for config changes| uplink; | ||||||||||||||
| class registry secondary; | ||||||||||||||
| class uplink secondary; | ||||||||||||||
| ``` | ||||||||||||||
| ```mermaid | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| graph LR; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| subgraph "Your infrastructure" | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| serviceA[Products<br/>subgraph]; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| serviceB[Reviews<br/>subgraph]; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| gateway([Router]); | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| end | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| subgraph "GraphOS" | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| registry{{Schema Registry}}; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| uplink{{Apollo<br/>Uplink}} | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| end | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| serviceA & serviceB -->|Publishes schema| registry; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| registry -->|Updates config| uplink; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| gateway -->|Polls for config changes| uplink; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| class registry secondary; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| class uplink secondary; | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation for consistency within the mermaid diagram. All elements in the diagram should have consistent indentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| ``` | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| <Note> | ||||||||||||||
| <Note> | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper rendering of the HTML tag and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the admonition is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| GraphOS also provides a [schema linter](/graphos/platform/schema-management/linting) with [composition specific rules](/graphos/platform/schema-management/linting/rules#composition-rules) to help you follow best practices. You can set up schema checks for your graph in GraphOS Studio or perform one-off linting with the Rover CLI. Check out the [schema linting](/graphos/platform/schema-management/linting) docs to learn more. | ||||||||||||||
| GraphOS also provides a [schema linter](/graphos/platform/schema-management/linting) with [composition specific rules](/graphos/platform/schema-management/linting/rules#composition-rules) to help you follow best practices. You can set up schema checks for your graph in GraphOS Studio or perform one-off linting with the Rover CLI. Check out the [schema linting](/graphos/platform/schema-management/linting) docs to learn more. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency within the note.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the content is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| </Note> | ||||||||||||||
| </Note> | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper rendering of the HTML tag and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the admonition is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ### Manually with the Rover CLI | ||||||||||||||
| ### Manually with the Rover CLI | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper heading rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the heading is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| The [Rover CLI](https://www.apollographql.com/docs/rover/) supports a `supergraph compose` command that you can use to compose a supergraph schema from a collection of subgraph schemas: | ||||||||||||||
| The [Rover CLI](https://www.apollographql.com/docs/rover/) supports a `supergraph compose` command that you can use to compose a supergraph schema from a collection of subgraph schemas: | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use backticks for inline code (
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use backticks for inline code
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ```bash showLineNumbers=false | ||||||||||||||
| rover supergraph compose --config ./supergraph-config.yaml | ||||||||||||||
| ``` | ||||||||||||||
| ```bash showLineNumbers=false | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| rover supergraph compose --config ./supergraph-config.yaml | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency within the code block.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| ``` | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| To learn how to install Rover and use this command, see the [Rover docs](/rover/). | ||||||||||||||
| To learn how to install Rover and use this command, see the [Rover docs](/rover/). | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the content is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ## Breaking composition | ||||||||||||||
| ## Breaking composition | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper heading rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the heading is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| Sometimes, your subgraph schemas might conflict in a way that causes composition to fail. This is called _breaking composition_. | ||||||||||||||
| Sometimes, your subgraph schemas might conflict in a way that causes composition to fail. This is called _breaking composition_. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the content is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| For example, take a look at these two subgraph schemas: | ||||||||||||||
| For example, take a look at these two subgraph schemas: | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use 'consider' instead of 'take a look at' for more concise and formal language, aligning with the Apollo voice.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| <p style="margin-bottom: 0">❌</p> | ||||||||||||||
| <CodeColumns> | ||||||||||||||
| <p style="margin-bottom: 0">❌</p> | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper rendering of the HTML tag and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the HTML tag is correctly rendered.
Suggested change
|
||||||||||||||
| <CodeColumns> | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper rendering of the HTML tag and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the shortcode is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ```graphql {2} title="Subgraph A" | ||||||||||||||
| type Event @shareable { | ||||||||||||||
| timestamp: String! | ||||||||||||||
| } | ||||||||||||||
| ``` | ||||||||||||||
| ```graphql {2} title="Subgraph A" | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| type Event @shareable { | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency within the code block.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| timestamp: String! | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation to be consistent with 2-space YAML indentation as per style guide. This ensures consistent formatting across code blocks.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| } | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency within the code block.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| ``` | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ```graphql {2} title="Subgraph B" | ||||||||||||||
| type Event @shareable { | ||||||||||||||
| timestamp: Int! | ||||||||||||||
| } | ||||||||||||||
| ``` | ||||||||||||||
| ```graphql {2} title="Subgraph B" | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| type Event @shareable { | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency within the code block.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| timestamp: Int! | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adjust indentation to be consistent with 2-space YAML indentation as per style guide. This ensures consistent formatting across code blocks.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| } | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency within the code block.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
| ``` | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper code block rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the code block is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| </CodeColumns> | ||||||||||||||
| </CodeColumns> | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper rendering of the HTML tag and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the shortcode is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails. | ||||||||||||||
| One subgraph defines `Event.timestamp` as a `String`, and the other defines it as an `Int`. Composition doesn't know which type to use, so it fails. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. HTML code tags (
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use backticks for inline code (
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use backticks for inline code (
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| <Note> | ||||||||||||||
| <Note> | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper rendering of the HTML tag and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the admonition is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). | ||||||||||||||
| For examples of valid inconsistencies in field return types, see [Differing shared field return types](/graphos/schema-design/federated-schemas/sharing-types/#return-types). | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency within the note.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the content is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| </Note> | ||||||||||||||
| </Note> | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper rendering of the HTML tag and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the admonition is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. | ||||||||||||||
| Breaking composition is a helpful feature of federation! Whenever a team modifies their subgraph schema, those changes might conflict with another subgraph. But that conflict won't affect your router, because composition fails to generate a new supergraph schema. It's like a compiler error that prevents you from running invalid code. Refer to the [Composition Rules Reference](/graphos/reference/federation/composition-rules) for details. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replaced 'But' with 'However' to maintain a more formal and professional tone in technical documentation.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Capitalize "Federation" as it refers to the product. Replace "But that" with "This" for better flow and conciseness, avoiding the slightly informal tone.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ## Next steps | ||||||||||||||
| ## Next steps | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure proper heading rendering and consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the heading is correctly rendered.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) | ||||||||||||||
| Ready to compose your first supergraph? [Get started with GraphOS!](/graphos/get-started/guides/quickstart) | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces for consistency.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading spaces to ensure the content is correctly rendered.
Suggested change
|
||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sentence is grammatically incorrect and unclear. It should state what schema composition is.