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 36756da8aa Fix docs from TODO-297 audit: replace fabricated Basic*
class refs on migration guide + rate-limit pages (ROLLUP slice m)
36756da8aa is described below
commit 36756da8aa8654f8cc8049a8eab1b9297e8b166c
Author: James Bognar <[email protected]>
AuthorDate: Mon Jul 27 08:03:57 2026 -0400
Fix docs from TODO-297 audit: replace fabricated Basic* class refs on
migration guide + rate-limit pages (ROLLUP slice m)
Closes the last TODO-297 ROLLUP slice (m); real Health/Swagger/Redoc/OpenApi
mixin+resource classes substituted for fabricated Basic* names on
27.V10MigrationGuide.md and 10.36.RestServerRateLimitAndRequestId.md.
Co-authored-by: Cursor <[email protected]>
---
pages/topics/10.36.RestServerRateLimitAndRequestId.md | 2 +-
pages/topics/27.V10MigrationGuide.md | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/pages/topics/10.36.RestServerRateLimitAndRequestId.md
b/pages/topics/10.36.RestServerRateLimitAndRequestId.md
index e8f15c1319..a7a0a160f9 100644
--- a/pages/topics/10.36.RestServerRateLimitAndRequestId.md
+++ b/pages/topics/10.36.RestServerRateLimitAndRequestId.md
@@ -124,7 +124,7 @@ A spoofed header lets an attacker forge a fresh key per
request and bypass the b
- Run on a tight schedule (often every 5–10 seconds) from a known set of IPs.
- Must always succeed to avoid spurious pod-restart loops.
-The defaults — `/healthz`, `/readyz`, `/livez` — match the Juneau
`BasicHealthResource` paths. Override with your own list (or pass
`.exemptPaths()` for none) when paths differ.
+The defaults — `/healthz`, `/readyz`, `/livez` — match the paths served by
Juneau's built-in health-probe classes (`HealthMixin` / `HealthServlet` /
`HealthResource`, `org.apache.juneau.rest.server.health`). Override with your
own list (or pass `.exemptPaths()` for none) when paths differ.
The path match is exact: it compares against `RestRequest.getPathInfo()`
first, then `getServletPath()`. Both are checked verbatim — there is no
prefix/glob matching in v1. Wildcard support is on the future-work list.
diff --git a/pages/topics/27.V10MigrationGuide.md
b/pages/topics/27.V10MigrationGuide.md
index ea916c9bb9..20d492d510 100644
--- a/pages/topics/27.V10MigrationGuide.md
+++ b/pages/topics/27.V10MigrationGuide.md
@@ -122,7 +122,7 @@ Single-type imports follow the same rename, e.g.:
| Old | New | Notes |
|-----|-----|-------|
-| `BasicHealthResource` standalone auto-mount used `@Rest(path="/")`, which
collided with root resources mounted at `/*` in Jetty microservices. |
`BasicHealthResource` now uses `@Rest(paths={"/healthz","/readyz","/livez"})`
and can also be composed into an existing root resource via
`@Rest(mixins=BasicHealthResource.class)`. | Prefer `mixins` when you already
have a root `@Rest(path="/")` resource. Keep standalone
`HealthProbeConfiguration` only when you explicitly want a separate servl [...]
+| `HealthServlet` standalone auto-mount used `@Rest(path="/")`, which collided
with root resources mounted at `/*` in Jetty microservices. | `HealthServlet`
now uses `@Rest(paths={"/healthz","/readyz","/livez"})`, and probes can also be
composed into an existing root resource via `@Rest(mixins=HealthMixin.class)`.
| Prefer `mixins` (`HealthMixin`) when you already have a root
`@Rest(path="/")` resource. Keep standalone `HealthServlet`, wired in via
`HealthProbeConfiguration`, only when y [...]
## SVL and Runtime Input Types Moved to `juneau-commons`
@@ -931,7 +931,7 @@ OpenAPI 3.1 emission is new in v10.0; existing Swagger v2
emission is unchanged.
| Old | New | Notes |
|-----|-----|-------|
-| Resource exposed only Swagger v2 at `/api/*`. No way to opt into OpenAPI 3.1
emission. | Apply one or more api-docs mixins from
`org.apache.juneau.rest.docs`: `BasicSwaggerResource` (`/api`),
`BasicSwaggerUiResource` (`/swagger`), `BasicOpenApiResource` (`/openapi`,
`/openapi.json`, `/openapi.yaml`), `BasicRedocResource` (`/redoc`). Subclasses
of `BasicRestServlet` / `BasicRestResource` get all four (composed as
`@Rest(mixins={BasicSwaggerUiResource.class, BasicRedocResource.class})`) [...]
+| Resource exposed only Swagger v2 at `/api/*`. No way to opt into OpenAPI 3.1
emission. | Apply one or more api-docs mixins from
`org.apache.juneau.rest.server.docs`: `SwaggerMixin` (`/api`), `SwaggerUiMixin`
(`/swagger`), `OpenApiMixin` (`/openapi`, `/openapi.json`, `/openapi.yaml`),
`RedocMixin` (`/redoc`). Subclasses of `BasicRestServlet` / `BasicRestResource`
get all four (composed as `@Rest(mixins={SwaggerUiMixin.class,
RedocMixin.class})`) automatically. | The `.json` and `.yaml` [...]
| `BasicRestOperations.getSwagger(RestRequest)` and `getOpenApi(RestRequest)`
interface methods | Removed. The endpoints are now mounted via the api-docs
mixin pack on `BasicRestServlet` / `BasicRestResource`. User-written
`BasicRestOperations` implementers should remove their old `getSwagger` /
`getOpenApi` overrides — the methods are no longer on the interface. | If you
need a different api-docs surface, add `@Rest(noInherit={"mixins"},
mixins=...)` on your subclass. |
| `BasicGroupOperations.getChildrenSwagger(RestRequest)` /
`getChildrenOpenApi(RestRequest)` (the `?Swagger` / `?OpenApi` query mirrors on
group resources) and the `HasSwaggerQueryParam` / `HasOpenApiQueryParam`
matcher inner classes | Removed. Hit `/api`, `/swagger`, `/openapi`, or
`/redoc` directly — they are always mounted on `BasicRestServletGroup` /
`BasicRestResourceGroup` via the api-docs mixin pack. | External docs that
linked to `/?Swagger=true` need updating to `/api` (or `/swa [...]
| `RestRequest.getSwagger()` was the only way to ask the server for its
self-described API. | `RestRequest.getOpenApi()` provides the OpenAPI 3.1
sibling. `RestContext.getOpenApi(Locale)` and
`RestContext.getOpenApiProvider()` mirror the Swagger getters. | The OpenAPI
3.1 document is generated by transforming the Swagger 2.0 emission to OpenAPI
3.1 JSON, so every Swagger-aware annotation (`@Schema`, `@Content`,
`@StatusCode`, etc.) round-trips with no source changes. |
