Skip to content

Regenerate API docs from OpenAPI spec#49

Merged
bgelatti merged 3 commits intomainfrom
fixNameAuthorizationToken
Apr 6, 2026
Merged

Regenerate API docs from OpenAPI spec#49
bgelatti merged 3 commits intomainfrom
fixNameAuthorizationToken

Conversation

@bgelatti
Copy link
Copy Markdown
Collaborator

@bgelatti bgelatti commented Apr 6, 2026

Problem

The rendered API documentation page still showed authorization-token (with hyphens) despite the OpenAPI spec being updated to authorization_token. Manual edits to the MDX file didn't take effect because the plugin renders from a compressed frontmatter blob.

Investigation

The docusaurus-plugin-openapi-docs generates API pages from a compressed api field in the MDX frontmatter, not from the visible JSX components. Manually editing only the JSX had no effect on the rendered output.

Solution

Ran docusaurus clean-api-docs all and docusaurus gen-api-docs all to fully regenerate all API documentation from the corrected OpenAPI spec. This also updates the plugin's output format to use separate JSON files for params, request schemas, and status codes.

bgelatti added 2 commits April 6, 2026 10:25
Regenerate all API docs using docusaurus-plugin-openapi-docs to ensure
the authorization_token parameter fix is reflected in the rendered page.
@bgelatti bgelatti requested a review from felipefdl April 6, 2026 13:32
Apply consistent JSON formatting to all generated ParamsDetails,
RequestSchema, and StatusCodes JSON files.
@bgelatti bgelatti merged commit 4533821 into main Apr 6, 2026
1 check passed
@bgelatti bgelatti deleted the fixNameAuthorizationToken branch April 6, 2026 13:51
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