docs: add API endpoint documentation#66
Conversation
WalkthroughThe README now includes an “API Endpoints” section documenting Authentication, Activities, and Dashboard routes with their HTTP methods and descriptions. ChangesAPI endpoint documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai please review this |
|
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 149-150: Update README.md formatting by adding a blank line
between the closing code fence and the “## API Endpoints” heading, and ensure
the file ends with exactly one trailing newline.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: alphaonelabs/coderabbit/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: aae12dce-635b-40f9-954e-4b8e4a79e30c
📒 Files selected for processing (1)
README.md
| ``` | ||
| ## API Endpoints |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the Markdown spacing and trailing newline.
Add a blank line between the closing code fence and ## API Endpoints, and ensure the file ends with exactly one newline so markdownlint passes.
Also applies to: 172-172
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 149-149: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 150-150: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 149 - 150, Update README.md formatting by adding a
blank line between the closing code fence and the “## API Endpoints” heading,
and ensure the file ends with exactly one trailing newline.
Source: Linters/SAST tools
2 participants
Summary
This PR adds API endpoint documentation to the README.
Changes
Motivation
The backend exposes several API routes through the Cloudflare Worker, but these routes were not documented in the README. This change improves onboarding for contributors and developers by providing a quick reference for commonly used endpoints.
Updated the README with an API Endpoints reference covering authentication, activity management, and dashboard routes. This improves developer onboarding and clarifies the backend endpoints exposed through the Cloudflare Worker without changing functionality.