docs: Add clarifying comments for stateless streamable HTTP endpoints #542
+2
−0
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
Add inline comments explaining why GET and DELETE endpoints return 405 in stateless mode: - GET: SSE notifications not supported without session management - DELETE: Session termination not needed in stateless mode
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.
This PR adds inline comments to clarify why GET and DELETE endpoints return 405 in stateless mode for streamable HTTP transport. As new StreamableHTTP user, I was still grasping the concepts, and at first thought those were to give useful errors for legacy SSE client connections.
Motivation and Context
When reading the stateless streamable HTTP example, it's not immediately clear why these endpoints are not implemented. The comments help developers understand that:
How Has This Been Tested?
Documentation change only - no code changes to test.
Breaking Changes
None - documentation only.
Types of changes
Checklist
Additional context
This change improves developer understanding of the stateless vs stateful streamable HTTP transport modes.