Remove the openapi-war-overlay module#296
Merged
vharseko merged 1 commit intoJul 23, 2026
Merged
Conversation
vharseko
added
codeql
Drop the vendored Swagger UI 2.1.4 WAR overlay and its only consumer wiring in json-resource-examples. The stale third-party JS in the overlay was the source of most open CodeQL code-scanning alerts, including the sole error-level one (js/invalid-prototype-value).
vharseko
force-pushed
the
chore/remove-openapi-war-overlay
branch
from
July 22, 2026 13:56
39a9fcb to
72bad77
Compare
maximthomas
approved these changes
Jul 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Removes the
openapi-war-overlaymodule — a vendored copy of Swagger UI 2.1.4 (2016) checked directly into the tree. Its bundled third-party JS (handlebars-4.7.6.js,marked.js,swagger-oauth.js,swagger-ui.js, …) was the source of most open CodeQL code-scanning alerts, including the sole error-level one (js/invalid-prototype-value).The module's only consumer inside the repo was
json-resource-examples; no other module or ecosystem repo depends on it.Changes
commons/rest/openapi-war-overlay/module (49 files).commons/rest/pom.xml— drop the module from the reactor.json-resource-examples/pom.xml— remove theopenapi-war-overlaydependency and themaven-war-plugin<overlay>.json-resource-examples/web.xml— remove the/openapi/*DefaultServletmapping.CrestHttpApplication.java— remove the/docs/api→ Swagger UI redirect route, the "API explorer" landing link, and the now-unusedSWAGGER_JSON_ROUTEconstant /Urisimport. OpenAPI JSON (?_api), CREST descriptor (?_crestapi) and HTML docs remain..github/workflows/codeql.yml— remove the now-deadopenapi-war-overlay/**/swagger-ui.jsignore entry.Verification
mvn -o -pl commons/rest/json-resource-examples -am clean packagesucceeds. The resulting servlet WAR contains 0openapi/entries and 0openapi-war-overlayreferences — Swagger UI is no longer bundled and the example builds with no dangling links.Note
openapi-war-overlayis published asorg.openidentityplatform.commons:openapi-war-overlay. No local ecosystem repo consumes it, but any external downstream depending on the published WAR would need to vendor Swagger UI itself after this removal.