docs: add Scalar API reference page#177
Merged
sachiniyer merged 1 commit intomainfrom Mar 11, 2026
Merged
Conversation
Add a static HTML page that renders the OpenAPI spec using Scalar's CDN-hosted API reference component. AI agent and client button are disabled for a clean, focused documentation experience. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script> | ||
| <script> | ||
| Scalar.createApiReference("#app", { | ||
| url: "./openapi.json", |
Contributor
There was a problem hiding this comment.
🔴 Relative URL ./openapi.json resolves to non-existent docs/api/openapi.json
The url property in the Scalar configuration is set to "./openapi.json", which resolves relative to the HTML file's location (docs/api/). However, openapi.json only exists at the repository root (openapi.json), not at docs/api/openapi.json. This means the API reference page will fail to load the OpenAPI spec, resulting in a broken/empty documentation page.
Suggested change
| url: "./openapi.json", | |
| url: "../../openapi.json", |
Was this helpful? React with 👍 or 👎 to provide feedback.
sachiniyer
added a commit
that referenced
this pull request
Mar 12, 2026
## Summary - Bumps version from 0.1.10 to 0.1.11 - The release workflow will auto-tag and build artifacts when merged to main ### Changes since v0.1.10 **Features:** - Add shell tab completion via clap_complete (#182) - Add --scan-id flag to bugs list command (#184) - Add scans list command (#163) - Add scans to the skill.md for the detail CLI (#185) - Auto-detect repository in detail-bugs skill (#160) **Fixes:** - Show user-friendly error messages instead of debug output (#129) - Continue list numbering across pages instead of resetting (#130) - Add file locking to prevent concurrent config overwrites (#131) **Chores & Refactoring:** - Replace Makefile with cargo xtask (#159) - Upgrade all dependencies to latest versions (#158) - Enable comprehensive clippy lints (pedantic, nursery, restriction) (#134, #135, #144, #152, #153, #154, #155) - Add GitHub Pages workflow for API docs (#178) - Add Scalar API reference page (#177) - Add integration tests against live API (#181) - Remove alpha warning from README (#156) Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
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.
Add a static HTML page that renders the OpenAPI spec using Scalar's
CDN-hosted API reference component. AI agent and client button are
disabled for a clean, focused documentation experience.
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com