Skip to content

ci: add GitHub Pages workflow for API docs #174

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

Closed
sachiniyer wants to merge 3 commits into from
Closed

ci: add GitHub Pages workflow for API docs #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8398f5
chore: sync openapi.json and update quinn-proto
sachiniyer Mar 11, 2026
aab5493
docs: add Scalar API reference page
sachiniyer Mar 11, 2026
e5f024a
ci: add GitHub Pages workflow for API docs
sachiniyer Mar 11, 2026
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
Empty file added .github/workflows/api-docs.yml
View file
Open in desktop
Empty file.
5 changes: 3 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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.

🔴 Incorrect relative path to openapi.json — file is at repo root, not in docs/api/

The HTML page at docs/api/index.html references ./openapi.json (line 13), which resolves to docs/api/openapi.json. However, the actual openapi.json lives at the repository root (openapi.json), as confirmed by xtask/src/main.rs:5 (const OPENAPI_PATH: &str = "openapi.json"). Since there is no build step that copies the file into docs/api/ (the workflow file is empty), this reference will 404 at runtime and the Scalar API reference page will fail to load any spec.

Prompt for agents 
The url in docs/api/index.html line 13 is set to "./openapi.json" but the openapi.json file lives at the repository root. Either:
1. Change the relative path to "../../openapi.json" to point to the repo root, OR
2. Add a build/deploy step in the (currently empty) .github/workflows/api-docs.yml that copies openapi.json into docs/api/ before deployment, OR
3. Use an absolute URL (e.g. the upstream https://api.detail.dev/public/v1/openapi.json).

Option 2 is likely intended since the workflow file was supposed to handle deployment.
Open in Devin Review

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

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