Skip to content

feat: Http endpoint web socket support - #1246

Merged
johanandren merged 22 commits into
mainfrom
wip-websocket-endpoint-support
Jan 29, 2026
Merged

johanandren merged 22 commits into
mainfrom
wip-websocket-endpoint-support

Conversation

@johanandren

@johanandren johanandren commented Jan 13, 2026 •

Copy link
Copy Markdown
Contributor

References https://github.com/lightbend/akka-runtime/issues/4621

Depends on runtime changes in https://github.com/lightbend/akka-runtime/pull/4695 (in runtime release 1.5.31)

@github-actions github-actions Bot added documentation documentation related java-sdk labels Jan 13, 2026
@johanandren

Copy link
Copy Markdown
Contributor Author

Can not go in until we have infrastructure in place, and then docs covering that should also go here before ready for merge.

@johanandren
johanandren force-pushed the wip-websocket-endpoint-support branch from babd69f to 4f39f7f Compare January 15, 2026 13:22
@johanandren
johanandren force-pushed the wip-websocket-endpoint-support branch from fe182b5 to be315d6 Compare January 23, 2026 12:53
@johanandren
johanandren marked this pull request as ready for review January 26, 2026 10:37

@patriknw patriknw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

*/
// Opened up for access from the public internet to make the service easy to try out.
// For actual services meant for production this must be carefully considered,
// and often set more limited

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

does JavaDoc allow such // comments between the /** and the class?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not sure, but we do it all over the samples already.


// Note: using websocket in a deployed service requires additional steps, see the documentation
// tag::ws-view-updates[]
@WebSocket("/by-city-ws/{cityName}") // <1>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

should we use a prefix, like we recommend?
/ws/by-city/{cityName}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hmm, maybe better yeah, needs to go in its own endpoint class then because this already has /customer as class wide prefix.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Changed both sample snippets to have a /websockets prefix, aligned with the descriptor sample prefix now.

@johanandren
johanandren merged commit bd17cd3 into main Jan 29, 2026
37 checks passed
@johanandren
johanandren deleted the wip-websocket-endpoint-support branch January 29, 2026 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation documentation related java-sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants