180 lines
6.0 KiB
Markdown
180 lines
6.0 KiB
Markdown
---
|
|
name: podcasts-routes
|
|
description: Handle 17 OpenAPI operation(s) under /api/v1/podcasts for the podcasts route group.
|
|
---
|
|
|
|
# podcasts API Routes
|
|
|
|
Handle 17 OpenAPI operation(s) under /api/v1/podcasts for the podcasts 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_podcast_api_v1_podcasts_post
|
|
|
|
- Operation ID: `api_create_podcast_api_v1_podcasts_post`
|
|
- Route: `POST /api/v1/podcasts/`
|
|
- Mode: WRITE
|
|
- Summary: Create a podcast
|
|
- Parameters:
|
|
- `org_id` in `query` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_podcast_api_v1_podcasts_podcast_uuid_get
|
|
|
|
- Operation ID: `api_get_podcast_api_v1_podcasts_podcast_uuid_get`
|
|
- Route: `GET /api/v1/podcasts/{podcast_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get a podcast
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
|
|
### api_update_podcast_api_v1_podcasts_podcast_uuid_put
|
|
|
|
- Operation ID: `api_update_podcast_api_v1_podcasts_podcast_uuid_put`
|
|
- Route: `PUT /api/v1/podcasts/{podcast_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Update a podcast
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_podcast_api_v1_podcasts_podcast_uuid_delete
|
|
|
|
- Operation ID: `api_delete_podcast_api_v1_podcasts_podcast_uuid_delete`
|
|
- Route: `DELETE /api/v1/podcasts/{podcast_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a podcast
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
|
|
### api_get_podcast_meta_api_v1_podcasts_podcast_uuid_meta_get
|
|
|
|
- Operation ID: `api_get_podcast_meta_api_v1_podcasts_podcast_uuid_meta_get`
|
|
- Route: `GET /api/v1/podcasts/{podcast_uuid}/meta`
|
|
- Mode: READ
|
|
- Summary: Get podcast metadata
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
|
|
### api_get_podcasts_orgslug_api_v1_podcasts_org_slug_org_slug_page_page_limit_limit
|
|
|
|
- Operation ID: `api_get_podcasts_orgslug_api_v1_podcasts_org_slug_org_slug_page_page_limit_limit`
|
|
- Route: `GET /api/v1/podcasts/org_slug/{org_slug}/page/{page}/limit/{limit}`
|
|
- Mode: READ
|
|
- Summary: List podcasts for an organization
|
|
- Parameters:
|
|
- `org_slug` in `path` required
|
|
- `page` in `path` required
|
|
- `limit` in `path` required
|
|
- `include_unpublished` in `query`
|
|
|
|
### api_get_podcasts_count_orgslug_api_v1_podcasts_org_slug_org_slug_count_get
|
|
|
|
- Operation ID: `api_get_podcasts_count_orgslug_api_v1_podcasts_org_slug_org_slug_count_get`
|
|
- Route: `GET /api/v1/podcasts/org_slug/{org_slug}/count`
|
|
- Mode: READ
|
|
- Summary: Count podcasts for an organization
|
|
- Parameters:
|
|
- `org_slug` in `path` required
|
|
|
|
### api_update_podcast_thumbnail_api_v1_podcasts_podcast_uuid_thumbnail_put
|
|
|
|
- Operation ID: `api_update_podcast_thumbnail_api_v1_podcasts_podcast_uuid_thumbnail_put`
|
|
- Route: `PUT /api/v1/podcasts/{podcast_uuid}/thumbnail`
|
|
- Mode: WRITE
|
|
- Summary: Update podcast thumbnail
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_podcast_rights_api_v1_podcasts_podcast_uuid_rights_get
|
|
|
|
- Operation ID: `api_get_podcast_rights_api_v1_podcasts_podcast_uuid_rights_get`
|
|
- Route: `GET /api/v1/podcasts/{podcast_uuid}/rights`
|
|
- Mode: READ
|
|
- Summary: Get podcast user rights
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
|
|
### api_get_podcast_episodes_api_v1_podcasts_podcast_uuid_episodes_get
|
|
|
|
- Operation ID: `api_get_podcast_episodes_api_v1_podcasts_podcast_uuid_episodes_get`
|
|
- Route: `GET /api/v1/podcasts/{podcast_uuid}/episodes`
|
|
- Mode: READ
|
|
- Summary: List podcast episodes
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
- `include_unpublished` in `query`
|
|
|
|
### api_create_episode_api_v1_podcasts_podcast_uuid_episodes_post
|
|
|
|
- Operation ID: `api_create_episode_api_v1_podcasts_podcast_uuid_episodes_post`
|
|
- Route: `POST /api/v1/podcasts/{podcast_uuid}/episodes`
|
|
- Mode: WRITE
|
|
- Summary: Create a podcast episode
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_reorder_episodes_api_v1_podcasts_podcast_uuid_episodes_reorder_put
|
|
|
|
- Operation ID: `api_reorder_episodes_api_v1_podcasts_podcast_uuid_episodes_reorder_put`
|
|
- Route: `PUT /api/v1/podcasts/{podcast_uuid}/episodes/reorder`
|
|
- Mode: WRITE
|
|
- Summary: Reorder podcast episodes
|
|
- Parameters:
|
|
- `podcast_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_episode_api_v1_podcasts_episodes_episode_uuid_get
|
|
|
|
- Operation ID: `api_get_episode_api_v1_podcasts_episodes_episode_uuid_get`
|
|
- Route: `GET /api/v1/podcasts/episodes/{episode_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get a podcast episode
|
|
- Parameters:
|
|
- `episode_uuid` in `path` required
|
|
|
|
### api_update_episode_api_v1_podcasts_episodes_episode_uuid_put
|
|
|
|
- Operation ID: `api_update_episode_api_v1_podcasts_episodes_episode_uuid_put`
|
|
- Route: `PUT /api/v1/podcasts/episodes/{episode_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Update a podcast episode
|
|
- Parameters:
|
|
- `episode_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_episode_api_v1_podcasts_episodes_episode_uuid_delete
|
|
|
|
- Operation ID: `api_delete_episode_api_v1_podcasts_episodes_episode_uuid_delete`
|
|
- Route: `DELETE /api/v1/podcasts/episodes/{episode_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a podcast episode
|
|
- Parameters:
|
|
- `episode_uuid` in `path` required
|
|
|
|
### api_upload_episode_audio_api_v1_podcasts_episodes_episode_uuid_audio_put
|
|
|
|
- Operation ID: `api_upload_episode_audio_api_v1_podcasts_episodes_episode_uuid_audio_put`
|
|
- Route: `PUT /api/v1/podcasts/episodes/{episode_uuid}/audio`
|
|
- Mode: WRITE
|
|
- Summary: Upload episode audio
|
|
- Parameters:
|
|
- `episode_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_upload_episode_thumbnail_api_v1_podcasts_episodes_episode_uuid_thumbnail_put
|
|
|
|
- Operation ID: `api_upload_episode_thumbnail_api_v1_podcasts_episodes_episode_uuid_thumbnail_put`
|
|
- Route: `PUT /api/v1/podcasts/episodes/{episode_uuid}/thumbnail`
|
|
- Mode: WRITE
|
|
- Summary: Upload episode thumbnail
|
|
- Parameters:
|
|
- `episode_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|