From f9411252452c435fca726c2a7ec6be00751380aa Mon Sep 17 00:00:00 2001 From: Avery Harnish Date: Mon, 20 Sep 2021 14:26:39 -0500 Subject: [PATCH] docs: adds gateway compatibility section to compose docs --- docs/source/supergraphs.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/supergraphs.md b/docs/source/supergraphs.md index 0a15f39777..e955c9d3cb 100644 --- a/docs/source/supergraphs.md +++ b/docs/source/supergraphs.md @@ -74,3 +74,15 @@ rover supergraph compose --config ./supergraph.yaml > prod-schema.graphql ``` > For more on passing values via `stdout`, see [Using `stdout`](./conventions#using-stdout). + +#### Gateway compatibility + +`rover supergraph compose` utilizes the composition function published in the [harmonizer]() package under the hood. Harmonizer is still under rapid development, and some breaking changes are to be expected. For now, newer versions of Rover emit supergraph schemas that are incompatible with older versions of [`@apollo/gateway`](https://www.npmjs.com/package/@apollo/gateway). + +The following table should help you understand the compatible versions of these two pieces of software. + + +|Rover version|Gateway version| +|---|---| +|<= v0.2|<= v0.38| +|>= v0.3|>= v0.39| \ No newline at end of file