Skip to content

docs: add API endpoint documentation #66

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

Open
jayati04 wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −1
Open

docs: add API endpoint documentation #66

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
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,27 @@ Frontend Server will start at:

```bash
http://localhost:3000
```
```
## API Endpoints
Comment on lines +149 to +150

@coderabbitai coderabbitai Bot Jul 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 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


### Authentication

| Method | Endpoint | Description |
|----------|----------|-------------|
| POST | /api/register | Register a new user |
| POST | /api/login | Authenticate and return token |

### Activities

| Method | Endpoint | Description |
|----------|----------|-------------|
| GET | /api/activities | List activities |
| POST | /api/activities | Create activity |
| GET | /api/activities/:id | Get activity details |
| POST | /api/join | Join activity |

### Dashboard

| Method | Endpoint | Description |
|----------|----------|-------------|
| GET | /api/dashboard | User dashboard |