174 lines
5.6 KiB
Markdown
174 lines
5.6 KiB
Markdown
---
|
|
name: boards-routes
|
|
description: Handle 17 OpenAPI operation(s) under /api/v1/boards for the boards route group.
|
|
---
|
|
|
|
# boards API Routes
|
|
|
|
Handle 17 OpenAPI operation(s) under /api/v1/boards for the boards 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_create_board_api_v1_boards_post
|
|
|
|
- Operation ID: `api_create_board_api_v1_boards_post`
|
|
- Route: `POST /api/v1/boards/`
|
|
- Mode: WRITE
|
|
- Summary: Create a board
|
|
- Parameters:
|
|
- `org_id` in `query` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_boards_by_org_api_v1_boards_org_org_id_get
|
|
|
|
- Operation ID: `api_get_boards_by_org_api_v1_boards_org_org_id_get`
|
|
- Route: `GET /api/v1/boards/org/{org_id}`
|
|
- Mode: READ
|
|
- Summary: List boards for an organization
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
|
|
### iterate_boards_playground_session_api_v1_boards_playg_137e675816
|
|
|
|
- Operation ID: `iterate_boards_playground_session_api_v1_boards_playground_iterate_post`
|
|
- Route: `POST /api/v1/boards/playground/iterate`
|
|
- Mode: WRITE
|
|
- Summary: Iterate on a boards playground AI session
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_session_state_api_v1_boards_playground_session_se_8691c1af5e
|
|
|
|
- Operation ID: `get_session_state_api_v1_boards_playground_session_session_uuid_get`
|
|
- Route: `GET /api/v1/boards/playground/session/{session_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get boards playground session state
|
|
- Parameters:
|
|
- `session_uuid` in `path` required
|
|
|
|
### start_boards_playground_session_api_v1_boards_playgro_28273d0ef8
|
|
|
|
- Operation ID: `start_boards_playground_session_api_v1_boards_playground_start_post`
|
|
- Route: `POST /api/v1/boards/playground/start`
|
|
- Mode: WRITE
|
|
- Summary: Start a boards playground AI session
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_board_api_v1_boards_board_uuid_delete
|
|
|
|
- Operation ID: `api_delete_board_api_v1_boards_board_uuid_delete`
|
|
- Route: `DELETE /api/v1/boards/{board_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a board
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
|
|
### api_get_board_api_v1_boards_board_uuid_get
|
|
|
|
- Operation ID: `api_get_board_api_v1_boards_board_uuid_get`
|
|
- Route: `GET /api/v1/boards/{board_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get a board by UUID
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
|
|
### api_update_board_api_v1_boards_board_uuid_put
|
|
|
|
- Operation ID: `api_update_board_api_v1_boards_board_uuid_put`
|
|
- Route: `PUT /api/v1/boards/{board_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Update a board
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_duplicate_board_api_v1_boards_board_uuid_duplicate_post
|
|
|
|
- Operation ID: `api_duplicate_board_api_v1_boards_board_uuid_duplicate_post`
|
|
- Route: `POST /api/v1/boards/{board_uuid}/duplicate`
|
|
- Mode: WRITE
|
|
- Summary: Duplicate a board
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
|
|
### api_get_board_members_api_v1_boards_board_uuid_members_get
|
|
|
|
- Operation ID: `api_get_board_members_api_v1_boards_board_uuid_members_get`
|
|
- Route: `GET /api/v1/boards/{board_uuid}/members`
|
|
- Mode: READ
|
|
- Summary: List board members
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
|
|
### api_add_board_member_api_v1_boards_board_uuid_members_post
|
|
|
|
- Operation ID: `api_add_board_member_api_v1_boards_board_uuid_members_post`
|
|
- Route: `POST /api/v1/boards/{board_uuid}/members`
|
|
- Mode: WRITE
|
|
- Summary: Add a member to a board
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_add_board_members_batch_api_v1_boards_board_uuid_1d4ae75f5f
|
|
|
|
- Operation ID: `api_add_board_members_batch_api_v1_boards_board_uuid_members_batch_post`
|
|
- Route: `POST /api/v1/boards/{board_uuid}/members/batch`
|
|
- Mode: WRITE
|
|
- Summary: Add multiple members to a board
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_remove_board_member_api_v1_boards_board_uuid_memb_a9d2a6f7d9
|
|
|
|
- Operation ID: `api_remove_board_member_api_v1_boards_board_uuid_members_user_id_delete`
|
|
- Route: `DELETE /api/v1/boards/{board_uuid}/members/{user_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove a member from a board
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
- `user_id` in `path` required
|
|
|
|
### api_check_board_membership_api_v1_boards_board_uuid_m_91cf8b728e
|
|
|
|
- Operation ID: `api_check_board_membership_api_v1_boards_board_uuid_membership_get`
|
|
- Route: `GET /api/v1/boards/{board_uuid}/membership`
|
|
- Mode: READ
|
|
- Summary: Check current user's board membership
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
|
|
### api_update_board_thumbnail_api_v1_boards_board_uuid_t_3b07ba5733
|
|
|
|
- Operation ID: `api_update_board_thumbnail_api_v1_boards_board_uuid_thumbnail_post`
|
|
- Route: `POST /api/v1/boards/{board_uuid}/thumbnail`
|
|
- Mode: WRITE
|
|
- Summary: Upload a board thumbnail
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_ydoc_state_api_v1_boards_board_uuid_ydoc_get
|
|
|
|
- Operation ID: `api_get_ydoc_state_api_v1_boards_board_uuid_ydoc_get`
|
|
- Route: `GET /api/v1/boards/{board_uuid}/ydoc`
|
|
- Mode: READ
|
|
- Summary: Fetch the Yjs document state for a board
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
- `x-internal-key` in `header` required
|
|
|
|
### api_store_ydoc_state_api_v1_boards_board_uuid_ydoc_put
|
|
|
|
- Operation ID: `api_store_ydoc_state_api_v1_boards_board_uuid_ydoc_put`
|
|
- Route: `PUT /api/v1/boards/{board_uuid}/ydoc`
|
|
- Mode: WRITE
|
|
- Summary: Persist the Yjs document state for a board
|
|
- Parameters:
|
|
- `board_uuid` in `path` required
|
|
- `x-internal-key` in `header` required
|