Skip to content

fix(docs): bump openapi docs packages to 5.0.2#3027

Merged
0xSysR3ll merged 1 commit into
developfrom
0xsysr3ll/fix/docusaurus-openapi-docs
May 13, 2026
Merged

fix(docs): bump openapi docs packages to 5.0.2#3027
0xSysR3ll merged 1 commit into
developfrom
0xsysr3ll/fix/docusaurus-openapi-docs

Conversation

@0xSysR3ll
Copy link
Copy Markdown
Contributor

@0xSysR3ll 0xSysR3ll commented May 13, 2026

Description

This PR fixes a webpack render issue with the Docusaurus + OpenAPI docs setup by upgrading docusaurus-plugin-openapi-docs and docusaurus-theme-openapi-docs to 5.0.2.

Also fixed the gen-api-docs pnpm command as it was missing the id argument.

How Has This Been Tested?

pnpm gen-api-docs
pnpm serve

Open API docs render properly.

Screenshots / Logs (if applicable)

Before

image

After

image

Checklist:

  • I have read and followed the contribution guidelines.
  • Disclosed any use of AI (see our policy)
  • I have updated the documentation accordingly.
  • All new and existing tests passed.
  • Successful build pnpm build
  • Translation keys pnpm i18n:extract
  • Database migration (if required)

Summary by CodeRabbit

  • Chores
    • Updated API documentation generation dependencies to patch version 5.0.2.
    • Refined API documentation generation configuration for improved consistency.

Review Change Stack

@0xSysR3ll 0xSysR3ll requested a review from a team as a code owner May 13, 2026 20:58
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d895a2e2-007c-411e-bcf8-1c9a5d6c159a

📥 Commits

Reviewing files that changed from the base of the PR and between 8759263 and 06026c9.

⛔ Files ignored due to path filters (1)
  • gen-docs/pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (1)
  • gen-docs/package.json

📝 Walkthrough

Walkthrough

The gen-docs/package.json is updated to add the all argument to the gen-api-docs npm script and bump docusaurus-plugin-openapi-docs and docusaurus-theme-openapi-docs from ^5.0.1 to 5.0.2.

Changes

Docusaurus API docs generation update

Layer / File(s) Summary
Script and dependency updates
gen-docs/package.json
The gen-api-docs script now invokes docusaurus gen-api-docs all for scoped generation, and supporting OpenAPI plugin and theme dependencies are updated to version 5.0.2.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • seerr-team/seerr#2981: Both PRs modify the Docusaurus OpenAPI doc generation setup in gen-docs/package.json, including the gen-api-docs script invocation and related OpenAPI tooling configuration.

Suggested reviewers

  • gauthier-th

Poem

🐰 A script now speaks with scoping clear,
Saying "generate all" far and near!
Dependencies bumped, a tidy affair,
OpenAPI docs flow everywhere! 📚✨

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: bumping OpenAPI docs packages to version 5.0.2, which is the primary objective and the most significant change in the changeset.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@seerr-automation-bot seerr-automation-bot added this to the v3.3.0 milestone May 13, 2026
@0xSysR3ll 0xSysR3ll merged commit 080c68a into develop May 13, 2026
19 checks passed
@0xSysR3ll 0xSysR3ll deleted the 0xsysr3ll/fix/docusaurus-openapi-docs branch May 13, 2026 21:53
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.

4 participants