Skip to content

Commit face55f

Browse files
committed
wip(web): vendor swagger-ui 5.32.11 to render the OpenAPI 3.1 spec
1 parent 85ef244 commit face55f

4 files changed

Lines changed: 17 additions & 9 deletions

File tree

‎web/SITES_MERGE_PLAYBOOK.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -493,10 +493,13 @@ built the spec URL as `BaseURL + "/sg-swagger.yaml"`, which yields the
493493
protocol-relative `//sg-swagger.yaml` when baseURL is `/` (artifact preview) —
494494
now `relURL`, correct for every baseURL shape.
495495

496-
Found while verifying, NOT fixed here: the vendored swagger-ui is a 3.x-era
497-
build and rejects the operator's OpenAPI **3.1** spec ("Unable to render this
496+
Found while verifying: the theme's vendored swagger-ui is a 3.x-era build and
497+
rejects the operator's OpenAPI **3.1** spec ("Unable to render this
498498
definition") — **the live stackgres.io API reference page is broken the same
499-
way**. Fix = vendor swagger-ui v5 (supports 3.1). Recorded under known gaps.
499+
way**. Fixed by vendoring swagger-ui **5.32.11** as project static overrides
500+
(`static/js/swagger-ui-bundle.js`, `static/js/swagger-ui-standalone-preset.js`,
501+
`static/css/swagger-ui.css` — shadowing the theme copies; the shortcode init
502+
API is unchanged in v5). The API reference renders fully again.
500503

501504
## Verified
502505

@@ -539,11 +542,9 @@ way**. Fix = vendor swagger-ui v5 (supports 3.1). Recorded under known gaps.
539542
that only resolve via the live site's redirect-to-docs-home fallback.
540543
Converting them to `relurl`/markdown links is a mechanical follow-up pass.
541544
- **RSS/sitemap dedup** between the three sections was not reviewed.
542-
- **Operator API reference doesn't render** (pre-existing, also broken on
543-
live stackgres.io): the operator's swagger is OpenAPI 3.1, the vendored
544-
swagger-ui bundle only supports ≤3.0. Upgrade to swagger-ui v5 (drop-in:
545-
`swagger-ui-bundle.js`, `swagger-ui-standalone-preset.js`,
546-
`swagger-ui.css` as project static overrides; the shortcode API is
547-
unchanged in v5).
545+
- ~~**Operator API reference doesn't render**~~ — closed in step 24:
546+
swagger-ui upgraded to 5.32.11 (project static overrides), renders the
547+
operator's OpenAPI 3.1 spec. Note the live standalone site remains broken
548+
until this merges.
548549
- **CI/deploy.** Each source repo had its own pipeline; the umbrella needs one
549550
(build + link-check + deploy).

‎web/static/css/swagger-ui.css‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎web/static/js/swagger-ui-bundle.js‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎web/static/js/swagger-ui-standalone-preset.js‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)