--- name: communities-routes description: Handle 12 OpenAPI operation(s) under /api/v1/communities for the communities route group. --- # communities API Routes Handle 12 OpenAPI operation(s) under /api/v1/communities for the communities 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_community_api_v1_communities_post - Operation ID: `api_create_community_api_v1_communities_post` - Route: `POST /api/v1/communities/` - Mode: WRITE - Summary: Create a community - Parameters: - `org_id` in `query` required - Body: JSON request body accepted. ### api_get_community_api_v1_communities_community_uuid_get - Operation ID: `api_get_community_api_v1_communities_community_uuid_get` - Route: `GET /api/v1/communities/{community_uuid}` - Mode: READ - Summary: Get a community - Parameters: - `community_uuid` in `path` required ### api_update_community_api_v1_communities_community_uuid_put - Operation ID: `api_update_community_api_v1_communities_community_uuid_put` - Route: `PUT /api/v1/communities/{community_uuid}` - Mode: WRITE - Summary: Update a community - Parameters: - `community_uuid` in `path` required - Body: JSON request body accepted. ### api_delete_community_api_v1_communities_community_uuid_delete - Operation ID: `api_delete_community_api_v1_communities_community_uuid_delete` - Route: `DELETE /api/v1/communities/{community_uuid}` - Mode: WRITE - Summary: Delete a community - Parameters: - `community_uuid` in `path` required ### api_get_communities_by_org_api_v1_communities_org_org_id_page_page_limit_limit_g - Operation ID: `api_get_communities_by_org_api_v1_communities_org_org_id_page_page_limit_limit_g` - Route: `GET /api/v1/communities/org/{org_id}/page/{page}/limit/{limit}` - Mode: READ - Summary: List communities for an organization - Parameters: - `org_id` in `path` required - `page` in `path` required - `limit` in `path` required ### api_get_community_by_course_api_v1_communities_course_course_uuid_get - Operation ID: `api_get_community_by_course_api_v1_communities_course_course_uuid_get` - Route: `GET /api/v1/communities/course/{course_uuid}` - Mode: READ - Summary: Get community for a course - Parameters: - `course_uuid` in `path` required ### api_link_community_to_course_api_v1_communities_community_uuid_link_course_cours - Operation ID: `api_link_community_to_course_api_v1_communities_community_uuid_link_course_cours` - Route: `PUT /api/v1/communities/{community_uuid}/link-course/{course_uuid}` - Mode: WRITE - Summary: Link community to a course - Parameters: - `community_uuid` in `path` required - `course_uuid` in `path` required ### api_unlink_community_from_course_api_v1_communities_community_uuid_unlink_course - Operation ID: `api_unlink_community_from_course_api_v1_communities_community_uuid_unlink_course` - Route: `DELETE /api/v1/communities/{community_uuid}/unlink-course` - Mode: WRITE - Summary: Unlink community from its course - Parameters: - `community_uuid` in `path` required ### api_get_community_rights_api_v1_communities_community_uuid_rights_get - Operation ID: `api_get_community_rights_api_v1_communities_community_uuid_rights_get` - Route: `GET /api/v1/communities/{community_uuid}/rights` - Mode: READ - Summary: Get current user rights for a community - Parameters: - `community_uuid` in `path` required ### api_update_community_thumbnail_api_v1_communities_community_uuid_thumbnail_put - Operation ID: `api_update_community_thumbnail_api_v1_communities_community_uuid_thumbnail_put` - Route: `PUT /api/v1/communities/{community_uuid}/thumbnail` - Mode: WRITE - Summary: Upload a community thumbnail - Parameters: - `community_uuid` in `path` required - Body: JSON request body accepted. ### api_create_discussion_api_v1_communities_community_uuid_discussions_post - Operation ID: `api_create_discussion_api_v1_communities_community_uuid_discussions_post` - Route: `POST /api/v1/communities/{community_uuid}/discussions` - Mode: WRITE - Summary: Create a discussion - Parameters: - `community_uuid` in `path` required - Body: JSON request body accepted. ### api_get_discussions_by_community_api_v1_communities_community_uuid_discussions_g - Operation ID: `api_get_discussions_by_community_api_v1_communities_community_uuid_discussions_g` - Route: `GET /api/v1/communities/{community_uuid}/discussions` - Mode: READ - Summary: List discussions in a community - Parameters: - `community_uuid` in `path` required - `sort_by` in `query` - `page` in `query` - `limit` in `query` - `label` in `query`