Skip to content

IGDD-3084: consume izgw-core's auto-detected swagger-ui version, drop the stale yaml pin - #185

Open
tmy1313 wants to merge 3 commits into
developfrom
IGDD-3084_swagger_ui_version_sync
Open

IGDD-3084: consume izgw-core's auto-detected swagger-ui version, drop the stale yaml pin#185
tmy1313 wants to merge 3 commits into
developfrom
IGDD-3084_swagger_ui_version_sync

Conversation

@tmy1313

@tmy1313 tmy1313 commented Aug 28, 2026

Copy link
Copy Markdown

Summary

  • application.yml hand-pinned springdoc.swagger-ui.version: 5.32.13, but izgw-bom independently bumps org.webjars:swagger-ui on its own nightly schedule, so the pin drifted (actual resolved version: 5.32.14) and /swagger/ui.html / /swagger/swagger-ui/index.html 404'd.
  • Consumes the fix from izgw-core (IGDD-3084: auto-detect swagger-ui webjar version instead of hand-pinning it izgw-core#95): a BeanPostProcessor that detects the real webjar version on the classpath at startup and overrides Springdoc's config with it, so there's no longer a second value to keep in sync. Removes the stale yaml pin entirely.
  • Adds SwaggerUiVersionIntegrationTests to prove Hub's own application context actually inherits the fix via component scan (not just that the mechanism exists in izgw-core).
  • Full OpenSpec change doc at openspec/changes/igdd-3084-swagger-ui-version-sync/ (proposal, design, tasks, capability spec).

Depends on IZGateway/izgw-core#95 — this PR's pom.xml already points at that PR's published SNAPSHOT (3.6.0-IGDD-3084_swagger_ui_version_sync-SNAPSHOT), verified to resolve from GitHub Packages.

Unrelated to the Spring Boot 4 migration (IGDD-2353) — same root cause and fix regardless of Spring Boot version; git history shows this exact drift-and-repatch cycle recurring since May, months before that migration branch existed.

Test plan

  • mvn clean test — 174 tests, 0 failures, 0 errors, BUILD SUCCESS (verified against the real published izgw-core artifact, not a local build)
  • SwaggerUiVersionIntegrationTests passes; startup log confirms Detected swagger-ui webjar version: 5.32.14
  • Manual end-to-end: TC_92a Get Documentation and TC_92b Get Api Document (Postman, via newman with a real client cert) both return 200
  • CI build/OWASP check on this PR

… the stale yaml pin

application.yml hand-pinned springdoc.swagger-ui.version to a literal that
had to be manually re-edited every time izgw-bom's nightly job bumped
org.webjars:swagger-ui, and it wasn't happening reliably -- the pin had
already drifted (5.32.13 pinned vs. 5.32.14 actually resolved), and
/swagger/ui.html was 404ing.

izgw-core now detects the real webjar version at startup instead, so the
pin is removed entirely. Added SwaggerUiVersionIntegrationTests to prove
Hub's own application context actually inherits the fix via component
scan, not just that the mechanism exists in izgw-core.
…ange

docs/superpowers/{plans,specs}/*.md were working notes generated while
drafting this change; the OpenSpec proposal/design docs already carry the
same content in this repo's own convention, so the separate copies were
redundant. Updated the two dangling references accordingly.
Code review correctly flagged that the documented test/verification trail
(174 tests, TC_92a/TC_92b) ran against izgw-core:3.5.1-IGDD-2353_spring_upgrade-SNAPSHOT,
not the 3.6.0-IGDD-3084_swagger_ui_version_sync-SNAPSHOT actually committed
in pom.xml -- a leftover from before the branch-placement move. Cleared the
local .m2 cache for that exact coordinate, forced a fresh fetch from
GitHub Packages (now that the izgw-core PR has published it), and reran the
full suite against it: 174 tests, 0 failures, BUILD SUCCESS. tasks.md
updated to document this accurately instead of the stale trail.
@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant