Skip to content

Commit e43c290

Browse files
committed
Mark the SSE and WebSocket modules as experimental
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.
1 parent e23b8e7 commit e43c290

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

‎httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333
* configurable parsing pipeline. It is designed for very low-latency, high-fan-out
3434
* read workloads and integrates with HttpClient 5's asynchronous I/O stack.</p>
3535
*
36+
* <p><strong>Experimental.</strong> This module is experimental. Its public API is not yet stable
37+
* and may change in an incompatible way, or be removed, in a future release; it is excluded from
38+
* the project's binary and source backward-compatibility guarantees for the 5.7 release series.</p>
39+
*
3640
* <h2>Key types</h2>
3741
* <ul>
3842
* <li>{@link org.apache.hc.client5.http.sse.SseExecutor} — entry point that opens

‎httpclient5-websocket/src/main/java/org/apache/hc/client5/http/websocket/package-info.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333
* are created by upgrading an HTTP request and are backed internally
3434
* by the non-blocking I/O reactor used by the HttpClient async APIs.</p>
3535
*
36+
* <p><strong>Experimental.</strong> This module is experimental. Its public API is not yet stable
37+
* and may change in an incompatible way, or be removed, in a future release; it is excluded from
38+
* the project's binary and source backward-compatibility guarantees for the 5.7 release series.</p>
39+
*
3640
* <h2>Core abstractions</h2>
3741
* <ul>
3842
* <li>{@link org.apache.hc.client5.http.websocket.api.WebSocket WebSocket} –

‎httpclient5-websocket/src/main/java/org/apache/hc/core5/websocket/package-info.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232
* {@code util}, and {@code exceptions} are internal implementation details
3333
* and may change without notice.</p>
3434
*
35+
* <p><strong>Experimental.</strong> This module is experimental. Its public API is not yet stable
36+
* and may change in an incompatible way, or be removed, in a future release; it is excluded from
37+
* the project's binary and source backward-compatibility guarantees for the 5.7 release series.</p>
38+
*
3539
* @since 5.7
3640
*/
3741
package org.apache.hc.core5.websocket;

0 commit comments

Comments
 (0)