Skip to content

Fix broken swagger-ui doc links (CIT-5067) - #36

Merged
matt-raffel-kiva merged 2 commits into
mainfrom
fix-partner-api-swagger-ui-links
Aug 26, 2026
Merged

matt-raffel-kiva merged 2 commits into
mainfrom
fix-partner-api-swagger-ui-links

Conversation

@matt-raffel-kiva

Copy link
Copy Markdown
Contributor

Summary

  • The bare /swagger-ui/ path returns a Spring Whitelabel Error Page (404) on both staging and production — the app has no welcome-file mapping for that path; /swagger-ui/index.html works.
  • Updates all swagger-ui links (docs, i18n translations, docusaurus nav config, sample READMEs) to point at swagger-ui/index.html, preserving any #anchor fragments.
  • Supersedes the earlier direct-to-main commits (639fa1e, 9ee26b6, 3325bd2), which were reverted because they bypassed the required-PR branch protection and the Firebase deploy workflow never ran for them.

Test plan

  • Confirm the PR preview-deploy workflow succeeds and spot-check a few links on the preview URL
  • Merge to trigger the live deploy and confirm https://fps-sdk-portal.web.app/ picks up the fix

Jira: https://kiva.atlassian.net/browse/CIT-5067

The bare /swagger-ui/ path 404s (Spring Whitelabel Error Page) on
both staging and production - the app has no welcome-file mapping
for that path. /swagger-ui/index.html works. Fixes all bare links
across the English docs, fr/es translations, the docusaurus nav
config, and the two sample READMEs that also referenced it.

Signed-off-by: Matt Raffel <mattr@kiva.org>
Direct pushes to main bypass required review and were observed to
not reliably trigger the merge-deploy GitHub Actions workflow (see
CIT-5067) - the change lands on main but never actually goes live.
Documents the real publish flow (branch -> PR -> preview check ->
merge) in portal/README.md, with a pointer from the root README.

Signed-off-by: Matt Raffel <mattr@kiva.org>
@matt-raffel-kiva
matt-raffel-kiva merged commit b308ff6 into main Aug 26, 2026
@matt-raffel-kiva
matt-raffel-kiva deleted the fix-partner-api-swagger-ui-links branch August 26, 2026 16:29
@github-actions

github-actions Bot commented Aug 26, 2026 •

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit badeb62):

https://fps-sdk-portal--pr36-fix-partner-api-swag-d5biabjp.web.app

(expires Wed, 02 Sep 2026 16:42:25 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 7129e37bc287154f12cd4086153fb872043ac1fe

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