Skip to content

docs: streaming beta#376

Open
gastonfournier wants to merge 1 commit into
mainfrom
docs/streaming
Open

docs: streaming beta#376
gastonfournier wants to merge 1 commit into
mainfrom
docs/streaming

Conversation

@gastonfournier
Copy link
Copy Markdown
Contributor

Streaming docs and example

Copilot AI review requested due to automatic review settings May 11, 2026 10:29
@coveralls
Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 25664740665

Coverage increased (+0.06%) to 79.666%

Details

  • Coverage increased (+0.06%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 4240
Covered Lines: 3500
Line Coverage: 82.55%
Relevant Branches: 1096
Covered Branches: 751
Branch Coverage: 68.52%
Branches in Coverage %: Yes
Coverage Strength: 9.7 hits per line

💛 - Coveralls

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds end-user documentation and a runnable example for the Java SDK’s beta streaming mode, aimed at early validation against Unleash Enterprise Edge.

Changes:

  • Document streaming beta requirements, configuration, and failover/reconnect behavior in the README.
  • Document the experimentalStreamingMode config builder option in the configuration options table.
  • Update the streaming example to use an Enterprise Edge base URL and apiKey() rather than a hard-coded demo URL/token.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Adds “Streaming beta” docs and documents experimentalStreamingMode in the config options table.
examples/streaming-example/src/main/java/io/getunleash/example/StreamingExample.java Updates the example to target an Enterprise Edge /api/ base URL and use apiKey() with environment variables/placeholders.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gastonfournier gastonfournier moved this from New to In Progress in Issues and PRs May 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

4 participants