docs: clarify subscription completion result - #3171
Open
DaleSeo wants to merge 2 commits into
Open
Conversation
DaleSeo
marked this pull request as ready for review
August 2, 2026 23:07
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.
Motivation and Context
Right now, the text calls the successful
subscriptions/listenresponse "empty," but the result shown right below it includesresultTypeand the required subscription metadata. That could be interpreted as requiring a literalresult: {}object, which would conflict with the schema and example.This wording describes it as a completion result instead and clarifies that it contains no method-specific data beyond the standard result fields and subscription metadata.
How Has This Been Tested?
npm run prepBreaking Changes
None.
Types of changes
Checklist