Skip to content

docs: add Scalar API reference page #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sachiniyer merged 1 commit into from
Mar 11, 2026
Merged

docs: add Scalar API reference page #173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/api/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Detail API Reference</title>
</head>
<body>
<div id="app"></div>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
<script>
Scalar.createApiReference("#app", {
url: "./openapi.json",
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 Relative URL ./openapi.json points to non-existent file in docs/api/

The Scalar API reference is configured with url: "./openapi.json", which resolves relative to the HTML file's location (docs/api/). However, no openapi.json exists in docs/api/ — the only openapi.json in the repository is at the repo root (openapi.json). When this page is served, the fetch for the OpenAPI spec will 404 and the API reference will fail to render. The URL should likely be ../../openapi.json or the openapi.json file should be copied/symlinked into docs/api/.

Prompt for agents 
In docs/api/index.html at line 13, the relative URL ./openapi.json resolves to docs/api/openapi.json, but the actual openapi.json file is at the repository root. Either:
1. Change the URL on line 13 to ../../openapi.json (i.e. url: "../../openapi.json") to point to the repo-root file, OR
2. Copy or symlink openapi.json into docs/api/, OR
3. Move or adjust the hosting so that openapi.json is served alongside this HTML file.
The correct fix depends on how docs/api/ is deployed (e.g. GitHub Pages, a static server, etc.).
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

agent: { disabled: true },
hideClientButton: true,
});
</script>
</body>
</html>
Loading