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.

Sign up for GitHub

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

Jump to bottom

fix(docs): Apollo-Query-Plan-Experimental -> Apollo-Expose-Query-Plan #3115

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(docs): Apollo-Query-Plan-Experimental -> Apollo-Expose-Query-Plan #3115

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c273d0e
fix(docs): `Apollo-Query-Plan-Experimental` -> `Apollo-Expose-Query-P…
aaronArinder Aug 13, 2024
ec5e4bd
Update docs/source/query-plans.mdx
aaronArinder Aug 13, 2024
e77d847
Update docs/source/query-plans.mdx
aaronArinder Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/query-plans.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-Query-Plan-Experimental` header 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
Expand Down