92 lines
2.6 KiB
Markdown
92 lines
2.6 KiB
Markdown
---
|
|
name: notifications-routes
|
|
description: Handle 8 OpenAPI operation(s) under /notifications for the notifications route group.
|
|
---
|
|
|
|
# notifications API Routes
|
|
|
|
Handle 8 OpenAPI operation(s) under /notifications for the notifications route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### activity_list_notifications_for_authenticated_user
|
|
|
|
- Operation ID: `activity_list_notifications_for_authenticated_user`
|
|
- Route: `GET /notifications`
|
|
- Mode: READ
|
|
- Summary: List notifications for the authenticated user
|
|
- Parameters:
|
|
- `all` in `query`
|
|
- `participating` in `query`
|
|
- `since` in `query`
|
|
- `before` in `query`
|
|
- `page` in `query`
|
|
- `per_page` in `query`
|
|
|
|
### activity_mark_notifications_as_read
|
|
|
|
- Operation ID: `activity_mark_notifications_as_read`
|
|
- Route: `PUT /notifications`
|
|
- Mode: WRITE
|
|
- Summary: Mark notifications as read
|
|
- Body: JSON request body accepted.
|
|
|
|
### activity_get_thread
|
|
|
|
- Operation ID: `activity_get_thread`
|
|
- Route: `GET /notifications/threads/{thread_id}`
|
|
- Mode: READ
|
|
- Summary: Get a thread
|
|
- Parameters:
|
|
- `thread_id` in `path` required
|
|
|
|
### activity_mark_thread_as_read
|
|
|
|
- Operation ID: `activity_mark_thread_as_read`
|
|
- Route: `PATCH /notifications/threads/{thread_id}`
|
|
- Mode: WRITE
|
|
- Summary: Mark a thread as read
|
|
- Parameters:
|
|
- `thread_id` in `path` required
|
|
|
|
### activity_mark_thread_as_done
|
|
|
|
- Operation ID: `activity_mark_thread_as_done`
|
|
- Route: `DELETE /notifications/threads/{thread_id}`
|
|
- Mode: WRITE
|
|
- Summary: Mark a thread as done
|
|
- Parameters:
|
|
- `thread_id` in `path` required
|
|
|
|
### activity_get_thread_subscription_for_authenticated_user
|
|
|
|
- Operation ID: `activity_get_thread_subscription_for_authenticated_user`
|
|
- Route: `GET /notifications/threads/{thread_id}/subscription`
|
|
- Mode: READ
|
|
- Summary: Get a thread subscription for the authenticated user
|
|
- Parameters:
|
|
- `thread_id` in `path` required
|
|
|
|
### activity_set_thread_subscription
|
|
|
|
- Operation ID: `activity_set_thread_subscription`
|
|
- Route: `PUT /notifications/threads/{thread_id}/subscription`
|
|
- Mode: WRITE
|
|
- Summary: Set a thread subscription
|
|
- Parameters:
|
|
- `thread_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### activity_delete_thread_subscription
|
|
|
|
- Operation ID: `activity_delete_thread_subscription`
|
|
- Route: `DELETE /notifications/threads/{thread_id}/subscription`
|
|
- Mode: WRITE
|
|
- Summary: Delete a thread subscription
|
|
- Parameters:
|
|
- `thread_id` in `path` required
|