You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2026/08/12 13:39:14 UTC
(juneau) branch docs updated: Docs/javadoc cleanup + rest header of(...) factories + MCP/rest-common doc clarifications
This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch docs
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/docs by this push:
new c68ca927a0 Docs/javadoc cleanup + rest header of(...) factories + MCP/rest-common doc clarifications
c68ca927a0 is described below
commit c68ca927a0a72ae268b98943443964fc702e924a
Author: James Bognar <ja...@apache.org>
AuthorDate: Wed Aug 12 09:39:09 2026 -0400
Docs/javadoc cleanup + rest header of(...) factories + MCP/rest-common doc clarifications
---
pages/topics/08.JuneauRest.md | 4 ++--
pages/topics/09.00.JuneauRestCommon.md | 11 +++--------
2 files changed, 5 insertions(+), 10 deletions(-)
diff --git a/pages/topics/08.JuneauRest.md b/pages/topics/08.JuneauRest.md
index 2418676e33..b837d6765b 100644
--- a/pages/topics/08.JuneauRest.md
+++ b/pages/topics/08.JuneauRest.md
@@ -68,11 +68,11 @@ Note that you may choose to have your service class implement your interface.
The REST libraries will happily look for annotations defined on methods of parent classes and interfaces.
It's up to you how you want to design it.
-Finally, the <a href="/site/apidocs/org/apache/juneau/rest/client/classic/RestClient.html" target="_blank">RestClient</a> class is used to construct a
+Finally, the classic <a href="/site/apidocs/org/apache/juneau/rest/client/classic/RestClient.html" target="_blank">RestClient</a> class (`juneau-rest-client-classic`) is used to construct a
remote proxy to our REST service:
```java
-// Use a RestClient with default JSON 5 support and BASIC auth.
+// Use a classic RestClient with default JSON 5 support and BASIC auth.
RestClient client = RestClient.create().json5().basicAuth(...).build();
// Instantiate our proxy interface.
diff --git a/pages/topics/09.00.JuneauRestCommon.md b/pages/topics/09.00.JuneauRestCommon.md
index 81b66102c3..c17536b54f 100644
--- a/pages/topics/09.00.JuneauRestCommon.md
+++ b/pages/topics/09.00.JuneauRestCommon.md
@@ -11,16 +11,11 @@ slug: JuneauRestCommon
| `juneau-rest-common` | Transport-neutral types under `org.apache.juneau.http.*` and `org.apache.juneau.http.remote.*` — annotations, lazy header beans, remote-proxy meta, transport-neutral parts, and transport-neutral response messages. Used by every `juneau-rest-*` module. | **No.** Zero `org.apache.httpcomponents:*` on the classpath. |
| `juneau-rest-common-classic` | Apache HttpClient 4.5–compatible facades under `org.apache.juneau.http.classic.*` — `BasicHeader`, `BasicMediaTypeHeader`, `BasicHttpEntity`, `BasicHttpResponse`, response/exception classes, `HeaderList`, etc. (~170 types). | **Yes.** Depends on `juneau-rest-common` and `org.apache.httpcomponents:httpcore:4.4.16`. |
-For transport-neutral (NG) consumers, the canonical path is `juneau-rest-common` alone. For code that uses any `org.apache.juneau.http.classic.*` facade (e.g. `BasicHeader`, `BasicHttpResponse`, `HeaderList`), add **both** artifacts:
+For transport-neutral (NG) consumers, the canonical path is `juneau-rest-common` alone. For code that uses any `org.apache.juneau.http.classic.*` facade (e.g. `BasicHeader`, `BasicHttpResponse`, `HeaderList`), declare `juneau-rest-common-classic` alone — its POM declares `juneau-rest-common` as a normal compile-scope dependency (no `<optional>`, no reduced `<scope>`), so `juneau-rest-common` is already on the compile classpath transitively:
-<DependencyInfo
- artifacts={[
- { artifact: "juneau-rest-common", bundle: "org.apache.juneau.rest.server.common" },
- { artifact: "juneau-rest-common-classic", bundle: "org.apache.juneau.rest.server.common.classic" }
- ]}
-/>
+<DependencyInfo artifact="juneau-rest-common-classic" bundle="org.apache.juneau.rest.server.common.classic" note="Pulls in juneau-rest-common transitively — no need to declare it separately." />
-The aggregator artifacts (`juneau-rest-server`, `juneau-rest-client-classic`, `juneau-rest-mock`, `juneau-microservice`, `juneau-rest-server-springboot`, `juneau-shaded-rest-server`, `juneau-shaded-rest-client`, `juneau-shaded-all`, `juneau-distrib`) already pull both modules in transitively, so most callers don't need to declare them directly.
+The aggregator artifacts (`juneau-rest-server`, `juneau-rest-client-classic`, `juneau-rest-mock`, `juneau-microservice`, `juneau-rest-server-springboot`, `juneau-shaded-rest-server`, `juneau-shaded-rest-client`, `juneau-shaded-all`, `juneau-distrib`) already pull both modules in transitively, so most callers don't need to declare either directly.
## Contents/Features