feat: migrate OpenAPI documentation from Swagger to Scalar with custom theme#137
Merged
JacobCoffee merged 1 commit intomainfrom Nov 24, 2025
Merged
Conversation
…m theme - Replace Swagger UI with Scalar as default OpenAPI documentation interface - Create custom Scalar theme using Byte brand colors (teal #42b1a8, blue #7bcebc) - Implement light and dark mode support in custom theme CSS - Serve custom CSS as static file at /static/css/scalar-theme.css - Keep Swagger UI available as fallback at /api/swagger - Update OpenAPI config to use render_plugins instead of root_schema_site - Update tests to verify Scalar and Swagger plugin configuration - Update documentation (RST, CLAUDE.md, README.md) with new endpoints Endpoints: - /api/scalar - Scalar UI (default, modern interface) - /api/swagger - Swagger UI (fallback) - /api/openapi.json - OpenAPI schema 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Sorry @JacobCoffee, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
|
🚅 Environment byte-pr-137 in byte has no services deployed. |
|
Documentation preview will be available shortly at https://jacobcoffee.github.io/byte-docs-preview/137 |
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
1 participant
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
Migrates the Byte Bot API documentation from Swagger UI to Scalar as the default OpenAPI documentation interface, with a custom theme using Byte brand colors.
Key Changes
/api/swagger/static/css/scalar-theme.cssEndpoints
/api/scalar/api/swagger/api/api/openapi.jsonBrand Colors Applied
#42b1a8(Byte Teal)#7bcebc(Byte Blue)#abe6d2(Byte Light Blue)#059669#d4a35a(Byte Orange)#fc7054(Byte Red)Files Changed
New Files:
services/api/src/byte_api/lib/scalar_theme.py- Scalar plugin factoryservices/api/src/byte_api/domain/web/resources/css/scalar-theme.css- Custom theme CSSModified Files:
services/api/src/byte_api/lib/openapi.py- Updated to use render_pluginstests/unit/api/test_openapi.py- Updated tests for new plugin systemdocs/web/api/lib/openapi.rst- Added Scalar documentationCLAUDE.md- Updated API docs URLsREADME.md- Updated quick start guideTest Plan
Screenshots
Note: Screenshots can be added after deployment to show the custom theme in action
Breaking Changes
None - Swagger UI remains available as a fallback at
/api/swaggerMigration Notes
/api/swagger🤖 Generated with Claude Code