Repository navigation
docs(graphql): name the mercurius subscription option in the federation hint - #3680
Merged
kamilmysliwiec merged 1 commit intoOct 30, 2026
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
Federation hint says subgraphs support subscriptions "with the
subscriptionsoption" and for Mercurius gateway it is enough to setwsUrlfor each service. Both are off for Mercurius. Its option issubscription(like on subscriptions page),subscriptionsonMercuriusFederationDrivergives TS2561 "Did you mean to write 'subscription'?" and if forced past types WebSocket handshake gets 400. Gateway with onlywsUrlalso answers 400, it needssubscription: trueitselfWhat is the new behavior?
Hint names both options (
subscriptionsfor Apollo,subscription: truefor Mercurius) and says Mercurius gateway needssubscription: truepluswsUrlfor each service. Checked on @nestjs/mercurius 14.1.0 with mercurius 16.12.1 and @mercuriusjs/gateway 5.2.0, subscription goes through subgraph and through gateway with these settingsDoes this PR introduce a breaking change?