docs updated v1.2.0
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
# API Endpoints Reference
|
||||
|
||||
**Last Verified:** December 25, 2025
|
||||
**Last Verified:** December 27, 2025
|
||||
**Version:** 1.2.0
|
||||
**Base URL:** `/api/v1/`
|
||||
**Documentation:** `/api/docs/` (Swagger) | `/api/redoc/` (ReDoc)
|
||||
|
||||
@@ -151,6 +152,54 @@ All endpoints require authentication unless noted.
|
||||
|
||||
---
|
||||
|
||||
## Notification Endpoints (`/api/v1/notifications/`) - v1.2.0
|
||||
|
||||
| Method | Path | Handler | Purpose |
|
||||
|--------|------|---------|---------|
|
||||
| GET | `/` | `NotificationViewSet.list` | List notifications (paginated) |
|
||||
| GET | `/{id}/` | `NotificationViewSet.retrieve` | Get notification detail |
|
||||
| DELETE | `/{id}/` | `NotificationViewSet.destroy` | Delete notification |
|
||||
| POST | `/{id}/read/` | `NotificationViewSet.read` | Mark single notification as read |
|
||||
| POST | `/read-all/` | `NotificationViewSet.read_all` | Mark all notifications as read |
|
||||
| GET | `/unread-count/` | `NotificationViewSet.unread_count` | Get unread notification count |
|
||||
|
||||
**Query Parameters:**
|
||||
- `?page=` - Page number for pagination
|
||||
- `?page_size=` - Results per page (default 20)
|
||||
- `?is_read=` - Filter by read status (true/false)
|
||||
- `?notification_type=` - Filter by type (ai_task, system, credit, billing, integration, content, info)
|
||||
|
||||
**Notification Types:**
|
||||
- `ai_cluster_complete`, `ai_cluster_failed` - Clustering operations
|
||||
- `ai_ideas_complete`, `ai_ideas_failed` - Idea generation
|
||||
- `ai_content_complete`, `ai_content_failed` - Content generation
|
||||
- `ai_images_complete`, `ai_images_failed` - Image generation
|
||||
- `ai_prompts_complete`, `ai_prompts_failed` - Image prompt generation
|
||||
- `content_ready_review`, `content_published`, `content_publish_failed` - Workflow
|
||||
- `wordpress_sync_success`, `wordpress_sync_failed` - WordPress sync
|
||||
- `credits_low`, `credits_depleted` - Billing alerts
|
||||
- `site_setup_complete`, `keywords_imported` - Setup
|
||||
- `system_info` - System notifications
|
||||
|
||||
**Response Format:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"notification_type": "ai_content_complete",
|
||||
"severity": "success",
|
||||
"title": "Content Generated",
|
||||
"message": "Generated 5 articles successfully",
|
||||
"is_read": false,
|
||||
"created_at": "2025-12-27T12:00:00Z",
|
||||
"read_at": null,
|
||||
"action_label": "View Content",
|
||||
"action_url": "/writer/content",
|
||||
"metadata": {"count": 5, "credits": 250}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Automation Endpoints (`/api/v1/automation/`)
|
||||
|
||||
| Method | Path | Handler | Purpose |
|
||||
|
||||
Reference in New Issue
Block a user