From 9961391b734931eff6b01060123fbd2e329c1dad Mon Sep 17 00:00:00 2001
From: Arturo Bernal <abernal@apache.org>
Date: Sat, 1 Aug 2026 09:29:36 +0200
Subject: [PATCH] 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.
---
 .../java/org/apache/hc/client5/http/sse/package-info.java     | 4 ++++
 .../org/apache/hc/client5/http/websocket/package-info.java    | 4 ++++
 .../main/java/org/apache/hc/core5/websocket/package-info.java | 4 ++++
 3 files changed, 12 insertions(+)

diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java
index 7c3345632f..6fa57894b2 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java
@@ -33,6 +33,10 @@
  * configurable parsing pipeline. It is designed for very low-latency, high-fan-out
  * read workloads and integrates with HttpClient 5's asynchronous I/O stack.</p>
  *
+ * <p><strong>Experimental.</strong> This module is experimental. Its public API is not yet stable
+ * and may change in an incompatible way, or be removed, in a future release; it is excluded from
+ * the project's binary and source backward-compatibility guarantees for the 5.7 release series.</p>
+ *
  * <h2>Key types</h2>
  * <ul>
  *   <li>{@link org.apache.hc.client5.http.sse.SseExecutor} — entry point that opens
diff --git a/httpclient5-websocket/src/main/java/org/apache/hc/client5/http/websocket/package-info.java b/httpclient5-websocket/src/main/java/org/apache/hc/client5/http/websocket/package-info.java
index f7b59da2f1..9d4104f953 100644
--- a/httpclient5-websocket/src/main/java/org/apache/hc/client5/http/websocket/package-info.java
+++ b/httpclient5-websocket/src/main/java/org/apache/hc/client5/http/websocket/package-info.java
@@ -33,6 +33,10 @@
  * are created by upgrading an HTTP request and are backed internally
  * by the non-blocking I/O reactor used by the HttpClient async APIs.</p>
  *
+ * <p><strong>Experimental.</strong> This module is experimental. Its public API is not yet stable
+ * and may change in an incompatible way, or be removed, in a future release; it is excluded from
+ * the project's binary and source backward-compatibility guarantees for the 5.7 release series.</p>
+ *
  * <h2>Core abstractions</h2>
  * <ul>
  *   <li>{@link org.apache.hc.client5.http.websocket.api.WebSocket WebSocket} –
diff --git a/httpclient5-websocket/src/main/java/org/apache/hc/core5/websocket/package-info.java b/httpclient5-websocket/src/main/java/org/apache/hc/core5/websocket/package-info.java
index 3394c70dd2..b445e38403 100644
--- a/httpclient5-websocket/src/main/java/org/apache/hc/core5/websocket/package-info.java
+++ b/httpclient5-websocket/src/main/java/org/apache/hc/core5/websocket/package-info.java
@@ -32,6 +32,10 @@
  * {@code util}, and {@code exceptions} are internal implementation details
  * and may change without notice.</p>
  *
+ * <p><strong>Experimental.</strong> This module is experimental. Its public API is not yet stable
+ * and may change in an incompatible way, or be removed, in a future release; it is excluded from
+ * the project's binary and source backward-compatibility guarantees for the 5.7 release series.</p>
+ *
  * @since 5.7
  */
 package org.apache.hc.core5.websocket;