From c273d0ecccc2f6a1cefa61f0bcd28a50984c0aea Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 13 Aug 2024 15:03:34 -0400 Subject: [PATCH 1/3] fix(docs): `Apollo-Query-Plan-Experimental` -> `Apollo-Expose-Query-Plan` this is more of a starter pr than an actual ready-to-merge pr; the `Apollo-Query-Plan-Experimental` header doesn't seem to be a thing anymore, but I haven't found its replacement yet (if there is a replacement) --- docs/source/query-plans.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/query-plans.mdx b/docs/source/query-plans.mdx index aaf61d6b5..e68c52cf1 100644 --- a/docs/source/query-plans.mdx +++ b/docs/source/query-plans.mdx @@ -504,7 +504,7 @@ You can view the query plan for a particular operation in any of the following w With [the Apollo Router Core](/router/) v0.16.0+ and [`@apollo/gateway`](/apollo-server/using-federation/api/apollo-gateway/) v2.5.4+, you can pass the following headers to return the query plans in the GraphQL response extensions: -- Including the `Apollo-Query-Plan-Experimental` header returns the query plan in the response extensions +- Including the `Apollo-Expose-Query-Planl` header with a `true` value returns the query plan in the response extensions - Additionally including the `Apollo-Query-Plan-Experimental-Format` header with one of the supported options changes the output format: - A value of `prettified` returns a human-readable string of the query plan - A value of `internal` returns a JSON representation of the query plan From ec5e4bd0a55edebded282d8e219f5c5ff2a199c0 Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 13 Aug 2024 15:04:34 -0400 Subject: [PATCH 2/3] Update docs/source/query-plans.mdx --- docs/source/query-plans.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/query-plans.mdx b/docs/source/query-plans.mdx index e68c52cf1..261086a2d 100644 --- a/docs/source/query-plans.mdx +++ b/docs/source/query-plans.mdx @@ -504,7 +504,7 @@ You can view the query plan for a particular operation in any of the following w With [the Apollo Router Core](/router/) v0.16.0+ and [`@apollo/gateway`](/apollo-server/using-federation/api/apollo-gateway/) v2.5.4+, you can pass the following headers to return the query plans in the GraphQL response extensions: -- Including the `Apollo-Expose-Query-Planl` header with a `true` value returns the query plan in the response extensions +- Including the `Apollo-Expose-Query-Plan` header with a `true` value returns the query plan in the response extensions - Additionally including the `Apollo-Query-Plan-Experimental-Format` header with one of the supported options changes the output format: - A value of `prettified` returns a human-readable string of the query plan - A value of `internal` returns a JSON representation of the query plan From e77d847e0a8f119498984d49ea9f45890f7f5802 Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 13 Aug 2024 15:12:09 -0400 Subject: [PATCH 3/3] Update docs/source/query-plans.mdx --- docs/source/query-plans.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/query-plans.mdx b/docs/source/query-plans.mdx index 261086a2d..9b824ff36 100644 --- a/docs/source/query-plans.mdx +++ b/docs/source/query-plans.mdx @@ -504,7 +504,8 @@ You can view the query plan for a particular operation in any of the following w With [the Apollo Router Core](/router/) v0.16.0+ and [`@apollo/gateway`](/apollo-server/using-federation/api/apollo-gateway/) v2.5.4+, you can pass the following headers to return the query plans in the GraphQL response extensions: -- Including the `Apollo-Expose-Query-Plan` header with a `true` value returns the query plan in the response extensions +- When using the router, including the `Apollo-Expose-Query-Plan` header with a `true` value returns the query plan in the response extensions +- And for the Apollo Gateway, the `Apollo-Query-Plan-Experimental` header with a `true` value returns the query plan in the response extensions - Additionally including the `Apollo-Query-Plan-Experimental-Format` header with one of the supported options changes the output format: - A value of `prettified` returns a human-readable string of the query plan - A value of `internal` returns a JSON representation of the query plan