Skip to content

docs: fix broken OpenAPI spec links on Admin API page#7500

Merged
Zaimwa9 merged 1 commit into
mainfrom
docs/fix-admin-api-openapi-links
May 13, 2026
Merged

docs: fix broken OpenAPI spec links on Admin API page#7500
Zaimwa9 merged 1 commit into
mainfrom
docs/fix-admin-api-openapi-links

Conversation

@Holmus
Copy link
Copy Markdown
Contributor

@Holmus Holmus commented May 12, 2026

Summary

The Admin API docs page links to the OpenAPI spec in JSON and YAML, but both links 404.

Test plan

  • curl both new URLs returns 200 with application/vnd.oai.openapi+json and application/vnd.oai.openapi content types
  • curl the old URLs returns 404
  • Confirm rendered docs page links resolve after deploy

The JSON and YAML OpenAPI spec links on the Admin API page were 404ing
because `?format=.json` / `?format=.yaml` is not a valid query for the
Swagger UI endpoint. Point them at `/api/v1/swagger.json` and
`/api/v1/swagger.yaml`, which is what the Swagger UI itself loads.
@Holmus Holmus requested a review from a team as a code owner May 12, 2026 15:27
@Holmus Holmus requested review from adamvialpando and removed request for a team May 12, 2026 15:27
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 12, 2026 3:28pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
flagsmith-frontend-preview Ignored Ignored May 12, 2026 3:28pm
flagsmith-frontend-staging Ignored Ignored May 12, 2026 3:28pm

Request Review

@Zaimwa9 Zaimwa9 merged commit 94e4416 into main May 13, 2026
12 checks passed
@Zaimwa9 Zaimwa9 deleted the docs/fix-admin-api-openapi-links branch May 13, 2026 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants