Skip to content

Document OpenAPI HTTP endpoint serving#3188

Open
pwizla wants to merge 1 commit into
mainfrom
cms/add-openapi-http-endpoint-docs
Open

Document OpenAPI HTTP endpoint serving#3188
pwizla wants to merge 1 commit into
mainfrom
cms/add-openapi-http-endpoint-docs

Conversation

@pwizla
Copy link
Copy Markdown
Collaborator

@pwizla pwizla commented May 19, 2026

Adds documentation for the new server.openapi configuration that lets Strapi serve generated OpenAPI specs over HTTP endpoints. Based on the strapi/strapi PR that adds registerOpenAPIRoute to @strapi/core.

Changes:

  • cms/api/openapi.md: new "Serving the specification over HTTP" section with configuration example, options table, and access control docs. Added tip in Swagger UI section referencing the live endpoint as an alternative to static file generation.
  • cms/configurations/server.md: added 16 openapi.* parameter rows to the options table and openapi block to the full configuration example.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 19, 2026

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

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview, Comment May 19, 2026 10:47am

Request Review

@github-actions github-actions Bot added internal PRs created by the Strapi core team pr: updated content PRs updating existing documentation content source: CMS labels May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team pr: updated content PRs updating existing documentation content source: CMS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant