Skip to content

Send spec-compliant Accept header in fetcher#4199

Merged
trevor-scheer merged 7 commits into
mainfrom
trevor/fetcher-spec-accept-header
Apr 23, 2026
Merged

Send spec-compliant Accept header in fetcher#4199
trevor-scheer merged 7 commits into
mainfrom
trevor/fetcher-spec-accept-header

Conversation

@trevor-scheer

@trevor-scheer trevor-scheer commented Apr 18, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Send application/graphql-response+json as the preferred content type per the GraphQL over HTTP spec, falling back to application/json;q=0.9
  • Applied to createSimpleFetcher, which previously sent no Accept header
  • createMultipartFetcher is left unchanged — the correct Accept header for multipart/mixed responses is still under discussion

Closes #4189

Changes

  • createSimpleFetcher: added accept: 'application/graphql-response+json, application/json;q=0.9'
  • Both fetchers continue to allow user-provided headers (options.headers, fetcherOpts.headers) to override the default
  • Added acceptHeaders.spec.ts with tests covering default headers and override behavior

Validation Steps

  1. yarn dev:graphiql to start the dev server
  2. Open GraphiQL in the browser and run a query (e.g. { __typename })
  3. In DevTools Network tab, inspect the fetch request to the GraphQL endpoint — the Accept request header should be application/graphql-response+json, application/json;q=0.9

@changeset-bot

changeset-bot Bot commented Apr 18, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a886507

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@graphiql/toolkit Minor
@graphiql/plugin-history Patch
@graphiql/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

The latest changes of this PR are not available as canary, since there are no linked changesets for this PR.

@codecov

codecov Bot commented Apr 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.96%. Comparing base (7979bf5) to head (bceaa66).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4199   +/-   ##
=======================================
  Coverage   63.96%   63.96%           
=======================================
  Files          35       35           
  Lines        3086     3086           
  Branches      934      934           
=======================================
  Hits         1974     1974           
  Misses       1107     1107           
  Partials        5        5           

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@TallTed

TallTed commented Apr 20, 2026

Copy link
Copy Markdown
Contributor

The currently specified Accept: header —

application/graphql-response+json, application/json;q=0.9, multipart/mixed

— persists an error. Leaving off the quality rating causes a media type to be treates as if 1.0 (maximum) quality, and that's what the old Accept: header had, and what the new header persists.

I'm fairly well certain that one of application/graphql-response+json or multipart/mixed is really preferred over the other, but I'm not sure which that is.

For sake of understanding, I offer two options. The first prefers application/graphql-response+json and the second prefers multipart/mixed.

application/graphql-response+json, application/json;q=0.9, multipart/mixed;q=0.95

application/graphql-response+json;q=0.95, application/json;q=0.9, multipart/mixed

Note — both of my offered options presume that application/json is the least-preferred. I hope that what I've written is clear enough that any reader of this comment can figure out how to make application/json more preferred than either of the other two.

@trevor-scheer

Copy link
Copy Markdown
Contributor Author

@TallTed I agree with what you're saying and I'm also unsure what the preference should be. For now I've backed out the multipart changes, we'll wait to see if this is ever prescribed by the spec. Some relevant conversation here: graphql/graphql-over-http#167

Thanks for the review!

