145 lines
5.0 KiB
Markdown
145 lines
5.0 KiB
Markdown
---
|
|
name: discussions-routes
|
|
description: Handle 14 OpenAPI operation(s) under /api/v1/discussions for the discussions route group.
|
|
---
|
|
|
|
# discussions API Routes
|
|
|
|
Handle 14 OpenAPI operation(s) under /api/v1/discussions for the discussions 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
|
|
|
|
### api_get_discussion_labels_api_v1_discussions_labels_get
|
|
|
|
- Operation ID: `api_get_discussion_labels_api_v1_discussions_labels_get`
|
|
- Route: `GET /api/v1/discussions/labels`
|
|
- Mode: READ
|
|
- Summary: List discussion labels
|
|
|
|
### api_get_discussion_api_v1_discussions_discussion_uuid_get
|
|
|
|
- Operation ID: `api_get_discussion_api_v1_discussions_discussion_uuid_get`
|
|
- Route: `GET /api/v1/discussions/{discussion_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
|
|
### api_update_discussion_api_v1_discussions_discussion_uuid_put
|
|
|
|
- Operation ID: `api_update_discussion_api_v1_discussions_discussion_uuid_put`
|
|
- Route: `PUT /api/v1/discussions/{discussion_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Update a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_discussion_api_v1_discussions_discussion_uuid_delete
|
|
|
|
- Operation ID: `api_delete_discussion_api_v1_discussions_discussion_uuid_delete`
|
|
- Route: `DELETE /api/v1/discussions/{discussion_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
|
|
### api_pin_discussion_api_v1_discussions_discussion_uuid_pin_put
|
|
|
|
- Operation ID: `api_pin_discussion_api_v1_discussions_discussion_uuid_pin_put`
|
|
- Route: `PUT /api/v1/discussions/{discussion_uuid}/pin`
|
|
- Mode: WRITE
|
|
- Summary: Pin or unpin a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_lock_discussion_api_v1_discussions_discussion_uuid_lock_put
|
|
|
|
- Operation ID: `api_lock_discussion_api_v1_discussions_discussion_uuid_lock_put`
|
|
- Route: `PUT /api/v1/discussions/{discussion_uuid}/lock`
|
|
- Mode: WRITE
|
|
- Summary: Lock or unlock a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_upvote_discussion_api_v1_discussions_discussion_uuid_vote_post
|
|
|
|
- Operation ID: `api_upvote_discussion_api_v1_discussions_discussion_uuid_vote_post`
|
|
- Route: `POST /api/v1/discussions/{discussion_uuid}/vote`
|
|
- Mode: WRITE
|
|
- Summary: Upvote a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
|
|
### api_remove_upvote_api_v1_discussions_discussion_uuid_vote_delete
|
|
|
|
- Operation ID: `api_remove_upvote_api_v1_discussions_discussion_uuid_vote_delete`
|
|
- Route: `DELETE /api/v1/discussions/{discussion_uuid}/vote`
|
|
- Mode: WRITE
|
|
- Summary: Remove an upvote from a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
|
|
### api_get_user_votes_batch_api_v1_discussions_votes_batch_post
|
|
|
|
- Operation ID: `api_get_user_votes_batch_api_v1_discussions_votes_batch_post`
|
|
- Route: `POST /api/v1/discussions/votes/batch`
|
|
- Mode: WRITE
|
|
- Summary: Batch check user vote status
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_create_comment_api_v1_discussions_discussion_uuid_comments_post
|
|
|
|
- Operation ID: `api_create_comment_api_v1_discussions_discussion_uuid_comments_post`
|
|
- Route: `POST /api/v1/discussions/{discussion_uuid}/comments`
|
|
- Mode: WRITE
|
|
- Summary: Create a comment
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_comments_by_discussion_api_v1_discussions_discussion_uuid_comments_get
|
|
|
|
- Operation ID: `api_get_comments_by_discussion_api_v1_discussions_discussion_uuid_comments_get`
|
|
- Route: `GET /api/v1/discussions/{discussion_uuid}/comments`
|
|
- Mode: READ
|
|
- Summary: List comments for a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
- `page` in `query`
|
|
- `limit` in `query`
|
|
|
|
### api_get_comment_count_api_v1_discussions_discussion_uuid_comments_count_get
|
|
|
|
- Operation ID: `api_get_comment_count_api_v1_discussions_discussion_uuid_comments_count_get`
|
|
- Route: `GET /api/v1/discussions/{discussion_uuid}/comments/count`
|
|
- Mode: READ
|
|
- Summary: Get comment count for a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
|
|
### api_get_reactions_api_v1_discussions_discussion_uuid_reactions_get
|
|
|
|
- Operation ID: `api_get_reactions_api_v1_discussions_discussion_uuid_reactions_get`
|
|
- Route: `GET /api/v1/discussions/{discussion_uuid}/reactions`
|
|
- Mode: READ
|
|
- Summary: List reactions on a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
|
|
### api_toggle_reaction_api_v1_discussions_discussion_uuid_reactions_post
|
|
|
|
- Operation ID: `api_toggle_reaction_api_v1_discussions_discussion_uuid_reactions_post`
|
|
- Route: `POST /api/v1/discussions/{discussion_uuid}/reactions`
|
|
- Mode: WRITE
|
|
- Summary: Toggle a reaction on a discussion
|
|
- Parameters:
|
|
- `discussion_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|