Skip to content

feat: add API versioning and v1 route documentation #1164

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
joelpeace48-cell merged 2 commits into from
Aug 31, 2026
Merged

feat: add API versioning and v1 route documentation #1164

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f8f076
feat: add API versioning and v1 route documentation
ACOB-DEV Aug 31, 2026
82a8f3e
Merge branch 'main' into feat/api-v1-versioning
joelpeace48-cell Aug 31, 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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,19 @@ cp backend/.env.example backend/.env
npm run dev:backend
```

API: http://localhost:3001 (health: http://localhost:3001/health, v1 endpoints: http://localhost:3001/api/v1).

#### API Endpoints & Versioning

All API routes are served under the versioned `/api/v1/` prefix:
- `GET /api/v1/` — API metadata and version information
- `GET /api/v1/campaigns` — List all campaigns
- `GET /api/v1/campaigns/:id` — Get campaign details by ID
- `POST /api/v1/campaigns` — Create a new campaign (requires API key)
- `PUT /api/v1/campaigns/:id` — Update a campaign (requires API key)
- `DELETE /api/v1/campaigns/:id` — Delete a campaign (requires API key)

> **Migration Note**: Legacy `/api/*` endpoints remain supported for backward compatibility, but developers are encouraged to use `/api/v1/*` for all new integrations.
#### Backend Endpoints

| Service | URL |
Expand Down
Loading