@trevor-scheer trevor-scheer force-pushed the trevor/fetcher-spec-accept-header branch from bceaa66 to dc8506e Compare April 23, 2026 17:55
Add `application/graphql-response+json` as the preferred content type
per the GraphQL over HTTP spec, with `application/json` as a fallback.
Applied to both createSimpleFetcher and createMultipartFetcher.
The spec-compliant accept header for `multipart/mixed` responses
is still under discussion (graphql/graphql-over-http#167), so
leave the multipart fetcher's accept header unchanged for now.
@trevor-scheer trevor-scheer force-pushed the trevor/fetcher-spec-accept-header branch from dc8506e to 90870c3 Compare April 23, 2026 17:57
@trevor-scheer trevor-scheer marked this pull request as ready for review April 23, 2026 17:58
@trevor-scheer trevor-scheer enabled auto-merge (squash) April 23, 2026 17:58
@trevor-scheer trevor-scheer changed the title Send spec-compliant Accept header in fetchers Send spec-compliant Accept header in fetcher Apr 23, 2026
@trevor-scheer trevor-scheer merged commit 463df14 into main Apr 23, 2026
12 checks passed
@trevor-scheer trevor-scheer deleted the trevor/fetcher-spec-accept-header branch April 23, 2026 18:40
@acao acao mentioned this pull request Apr 23, 2026
@acao acao mentioned this pull request May 7, 2026
@acao acao mentioned this pull request May 8, 2026
This was referenced May 9, 2026
benjie pushed a commit that referenced this pull request May 11, 2026
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @graphiql/toolkit@0.12.0

### Minor Changes

- [#4199](#4199)
[`463df14`](463df14)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Send
spec-compliant `Accept` header (`application/graphql-response+json`) in
`createSimpleFetcher`

## codemirror-graphql@2.2.5

### Patch Changes

- Updated dependencies
\[[`914a547`](914a547),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service@5.5.1

## graphiql@5.2.3

### Patch Changes

- [#4181](#4181)
[`f1a210e`](f1a210e)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix schema
prop to skip introspection when IntrospectionQuery data is provided

Previously, passing an `IntrospectionQuery` result as the `schema` prop
would still trigger a network introspection request. The
`shouldIntrospect` check only recognized `GraphQLSchema` instances (via
`isSchema`), not raw introspection data. Now, when an
`IntrospectionQuery` is passed, a schema is built from it directly using
`buildClientSchema` and introspection is skipped.

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

- Updated dependencies
\[[`f1a210e`](f1a210e),
[`6f5d5d2`](6f5d5d2),
[`40359eb`](40359eb),
[`e7b30c1`](e7b30c1)]:
    -   @graphiql/react@0.37.4
    -   @graphiql/plugin-doc-explorer@0.4.2
    -   @graphiql/plugin-history@0.4.2

## @graphiql/plugin-code-exporter@5.1.2

### Patch Changes

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

## @graphiql/plugin-doc-explorer@0.4.2

### Patch Changes

- [#4231](#4231)
[`6f5d5d2`](6f5d5d2)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix
degraded type declarations in published packages

Both packages import from `@graphiql/react` at build time but only
declared it as a peer dependency. Yarn workspaces topologically orders
builds via `dependencies`/`devDependencies`, not `peerDependencies`, so
on a clean checkout these plugins built before `@graphiql/react` had
emitted its `dist/*.d.ts`. `vite-plugin-dts` then ran `tsc` against
unresolved `@graphiql/react` imports, fell back to `any` for any return
type that flowed through `useGraphiQL`, and published `.d.ts` artifacts
where hooks like `useDocExplorer` and `useDocExplorerActions` resolved
to `() => any` instead of their real shapes.

Adding `@graphiql/react` as a `devDependency` matches the pattern
already in `@graphiql/plugin-explorer` and
`@graphiql/plugin-code-exporter` and lets the build run in topological
order.

- [#4140](#4140)
[`40359eb`](40359eb)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove
`react-compiler-runtime` peer dependency

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

## @graphiql/plugin-explorer@5.1.2

### Patch Changes

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

## @graphiql/plugin-history@0.4.2

### Patch Changes

- [#4231](#4231)
[`6f5d5d2`](6f5d5d2)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix
degraded type declarations in published packages

Both packages import from `@graphiql/react` at build time but only
declared it as a peer dependency. Yarn workspaces topologically orders
builds via `dependencies`/`devDependencies`, not `peerDependencies`, so
on a clean checkout these plugins built before `@graphiql/react` had
emitted its `dist/*.d.ts`. `vite-plugin-dts` then ran `tsc` against
unresolved `@graphiql/react` imports, fell back to `any` for any return
type that flowed through `useGraphiQL`, and published `.d.ts` artifacts
where hooks like `useDocExplorer` and `useDocExplorerActions` resolved
to `() => any` instead of their real shapes.

Adding `@graphiql/react` as a `devDependency` matches the pattern
already in `@graphiql/plugin-explorer` and
`@graphiql/plugin-code-exporter` and lets the build run in topological
order.

- [#4140](#4140)
[`40359eb`](40359eb)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove
`react-compiler-runtime` peer dependency

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

- Updated dependencies
\[[`463df14`](463df14)]:
    -   @graphiql/toolkit@0.12.0

## @graphiql/react@0.37.4

### Patch Changes

- [#4181](#4181)
[`f1a210e`](f1a210e)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix schema
prop to skip introspection when IntrospectionQuery data is provided

Previously, passing an `IntrospectionQuery` result as the `schema` prop
would still trigger a network introspection request. The
`shouldIntrospect` check only recognized `GraphQLSchema` instances (via
`isSchema`), not raw introspection data. Now, when an
`IntrospectionQuery` is passed, a schema is built from it directly using
`buildClientSchema` and introspection is skipped.

- [#4140](#4140)
[`40359eb`](40359eb)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove
`react-compiler-runtime` peer dependency

- [#4211](#4211)
[`e7b30c1`](e7b30c1)
Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to
sideEffects to allow import of CSS in Webpack Javascript

- Updated dependencies
\[[`914a547`](914a547),
[`463df14`](463df14),
[`4bb7909`](4bb7909),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service@5.5.1
    -   @graphiql/toolkit@0.12.0
    -   monaco-graphql@1.7.4

## graphql-language-service@5.5.1

### Patch Changes

- [#3882](#3882)
[`914a547`](914a547)
Thanks [@bensengupta](https://github.com/bensengupta)! - Fix off-by-one
when hovering over token

- [#4222](#4222)
[`10f66d5`](10f66d5)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and
update graphql-config dependency

## graphql-language-service-server@2.14.9

### Patch Changes

- [#4187](#4187)
[`ca83879`](ca83879)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Bump
required TypeScript runtime dependency from `^5.3.3` to `^5.8.0`. This
is preparatory work for adopting the TypeScript Native Preview (tsgo)
compiler in a follow-up change, which tracks TypeScript 5.8 semantics.
In practice `^5.3.3` already resolved to TS 5.8+ for most consumers; the
new floor only affects consumers who pin TypeScript to 5.3–5.7 via
resolutions or overrides.

- [#4222](#4222)
[`10f66d5`](10f66d5)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and
update graphql-config dependency

- Updated dependencies
\[[`914a547`](914a547),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service@5.5.1

## monaco-graphql@1.7.4

### Patch Changes

- [#4225](#4225)
[`4bb7909`](4bb7909)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix hover
crashing on the first line of a query

`GraphQLWorker.doHover` was passing 0-indexed positions to `getRange`,
which expects a 1-indexed `SourceLocation` (per the GraphQL spec). On
the first line this caused `Expected Parser stream to be available` to
be logged and hover to return `null`. On other lines it returned the
range of the previous line's last token rather than the token under the
cursor. Use `getTokenAtPosition` to compute the actual token range
instead.

- Updated dependencies
\[[`914a547`](914a547),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service@5.5.1

## vscode-graphql@0.13.3

### Patch Changes

- [#4183](#4183)
[`2ef9389`](2ef9389)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code
extension publishing scripts

- Updated dependencies
\[[`ca83879`](ca83879),
[`10f66d5`](10f66d5)]:
    -   graphql-language-service-server@2.14.9

## vscode-graphql-execution@0.3.3

### Patch Changes

- [#4183](#4183)
[`2ef9389`](2ef9389)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code
extension publishing scripts

- [#4222](#4222)
[`10f66d5`](10f66d5)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and
update graphql-config dependency

## vscode-graphql-syntax@1.3.9

### Patch Changes

- [#4183](#4183)
[`2ef9389`](2ef9389)
Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code
extension publishing scripts

- [#4143](#4143)
[`7979bf5`](7979bf5)
Thanks [@Netail](https://github.com/Netail)! - Add syntax highlighting
support for subscription operations.

- [#4144](#4144)
[`f7e2a56`](f7e2a56)
Thanks [@jsmnbom](https://github.com/jsmnbom)! - Add `text.html.vue` as
inline injection target.

[This PR](vuejs/language-tools#5856) broke
tooling by changing the vue grammar scope from `source.vue` to
`text.html.vue`. This adds `text.html.vue` as an additional injection
target for GraphQL syntax highlighting so that it works in both cases.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[graphiql] Send Accept: application/graphql-response+json, application/json;q=0.9

3 participants