Skip to content

docs: add API endpoint documentation#66

Open
jayati04 wants to merge 1 commit into
alphaonelabs:mainfrom
jayati04:docs/api-endpoints
Open

docs: add API endpoint documentation#66
jayati04 wants to merge 1 commit into
alphaonelabs:mainfrom
jayati04:docs/api-endpoints

Conversation

@jayati04

@jayati04 jayati04 commented Jun 9, 2026

Copy link
Copy Markdown

Summary

This PR adds API endpoint documentation to the README.

Changes

  • Added authentication endpoint documentation
  • Added activity management endpoint documentation
  • Added dashboard endpoint documentation

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.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@jayati04, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 27 minutes and 44 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: alphaonelabs/coderabbit/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: bc57b783-a14c-4d91-986a-25117c0d61b3

📥 Commits

Reviewing files that changed from the base of the PR and between 997b01e and 838843e.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant