Add support for Server-Sent Events (SSE) in API Explorer and configuration#1041
Merged
sserrata merged 2 commits intoPaloAltoNetworks:mainfrom Mar 24, 2025
Merged
Add support for Server-Sent Events (SSE) in API Explorer and configuration#1041sserrata merged 2 commits intoPaloAltoNetworks:mainfrom
sserrata merged 2 commits intoPaloAltoNetworks:mainfrom
Conversation
|
Visit the preview URL for this PR (updated for commit cf0aca7): https://docusaurus-openapi-36b86--pr1041-b5fc1kg5.web.app (expires Wed, 23 Apr 2025 15:33:18 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
Member
|
Thanks for the contribution @dvaJi, planning to review it for the next release. |
Member
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.

Description
Added support for Server-Sent Events (SSE) to handle streaming responses in the
docusaurus-theme-openapi-docslibrary. This includes a newhandleEventStreamfunction to process SSE responses and update the state accordingly.Motivation and Context
This change is required to support APIs that use Server-Sent Events (SSE) for streaming data. It solves the problem of handling real-time updates from the server, which was not supported previously (it waits until the request is closed). This enhancement allows users to see live updates in the API response section.
How Has This Been Tested?
Tested locally by linking the modified
docusaurus-theme-openapi-docslibrary to another project and verifying that SSE responses are handled correctly. Specifically:Screenshots (if appropriate)
Types of changes
Checklist