Skip to content
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

[docs] Update composition errors docs #2977

Merged
merged 5 commits into from
May 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 11 additions & 5 deletions docs/source/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,19 @@ description: Learn the error codes you can receive if composition fails.
toc: false
---

When Apollo Gateway attempts to compose the schemas provided by your [subgraphs](./building-supergraphs/subgraphs-overview/) into a supergraph schema, it confirms that:
When GraphOS attempts to compose the schemas provided by your [subgraphs](./building-supergraphs/subgraphs-overview/) into a supergraph schema, it confirms that:

- The subgraphs are valid
- The subgraphs have valid GraphQL and Federation syntax
- The resulting supergraph schema is valid
- The gateway has all of the information it needs to execute operations against the resulting schema
- The graph router or gateway has all of the information it needs to execute operations against the resulting schema

If Apollo Gateway encounters an error, composition fails. This document lists subgraph validation and composition error codes, along with their root causes.
If composition fails, a new supergraph schema cannot be generated. This document lists subgraph validation and composition error codes, along with their root causes.

<Note>

Composition may flag potential improvements or _hints_ on schemas which are technically valid. These hints aren't errors, and are instead logged as part of the composition build step.
To learn more, see the [composition hints doc](/federation/hints/).
</Note>

### Errors

Expand Down Expand Up @@ -1633,4 +1639,4 @@ Subgraph definitions for a union are now merged by composition.
</td>
</tr>
</tbody>
</table>
</table>