Skip to content

chore(docs): Automate API docs, replace stale ReDoc bundle - #642

Merged
jasonmcintosh merged 1 commit into
spinnaker:masterfrom
jasonmcintosh:fixApiDocs
Aug 13, 2026
Merged

chore(docs): Automate API docs, replace stale ReDoc bundle#642
jasonmcintosh merged 1 commit into
spinnaker:masterfrom
jasonmcintosh:fixApiDocs

Conversation

@jasonmcintosh

Copy link
Copy Markdown
Member

Replace the manually-bundled, long-stale docs.html (last regenerated by hand, no automation) with a thin ReDoc loader that reads swagger.json via spec-url. This means the HTML never needs to be touched again - only swagger.json, which the Spinnaker release automation (spinnaker/spinnaker's spinnaker-release action) now publishes here automatically on each release.

Also seeds swagger.json with a current Gate OpenAPI spec, and works around a known ReDoc CDN bundle bug (process is not defined in the browser - Redocly/redoc#2323) with a small process polyfill.

Replace the manually-bundled, long-stale docs.html (last regenerated
by hand, no automation) with a thin ReDoc loader that reads
swagger.json via spec-url. This means the HTML never needs to be
touched again - only swagger.json, which the Spinnaker release
automation (spinnaker/spinnaker's spinnaker-release action) now
publishes here automatically on each release.

Also seeds swagger.json with a current Gate OpenAPI spec, and works
around a known ReDoc CDN bundle bug (process is not defined in the
browser - Redocly/redoc#2323) with a small process polyfill.
@christosarvanitis
christosarvanitis self-requested a review August 13, 2026 14:27
@mergify

mergify Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@jasonmcintosh
jasonmcintosh merged commit 8b2b69a into spinnaker:master Aug 13, 2026
6 checks passed
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.

2 participants