154 lines
5.6 KiB
Markdown
154 lines
5.6 KiB
Markdown
---
|
|
name: playgrounds-routes
|
|
description: Handle 15 OpenAPI operation(s) under /api/v1/playgrounds for the playgrounds route group.
|
|
---
|
|
|
|
# playgrounds API Routes
|
|
|
|
Handle 15 OpenAPI operation(s) under /api/v1/playgrounds for the playgrounds 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_playground_api_v1_playgrounds_post
|
|
|
|
- Operation ID: `api_create_playground_api_v1_playgrounds_post`
|
|
- Route: `POST /api/v1/playgrounds/`
|
|
- Mode: WRITE
|
|
- Summary: Create a playground
|
|
- Parameters:
|
|
- `org_id` in `query` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_list_org_playgrounds_api_v1_playgrounds_org_org_id_get
|
|
|
|
- Operation ID: `api_list_org_playgrounds_api_v1_playgrounds_org_org_id_get`
|
|
- Route: `GET /api/v1/playgrounds/org/{org_id}`
|
|
- Mode: READ
|
|
- Summary: List playgrounds for an organization
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
|
|
### api_get_playground_api_v1_playgrounds_playground_uuid_get
|
|
|
|
- Operation ID: `api_get_playground_api_v1_playgrounds_playground_uuid_get`
|
|
- Route: `GET /api/v1/playgrounds/{playground_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get a playground by UUID
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
|
|
### api_update_playground_api_v1_playgrounds_playground_uuid_put
|
|
|
|
- Operation ID: `api_update_playground_api_v1_playgrounds_playground_uuid_put`
|
|
- Route: `PUT /api/v1/playgrounds/{playground_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Update a playground
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_playground_api_v1_playgrounds_playground_uuid_delete
|
|
|
|
- Operation ID: `api_delete_playground_api_v1_playgrounds_playground_uuid_delete`
|
|
- Route: `DELETE /api/v1/playgrounds/{playground_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a playground
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
|
|
### api_duplicate_playground_api_v1_playgrounds_playground_uuid_duplicate_post
|
|
|
|
- Operation ID: `api_duplicate_playground_api_v1_playgrounds_playground_uuid_duplicate_post`
|
|
- Route: `POST /api/v1/playgrounds/{playground_uuid}/duplicate`
|
|
- Mode: WRITE
|
|
- Summary: Duplicate a playground
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
|
|
### api_update_playground_thumbnail_api_v1_playgrounds_playground_uuid_thumbnail_pos
|
|
|
|
- Operation ID: `api_update_playground_thumbnail_api_v1_playgrounds_playground_uuid_thumbnail_pos`
|
|
- Route: `POST /api/v1/playgrounds/{playground_uuid}/thumbnail`
|
|
- Mode: WRITE
|
|
- Summary: Upload a playground thumbnail
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_add_usergroup_to_playground_api_v1_playgrounds_playground_uuid_usergroups_us
|
|
|
|
- Operation ID: `api_add_usergroup_to_playground_api_v1_playgrounds_playground_uuid_usergroups_us`
|
|
- Route: `POST /api/v1/playgrounds/{playground_uuid}/usergroups/{usergroup_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Grant a usergroup access to a playground
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
- `usergroup_uuid` in `path` required
|
|
|
|
### api_remove_usergroup_from_playground_api_v1_playgrounds_playground_uuid_usergrou
|
|
|
|
- Operation ID: `api_remove_usergroup_from_playground_api_v1_playgrounds_playground_uuid_usergrou`
|
|
- Route: `DELETE /api/v1/playgrounds/{playground_uuid}/usergroups/{usergroup_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Revoke a usergroup from a playground
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
- `usergroup_uuid` in `path` required
|
|
|
|
### api_get_playground_usergroups_api_v1_playgrounds_playground_uuid_usergroups_get
|
|
|
|
- Operation ID: `api_get_playground_usergroups_api_v1_playgrounds_playground_uuid_usergroups_get`
|
|
- Route: `GET /api/v1/playgrounds/{playground_uuid}/usergroups`
|
|
- Mode: READ
|
|
- Summary: List usergroups attached to a playground
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
|
|
### api_get_playground_reactions_api_v1_playgrounds_playground_uuid_reactions_get
|
|
|
|
- Operation ID: `api_get_playground_reactions_api_v1_playgrounds_playground_uuid_reactions_get`
|
|
- Route: `GET /api/v1/playgrounds/{playground_uuid}/reactions`
|
|
- Mode: READ
|
|
- Summary: List reactions on a playground
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
|
|
### api_toggle_playground_reaction_api_v1_playgrounds_playground_uuid_reactions_post
|
|
|
|
- Operation ID: `api_toggle_playground_reaction_api_v1_playgrounds_playground_uuid_reactions_post`
|
|
- Route: `POST /api/v1/playgrounds/{playground_uuid}/reactions`
|
|
- Mode: WRITE
|
|
- Summary: Toggle a reaction on a playground
|
|
- Parameters:
|
|
- `playground_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### start_playground_session_api_v1_playgrounds_generate_start_post
|
|
|
|
- Operation ID: `start_playground_session_api_v1_playgrounds_generate_start_post`
|
|
- Route: `POST /api/v1/playgrounds/generate/start`
|
|
- Mode: WRITE
|
|
- Summary: Start a playground generation session
|
|
- Body: JSON request body accepted.
|
|
|
|
### iterate_playground_session_api_v1_playgrounds_generate_iterate_post
|
|
|
|
- Operation ID: `iterate_playground_session_api_v1_playgrounds_generate_iterate_post`
|
|
- Route: `POST /api/v1/playgrounds/generate/iterate`
|
|
- Mode: WRITE
|
|
- Summary: Iterate on a playground generation session
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_session_state_api_v1_playgrounds_generate_session_session_uuid_get
|
|
|
|
- Operation ID: `get_session_state_api_v1_playgrounds_generate_session_session_uuid_get`
|
|
- Route: `GET /api/v1/playgrounds/generate/session/{session_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get playground generation session state
|
|
- Parameters:
|
|
- `session_uuid` in `path` required
|