115 lines
4.1 KiB
Markdown
115 lines
4.1 KiB
Markdown
---
|
|
name: chapters-routes
|
|
description: Handle 10 OpenAPI operation(s) under /api/v1/chapters for the chapters route group.
|
|
---
|
|
|
|
# chapters API Routes
|
|
|
|
Handle 10 OpenAPI operation(s) under /api/v1/chapters for the chapters 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.
|
|
|
|
When creating multiple lesson chapters for a course, keep the returned `id` for
|
|
each chapter. If the user requested course content, create at least one activity
|
|
for every chapter using that specific `chapter_id`; do not reuse the first
|
|
chapter ID for all activities. Verify every chapter has at least one activity.
|
|
|
|
## Operations
|
|
|
|
### api_create_coursechapter_api_v1_chapters_post
|
|
|
|
- Operation ID: `api_create_coursechapter_api_v1_chapters_post`
|
|
- Route: `POST /api/v1/chapters/`
|
|
- Mode: WRITE
|
|
- Summary: Create chapter
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_chapter_by_api_v1_chapters_course_course_id_p_ca466b63a8
|
|
|
|
- Operation ID: `api_get_chapter_by_api_v1_chapters_course_course_id_page_page_limit_limit_get`
|
|
- Route: `GET /api/v1/chapters/course/{course_id}/page/{page}/limit/{limit}`
|
|
- Mode: READ
|
|
- Summary: List course chapters
|
|
- Parameters:
|
|
- `course_id` in `path` required
|
|
- `page` in `path` required
|
|
- `limit` in `path` required
|
|
|
|
### api_get_chapter_meta_api_v1_chapters_course_course_uuid_meta_get
|
|
|
|
- Operation ID: `api_get_chapter_meta_api_v1_chapters_course_course_uuid_meta_get`
|
|
- Route: `GET /api/v1/chapters/course/{course_uuid}/meta`
|
|
- Mode: READ
|
|
- Summary: Get chapters metadata (deprecated)
|
|
- Parameters:
|
|
- `course_uuid` in `path` required
|
|
|
|
### api_update_chapter_meta_api_v1_chapters_course_course_ae93bf15bd
|
|
|
|
- Operation ID: `api_update_chapter_meta_api_v1_chapters_course_course_uuid_order_put`
|
|
- Route: `PUT /api/v1/chapters/course/{course_uuid}/order`
|
|
- Mode: WRITE
|
|
- Summary: Reorder chapters and activities
|
|
- Parameters:
|
|
- `course_uuid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_coursechapter_api_v1_chapters_chapter_id_delete
|
|
|
|
- Operation ID: `api_delete_coursechapter_api_v1_chapters_chapter_id_delete`
|
|
- Route: `DELETE /api/v1/chapters/{chapter_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete chapter
|
|
- Parameters:
|
|
- `chapter_id` in `path` required
|
|
|
|
### api_get_coursechapter_api_v1_chapters_chapter_id_get
|
|
|
|
- Operation ID: `api_get_coursechapter_api_v1_chapters_chapter_id_get`
|
|
- Route: `GET /api/v1/chapters/{chapter_id}`
|
|
- Mode: READ
|
|
- Summary: Get chapter by ID
|
|
- Parameters:
|
|
- `chapter_id` in `path` required
|
|
|
|
### api_update_coursechapter_api_v1_chapters_chapter_id_put
|
|
|
|
- Operation ID: `api_update_coursechapter_api_v1_chapters_chapter_id_put`
|
|
- Route: `PUT /api/v1/chapters/{chapter_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update chapter
|
|
- Parameters:
|
|
- `chapter_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_list_chapter_usergroups_api_v1_chapters_chapter_u_7ea9b7d53b
|
|
|
|
- Operation ID: `api_list_chapter_usergroups_api_v1_chapters_chapter_uuid_usergroups_get`
|
|
- Route: `GET /api/v1/chapters/{chapter_uuid}/usergroups`
|
|
- Mode: READ
|
|
- Summary: List user groups assigned to a locked chapter
|
|
- Parameters:
|
|
- `chapter_uuid` in `path` required
|
|
|
|
### api_remove_chapter_usergroup_api_v1_chapters_chapter_0bc8cff2fa
|
|
|
|
- Operation ID: `api_remove_chapter_usergroup_api_v1_chapters_chapter_uuid_usergroups_usergroup_u`
|
|
- Route: `DELETE /api/v1/chapters/{chapter_uuid}/usergroups/{usergroup_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Revoke a user group's access to a locked chapter
|
|
- Parameters:
|
|
- `chapter_uuid` in `path` required
|
|
- `usergroup_uuid` in `path` required
|
|
|
|
### api_add_chapter_usergroup_api_v1_chapters_chapter_uui_576584c595
|
|
|
|
- Operation ID: `api_add_chapter_usergroup_api_v1_chapters_chapter_uuid_usergroups_usergroup_uuid`
|
|
- Route: `POST /api/v1/chapters/{chapter_uuid}/usergroups/{usergroup_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Grant a user group access to a locked chapter
|
|
- Parameters:
|
|
- `chapter_uuid` in `path` required
|
|
- `usergroup_uuid` in `path` required
|