Skip to content

Mark the SSE and WebSocket modules as experimental - #864

Open
arturobernalg wants to merge 1 commit into
apache:masterfrom
arturobernalg:mark-sse-websocket-experimental
Open

Mark the SSE and WebSocket modules as experimental#864
arturobernalg wants to merge 1 commit into
apache:masterfrom
arturobernalg:mark-sse-websocket-experimental

Conversation

@arturobernalg

Copy link
Copy Markdown
Member

Annotated the public API types of the httpclient5-sse and httpclient5-websocket modules with @experimental. Both modules expose a large API surface that is not yet stable, and the annotation marks them as subject to change so that a relaxed compatibility policy applies for the 5.7 release series; the japicmp binary and source compatibility checks are already skipped for both modules. Types that are already marked @internal are left unchanged.

@arturobernalg
arturobernalg requested a review from ok2c August 1, 2026 09:40
@ok2c

ok2c commented Aug 1, 2026

Copy link
Copy Markdown
Member

@arturobernalg I imagine adding a note to the top level package-info.java about the module still considered experimental would be enough. I leave it up to you to decide if you want to mark every public class @Experimenal or just mark the top level javadoc.

Added an experimental note to the top-level package documentation of the httpclient5-sse and
httpclient5-websocket modules. Both modules expose a large API surface that is not yet stable;
the note states that their public API may change in an incompatible way, or be removed, in a
future release. This is consistent with the japicmp binary and source compatibility checks
already being skipped for both modules throughout the 5.7 release series.
@arturobernalg
arturobernalg force-pushed the mark-sse-websocket-experimental branch from 25a89fc to 9961391 Compare August 2, 2026 05:41
@arturobernalg
arturobernalg requested a review from ok2c August 2, 2026 05:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants