Add Bitrise CI API reference hub (docusaurus-plugin-openapi-docs)#36
Open
zoltan-baba wants to merge 1 commit into
Open
Add Bitrise CI API reference hub (docusaurus-plugin-openapi-docs)#36zoltan-baba wants to merge 1 commit into
zoltan-baba wants to merge 1 commit into
Conversation
- Add docusaurus-plugin-openapi-docs + docusaurus-theme-openapi-docs packages - Commit API spec snapshot to api/bitrise-ci.json - Generate API reference output under docs/bitrise-api/api-reference/ - Add docs/bitrise-api/ hub index page and category - Wire bitriseAPISidebar in sidebars.ts with tag label normalisation and Code icons - Add Introduction entry (Book icon) to the top of bitriseAPISidebar - Add injectApiSidebar + sidebarItemsGenerator in docusaurus.config.ts to resolve appendApiHubLink markers - Append "API reference ↗" link to the CI API sidebar category via _category_.json - Remove old SwaggerUI API reference page (docs/bitrise-ci/api/api-reference.mdx) - Swizzle DocItem to route generated pages through ApiItem with api-reference-page HTML class - Swizzle DocSidebarItem/Link to show ↗ indicator for newTab links - Add CSS: full-width layout on API explorer pages; hide duplicate openapi heading - Add scripts/patch-api-info.js and npm run gen-api-docs to reapply post-generation patches - Patch bitrise-api.info.mdx: add displayed_sidebar and MIT license name Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
matenadasdi
approved these changes
Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/en/bitrise-apihub powered bydocusaurus-plugin-openapi-docs, rendering the full Bitrise CI REST API as interactive reference pages/en/bitrise-ci/api/api-reference) in favour of an "API reference ↗" link appended to the CI API sidebar categoryscripts/patch-api-info.jsandnpm run gen-api-docsto reapply post-generation patches (displayed_sidebar, MIT licence name) automatically after spec updatesTest plan
/en/bitrise-apihub index renders with the correct three-column layout/en/bitrise-api/api-reference/bitrise-apiIntroduction page shows the Bitrise API sidebar/en/bitrise-ci/api/api-referenceURL no longer exists (expect 404 or redirect)npm run gen-api-docsregenerates and patches cleanly🤖 Generated with Claude Code