deploy
This commit is contained in:
@@ -3,10 +3,10 @@
|
||||
"language": "python",
|
||||
"name": "learnhouse-agent",
|
||||
"description": "LearnHouse is an open-source platform tailored for learning experiences.",
|
||||
"version": "1.2.8",
|
||||
"version": "1.2.9",
|
||||
"entrypoint": {
|
||||
"module": "agent",
|
||||
"class_name": "Learnhouse",
|
||||
"class_name": "LearnhouseAgent",
|
||||
"function": null,
|
||||
"command": []
|
||||
},
|
||||
@@ -163,8 +163,8 @@
|
||||
"source": "python-a2a-pack",
|
||||
"project_manifest": {
|
||||
"name": "learnhouse-agent",
|
||||
"version": "1.2.8",
|
||||
"entrypoint": "agent:Learnhouse"
|
||||
"version": "1.2.9",
|
||||
"entrypoint": "agent:LearnhouseAgent"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# learnhouse
|
||||
# learnhouse-agent
|
||||
|
||||
Generated A2APack agent for LearnHouse.
|
||||
|
||||
@@ -12,8 +12,11 @@ Deployment context:
|
||||
- This LearnHouse instance runs single-organization tenancy.
|
||||
- Existing organization: A2A Cloud Academy
|
||||
- Default `org_slug`: `default`
|
||||
- Default `org_id`: `1`
|
||||
- Do not create additional organizations on this instance; that requires
|
||||
LearnHouse Enterprise multi-organization mode.
|
||||
- Course creation uses multipart form fields: `name`, `description`, `public`,
|
||||
and `about`.
|
||||
|
||||
The generated code is intentionally editable. Tune prompts, operation
|
||||
grouping, auth names, and safety policy before publishing serious agents.
|
||||
|
||||
4
a2a.yaml
4
a2a.yaml
@@ -1,6 +1,6 @@
|
||||
name: learnhouse-agent
|
||||
version: 1.2.8
|
||||
entrypoint: agent:Learnhouse
|
||||
version: 1.2.9
|
||||
entrypoint: agent:LearnhouseAgent
|
||||
description: LearnHouse is an open-source platform tailored for learning experiences.
|
||||
runtime:
|
||||
resources:
|
||||
|
||||
@@ -21,52 +21,84 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Create activity
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_activity_versions_api_v1_activities_activity_uuid_versions_get
|
||||
### api_get_chapter_activities_api_v1_activities_chapter_663ab6bde2
|
||||
|
||||
- Operation ID: `api_get_activity_versions_api_v1_activities_activity_uuid_versions_get`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/versions`
|
||||
- Operation ID: `api_get_chapter_activities_api_v1_activities_chapter_chapter_id_get`
|
||||
- Route: `GET /api/v1/activities/chapter/{chapter_id}`
|
||||
- Mode: READ
|
||||
- Summary: List activity versions
|
||||
- Summary: List chapter activities
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `limit` in `query`
|
||||
- `offset` in `query`
|
||||
- `chapter_id` in `path` required
|
||||
|
||||
### api_get_activity_version_api_v1_activities_activity_uuid_versions_version_number
|
||||
### api_create_documentpdf_activity_api_v1_activities_doc_0fa3c707b3
|
||||
|
||||
- Operation ID: `api_get_activity_version_api_v1_activities_activity_uuid_versions_version_number`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/versions/{version_number}`
|
||||
- Mode: READ
|
||||
- Summary: Get activity version
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `version_number` in `path` required
|
||||
|
||||
### api_get_activity_state_api_v1_activities_activity_uuid_state_get
|
||||
|
||||
- Operation ID: `api_get_activity_state_api_v1_activities_activity_uuid_state_get`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/state`
|
||||
- Mode: READ
|
||||
- Summary: Get activity state
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_restore_activity_version_api_v1_activities_activity_uuid_versions_version_nu
|
||||
|
||||
- Operation ID: `api_restore_activity_version_api_v1_activities_activity_uuid_versions_version_nu`
|
||||
- Route: `POST /api/v1/activities/{activity_uuid}/versions/{version_number}/restore`
|
||||
- Operation ID: `api_create_documentpdf_activity_api_v1_activities_documentpdf_post`
|
||||
- Route: `POST /api/v1/activities/documentpdf`
|
||||
- Mode: WRITE
|
||||
- Summary: Restore activity version
|
||||
- Summary: Create PDF document activity
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_documentpdf_activity_api_v1_activities_doc_a4d82f2474
|
||||
|
||||
- Operation ID: `api_update_documentpdf_activity_api_v1_activities_documentpdf_activity_uuid_put`
|
||||
- Route: `PUT /api/v1/activities/documentpdf/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update PDF document activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `version_number` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_editor_bootstrap_api_v1_activities_activity_uuid_editor_bootstrap_get
|
||||
### api_create_external_video_activity_api_v1_activities_6fccc29f5e
|
||||
|
||||
- Operation ID: `api_get_editor_bootstrap_api_v1_activities_activity_uuid_editor_bootstrap_get`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/editor-bootstrap`
|
||||
- Operation ID: `api_create_external_video_activity_api_v1_activities_external_video_post`
|
||||
- Route: `POST /api/v1/activities/external_video`
|
||||
- Mode: WRITE
|
||||
- Summary: Create external video activity
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_external_video_activity_api_v1_activities_231ea2dcf8
|
||||
|
||||
- Operation ID: `api_update_external_video_activity_api_v1_activities_external_video_activity_uui`
|
||||
- Route: `PUT /api/v1/activities/external_video/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update external video activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_activityby_id_api_v1_activities_id_activity_id_get
|
||||
|
||||
- Operation ID: `api_get_activityby_id_api_v1_activities_id_activity_id_get`
|
||||
- Route: `GET /api/v1/activities/id/{activity_id}`
|
||||
- Mode: READ
|
||||
- Summary: Editor bootstrap payload
|
||||
- Summary: Get activity by ID
|
||||
- Parameters:
|
||||
- `activity_id` in `path` required
|
||||
|
||||
### api_create_video_activity_api_v1_activities_video_post
|
||||
|
||||
- Operation ID: `api_create_video_activity_api_v1_activities_video_post`
|
||||
- Route: `POST /api/v1/activities/video`
|
||||
- Mode: WRITE
|
||||
- Summary: Create video activity
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_video_activity_api_v1_activities_video_act_053ebe48d1
|
||||
|
||||
- Operation ID: `api_update_video_activity_api_v1_activities_video_activity_uuid_put`
|
||||
- Route: `PUT /api/v1/activities/video/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update hosted video activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_activity_api_v1_activities_activity_uuid_delete
|
||||
|
||||
- Operation ID: `api_delete_activity_api_v1_activities_activity_uuid_delete`
|
||||
- Route: `DELETE /api/v1/activities/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
@@ -89,88 +121,25 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `activity_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_activity_api_v1_activities_activity_uuid_delete
|
||||
### api_get_editor_bootstrap_api_v1_activities_activity_u_05beca7477
|
||||
|
||||
- Operation ID: `api_delete_activity_api_v1_activities_activity_uuid_delete`
|
||||
- Route: `DELETE /api/v1/activities/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_get_activityby_id_api_v1_activities_id_activity_id_get
|
||||
|
||||
- Operation ID: `api_get_activityby_id_api_v1_activities_id_activity_id_get`
|
||||
- Route: `GET /api/v1/activities/id/{activity_id}`
|
||||
- Operation ID: `api_get_editor_bootstrap_api_v1_activities_activity_uuid_editor_bootstrap_get`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/editor-bootstrap`
|
||||
- Mode: READ
|
||||
- Summary: Get activity by ID
|
||||
- Summary: Editor bootstrap payload
|
||||
- Parameters:
|
||||
- `activity_id` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_get_chapter_activities_api_v1_activities_chapter_chapter_id_get
|
||||
### api_get_activity_state_api_v1_activities_activity_uuid_state_get
|
||||
|
||||
- Operation ID: `api_get_chapter_activities_api_v1_activities_chapter_chapter_id_get`
|
||||
- Route: `GET /api/v1/activities/chapter/{chapter_id}`
|
||||
- Operation ID: `api_get_activity_state_api_v1_activities_activity_uuid_state_get`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/state`
|
||||
- Mode: READ
|
||||
- Summary: List chapter activities
|
||||
- Parameters:
|
||||
- `chapter_id` in `path` required
|
||||
|
||||
### api_create_video_activity_api_v1_activities_video_post
|
||||
|
||||
- Operation ID: `api_create_video_activity_api_v1_activities_video_post`
|
||||
- Route: `POST /api/v1/activities/video`
|
||||
- Mode: WRITE
|
||||
- Summary: Create video activity
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_external_video_activity_api_v1_activities_external_video_post
|
||||
|
||||
- Operation ID: `api_create_external_video_activity_api_v1_activities_external_video_post`
|
||||
- Route: `POST /api/v1/activities/external_video`
|
||||
- Mode: WRITE
|
||||
- Summary: Create external video activity
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_documentpdf_activity_api_v1_activities_documentpdf_post
|
||||
|
||||
- Operation ID: `api_create_documentpdf_activity_api_v1_activities_documentpdf_post`
|
||||
- Route: `POST /api/v1/activities/documentpdf`
|
||||
- Mode: WRITE
|
||||
- Summary: Create PDF document activity
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_video_activity_api_v1_activities_video_activity_uuid_put
|
||||
|
||||
- Operation ID: `api_update_video_activity_api_v1_activities_video_activity_uuid_put`
|
||||
- Route: `PUT /api/v1/activities/video/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update hosted video activity
|
||||
- Summary: Get activity state
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_external_video_activity_api_v1_activities_external_video_activity_uui
|
||||
|
||||
- Operation ID: `api_update_external_video_activity_api_v1_activities_external_video_activity_uui`
|
||||
- Route: `PUT /api/v1/activities/external_video/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update external video activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_documentpdf_activity_api_v1_activities_documentpdf_activity_uuid_put
|
||||
|
||||
- Operation ID: `api_update_documentpdf_activity_api_v1_activities_documentpdf_activity_uuid_put`
|
||||
- Route: `PUT /api/v1/activities/documentpdf/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update PDF document activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_list_activity_usergroups_api_v1_activities_activity_uuid_usergroups_get
|
||||
### api_list_activity_usergroups_api_v1_activities_activi_cc7f8f474c
|
||||
|
||||
- Operation ID: `api_list_activity_usergroups_api_v1_activities_activity_uuid_usergroups_get`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/usergroups`
|
||||
@@ -179,7 +148,17 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_add_activity_usergroup_api_v1_activities_activity_uuid_usergroups_usergroup_
|
||||
### api_remove_activity_usergroup_api_v1_activities_activ_413d0bb7de
|
||||
|
||||
- Operation ID: `api_remove_activity_usergroup_api_v1_activities_activity_uuid_usergroups_usergro`
|
||||
- Route: `DELETE /api/v1/activities/{activity_uuid}/usergroups/{usergroup_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Revoke a user group's access to a locked activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
|
||||
### api_add_activity_usergroup_api_v1_activities_activity_07e359d60e
|
||||
|
||||
- Operation ID: `api_add_activity_usergroup_api_v1_activities_activity_uuid_usergroups_usergroup_`
|
||||
- Route: `POST /api/v1/activities/{activity_uuid}/usergroups/{usergroup_uuid}`
|
||||
@@ -189,12 +168,33 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `activity_uuid` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
|
||||
### api_remove_activity_usergroup_api_v1_activities_activity_uuid_usergroups_usergro
|
||||
### api_get_activity_versions_api_v1_activities_activity_d2be4ccb83
|
||||
|
||||
- Operation ID: `api_remove_activity_usergroup_api_v1_activities_activity_uuid_usergroups_usergro`
|
||||
- Route: `DELETE /api/v1/activities/{activity_uuid}/usergroups/{usergroup_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Revoke a user group's access to a locked activity
|
||||
- Operation ID: `api_get_activity_versions_api_v1_activities_activity_uuid_versions_get`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/versions`
|
||||
- Mode: READ
|
||||
- Summary: List activity versions
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `limit` in `query`
|
||||
- `offset` in `query`
|
||||
|
||||
### api_get_activity_version_api_v1_activities_activity_u_f066c45e54
|
||||
|
||||
- Operation ID: `api_get_activity_version_api_v1_activities_activity_uuid_versions_version_number`
|
||||
- Route: `GET /api/v1/activities/{activity_uuid}/versions/{version_number}`
|
||||
- Mode: READ
|
||||
- Summary: Get activity version
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `version_number` in `path` required
|
||||
|
||||
### api_restore_activity_version_api_v1_activities_activi_0e908d5dc6
|
||||
|
||||
- Operation ID: `api_restore_activity_version_api_v1_activities_activity_uuid_versions_version_nu`
|
||||
- Route: `POST /api/v1/activities/{activity_uuid}/versions/{version_number}/restore`
|
||||
- Mode: WRITE
|
||||
- Summary: Restore activity version
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `version_number` in `path` required
|
||||
|
||||
@@ -13,6 +13,26 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### api_admin_magic_consume_api_v1_admin_org_slug_auth_ma_13806ba8d2
|
||||
|
||||
- Operation ID: `api_admin_magic_consume_api_v1_admin_org_slug_auth_magic_consume_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/auth/magic-consume`
|
||||
- Mode: READ
|
||||
- Summary: Consume a magic sign-in link (browser-facing)
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `token` in `query` required
|
||||
|
||||
### api_admin_issue_magic_link_api_v1_admin_org_slug_auth_b4599e8c7b
|
||||
|
||||
- Operation ID: `api_admin_issue_magic_link_api_v1_admin_org_slug_auth_magic_link_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/auth/magic-link`
|
||||
- Mode: WRITE
|
||||
- Summary: Issue a magic sign-in link
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_issue_token_api_v1_admin_org_slug_auth_token_post
|
||||
|
||||
- Operation ID: `api_admin_issue_token_api_v1_admin_org_slug_auth_token_post`
|
||||
@@ -23,7 +43,39 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_check_course_access_api_v1_admin_org_slug_courses_course_uuid_access_u
|
||||
### api_admin_get_user_certificates_api_v1_admin_org_slug_e5a0e75737
|
||||
|
||||
- Operation ID: `api_admin_get_user_certificates_api_v1_admin_org_slug_certifications_user_id_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/certifications/{user_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get user certificates
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_award_certificate_api_v1_admin_org_slug_cer_a55aec2729
|
||||
|
||||
- Operation ID: `api_admin_award_certificate_api_v1_admin_org_slug_certifications_user_id_course_`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/certifications/{user_id}/{course_uuid}/award`
|
||||
- Mode: WRITE
|
||||
- Summary: Manually award a certificate
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_revoke_certificate_api_v1_admin_org_slug_ce_585016dce1
|
||||
|
||||
- Operation ID: `api_admin_revoke_certificate_api_v1_admin_org_slug_certifications_user_id_user_c`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/certifications/{user_id}/{user_certification_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Revoke a user's certificate
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `user_certification_uuid` in `path` required
|
||||
|
||||
### api_admin_check_course_access_api_v1_admin_org_slug_c_33e8055eda
|
||||
|
||||
- Operation ID: `api_admin_check_course_access_api_v1_admin_org_slug_courses_course_uuid_access_u`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/courses/{course_uuid}/access/{user_id}`
|
||||
@@ -34,7 +86,39 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `course_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_bulk_unenroll_api_v1_admin_org_slug_enrollments_bulk_unenroll_post
|
||||
### api_admin_get_course_analytics_api_v1_admin_org_slug_a01b54e7f8
|
||||
|
||||
- Operation ID: `api_admin_get_course_analytics_api_v1_admin_org_slug_courses_course_uuid_analyti`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/courses/{course_uuid}/analytics`
|
||||
- Mode: READ
|
||||
- Summary: Aggregate stats for a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_list_course_enrollments_api_v1_admin_org_sl_ea439e26eb
|
||||
|
||||
- Operation ID: `api_admin_list_course_enrollments_api_v1_admin_org_slug_courses_course_uuid_enro`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/courses/{course_uuid}/enrollments`
|
||||
- Mode: READ
|
||||
- Summary: List users enrolled in a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
|
||||
### api_admin_bulk_enroll_api_v1_admin_org_slug_enrollmen_c76b6c3285
|
||||
|
||||
- Operation ID: `api_admin_bulk_enroll_api_v1_admin_org_slug_enrollments_bulk_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/enrollments/bulk`
|
||||
- Mode: WRITE
|
||||
- Summary: Bulk enroll users in a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_bulk_unenroll_api_v1_admin_org_slug_enrollm_1d6da8f703
|
||||
|
||||
- Operation ID: `api_admin_bulk_unenroll_api_v1_admin_org_slug_enrollments_bulk_unenroll_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/enrollments/bulk/unenroll`
|
||||
@@ -44,18 +128,17 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_enroll_user_api_v1_admin_org_slug_enrollments_user_id_course_uuid_post
|
||||
### api_admin_get_user_enrollments_api_v1_admin_org_slug_d860a65110
|
||||
|
||||
- Operation ID: `api_admin_enroll_user_api_v1_admin_org_slug_enrollments_user_id_course_uuid_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/enrollments/{user_id}/{course_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Enroll user in course
|
||||
- Operation ID: `api_admin_get_user_enrollments_api_v1_admin_org_slug_enrollments_user_id_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/enrollments/{user_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get user enrollments
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_unenroll_user_api_v1_admin_org_slug_enrollments_user_id_course_uuid_de
|
||||
### api_admin_unenroll_user_api_v1_admin_org_slug_enrollm_0bc9c6c065
|
||||
|
||||
- Operation ID: `api_admin_unenroll_user_api_v1_admin_org_slug_enrollments_user_id_course_uuid_de`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/enrollments/{user_id}/{course_uuid}`
|
||||
@@ -66,39 +149,28 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_get_user_enrollments_api_v1_admin_org_slug_enrollments_user_id_get
|
||||
### api_admin_enroll_user_api_v1_admin_org_slug_enrollmen_80a503c510
|
||||
|
||||
- Operation ID: `api_admin_get_user_enrollments_api_v1_admin_org_slug_enrollments_user_id_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/enrollments/{user_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get user enrollments
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_get_user_progress_api_v1_admin_org_slug_progress_user_id_course_uuid_g
|
||||
|
||||
- Operation ID: `api_admin_get_user_progress_api_v1_admin_org_slug_progress_user_id_course_uuid_g`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/progress/{user_id}/{course_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get user progress in course
|
||||
- Operation ID: `api_admin_enroll_user_api_v1_admin_org_slug_enrollments_user_id_course_uuid_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/enrollments/{user_id}/{course_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Enroll user in course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_complete_activity_api_v1_admin_org_slug_progress_user_id_activities_ac
|
||||
### api_admin_get_all_user_progress_api_v1_admin_org_slug_5980bde222
|
||||
|
||||
- Operation ID: `api_admin_complete_activity_api_v1_admin_org_slug_progress_user_id_activities_ac`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/progress/{user_id}/activities/{activity_uuid}/complete`
|
||||
- Mode: WRITE
|
||||
- Summary: Mark activity as completed
|
||||
- Operation ID: `api_admin_get_all_user_progress_api_v1_admin_org_slug_progress_user_id_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/progress/{user_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get all user progress
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_admin_uncomplete_activity_api_v1_admin_org_slug_progress_user_id_activities_
|
||||
### api_admin_uncomplete_activity_api_v1_admin_org_slug_p_333dafc4cf
|
||||
|
||||
- Operation ID: `api_admin_uncomplete_activity_api_v1_admin_org_slug_progress_user_id_activities_`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/progress/{user_id}/activities/{activity_uuid}/complete`
|
||||
@@ -109,7 +181,29 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `user_id` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_admin_complete_course_api_v1_admin_org_slug_progress_user_id_course_uuid_com
|
||||
### api_admin_complete_activity_api_v1_admin_org_slug_pro_a0e5004bd3
|
||||
|
||||
- Operation ID: `api_admin_complete_activity_api_v1_admin_org_slug_progress_user_id_activities_ac`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/progress/{user_id}/activities/{activity_uuid}/complete`
|
||||
- Mode: WRITE
|
||||
- Summary: Mark activity as completed
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_admin_get_user_progress_api_v1_admin_org_slug_pro_eadf9c3840
|
||||
|
||||
- Operation ID: `api_admin_get_user_progress_api_v1_admin_org_slug_progress_user_id_course_uuid_g`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/progress/{user_id}/{course_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get user progress in course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_complete_course_api_v1_admin_org_slug_progr_c218814127
|
||||
|
||||
- Operation ID: `api_admin_complete_course_api_v1_admin_org_slug_progress_user_id_course_uuid_com`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/progress/{user_id}/{course_uuid}/complete`
|
||||
@@ -120,17 +214,18 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_get_all_user_progress_api_v1_admin_org_slug_progress_user_id_get
|
||||
### api_admin_reset_user_progress_api_v1_admin_org_slug_p_31449b62bc
|
||||
|
||||
- Operation ID: `api_admin_get_all_user_progress_api_v1_admin_org_slug_progress_user_id_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/progress/{user_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get all user progress
|
||||
- Operation ID: `api_admin_reset_user_progress_api_v1_admin_org_slug_progress_user_id_course_uuid`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/progress/{user_id}/{course_uuid}/reset`
|
||||
- Mode: WRITE
|
||||
- Summary: Reset a user's progress in a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_get_user_trail_detail_api_v1_admin_org_slug_trails_user_id_get
|
||||
### api_admin_get_user_trail_detail_api_v1_admin_org_slug_232a8bff43
|
||||
|
||||
- Operation ID: `api_admin_get_user_trail_detail_api_v1_admin_org_slug_trails_user_id_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/trails/{user_id}`
|
||||
@@ -140,7 +235,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_get_user_course_trail_detail_api_v1_admin_org_slug_trails_user_id_cour
|
||||
### api_admin_get_user_course_trail_detail_api_v1_admin_o_61e79d638b
|
||||
|
||||
- Operation ID: `api_admin_get_user_course_trail_detail_api_v1_admin_org_slug_trails_user_id_cour`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/trails/{user_id}/courses/{course_uuid}`
|
||||
@@ -151,14 +246,80 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_get_user_certificates_api_v1_admin_org_slug_certifications_user_id_get
|
||||
### api_admin_create_usergroup_api_v1_admin_org_slug_usergroups_post
|
||||
|
||||
- Operation ID: `api_admin_get_user_certificates_api_v1_admin_org_slug_certifications_user_id_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/certifications/{user_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get user certificates
|
||||
- Operation ID: `api_admin_create_usergroup_api_v1_admin_org_slug_usergroups_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/usergroups`
|
||||
- Mode: WRITE
|
||||
- Summary: Create a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_delete_usergroup_api_v1_admin_org_slug_user_6deba06a8c
|
||||
|
||||
- Operation ID: `api_admin_delete_usergroup_api_v1_admin_org_slug_usergroups_usergroup_uuid_delet`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
|
||||
### api_admin_remove_course_from_usergroup_api_v1_admin_o_ba616ff1d6
|
||||
|
||||
- Operation ID: `api_admin_remove_course_from_usergroup_api_v1_admin_org_slug_usergroups_usergrou`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/courses/{course_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Revoke a cohort's access to a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_add_course_to_usergroup_api_v1_admin_org_sl_cac4a6b452
|
||||
|
||||
- Operation ID: `api_admin_add_course_to_usergroup_api_v1_admin_org_slug_usergroups_usergroup_uui`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/courses/{course_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Grant a cohort access to a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_list_usergroup_members_api_v1_admin_org_slu_61091a34a8
|
||||
|
||||
- Operation ID: `api_admin_list_usergroup_members_api_v1_admin_org_slug_usergroups_usergroup_uuid`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members`
|
||||
- Mode: READ
|
||||
- Summary: List members of a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
|
||||
### api_admin_remove_usergroup_member_api_v1_admin_org_sl_c10689c1d9
|
||||
|
||||
- Operation ID: `api_admin_remove_usergroup_member_api_v1_admin_org_slug_usergroups_usergroup_uui`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Remove a user from a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_add_usergroup_member_api_v1_admin_org_slug_1138e931f8
|
||||
|
||||
- Operation ID: `api_admin_add_usergroup_member_api_v1_admin_org_slug_usergroups_usergroup_uuid_m`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Add a user to a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_provision_user_api_v1_admin_org_slug_users_post
|
||||
@@ -171,6 +332,16 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_get_user_by_email_api_v1_admin_org_slug_use_a0d33c23a8
|
||||
|
||||
- Operation ID: `api_admin_get_user_by_email_api_v1_admin_org_slug_users_by_email_email_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/users/by-email/{email}`
|
||||
- Mode: READ
|
||||
- Summary: Look up a user by email
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `email` in `path` required
|
||||
|
||||
### api_admin_remove_user_api_v1_admin_org_slug_users_user_id_delete
|
||||
|
||||
- Operation ID: `api_admin_remove_user_api_v1_admin_org_slug_users_user_id_delete`
|
||||
@@ -181,7 +352,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_update_user_profile_api_v1_admin_org_slug_users_user_id_patch
|
||||
### api_admin_update_user_profile_api_v1_admin_org_slug_u_2b4c820274
|
||||
|
||||
- Operation ID: `api_admin_update_user_profile_api_v1_admin_org_slug_users_user_id_patch`
|
||||
- Route: `PATCH /api/v1/admin/{org_slug}/users/{user_id}`
|
||||
@@ -192,199 +363,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_get_user_by_email_api_v1_admin_org_slug_users_by_email_email_get
|
||||
|
||||
- Operation ID: `api_admin_get_user_by_email_api_v1_admin_org_slug_users_by_email_email_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/users/by-email/{email}`
|
||||
- Mode: READ
|
||||
- Summary: Look up a user by email
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `email` in `path` required
|
||||
|
||||
### api_admin_issue_magic_link_api_v1_admin_org_slug_auth_magic_link_post
|
||||
|
||||
- Operation ID: `api_admin_issue_magic_link_api_v1_admin_org_slug_auth_magic_link_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/auth/magic-link`
|
||||
- Mode: WRITE
|
||||
- Summary: Issue a magic sign-in link
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_magic_consume_api_v1_admin_org_slug_auth_magic_consume_get
|
||||
|
||||
- Operation ID: `api_admin_magic_consume_api_v1_admin_org_slug_auth_magic_consume_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/auth/magic-consume`
|
||||
- Mode: READ
|
||||
- Summary: Consume a magic sign-in link (browser-facing)
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `token` in `query` required
|
||||
|
||||
### api_admin_bulk_enroll_api_v1_admin_org_slug_enrollments_bulk_post
|
||||
|
||||
- Operation ID: `api_admin_bulk_enroll_api_v1_admin_org_slug_enrollments_bulk_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/enrollments/bulk`
|
||||
- Mode: WRITE
|
||||
- Summary: Bulk enroll users in a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_list_course_enrollments_api_v1_admin_org_slug_courses_course_uuid_enro
|
||||
|
||||
- Operation ID: `api_admin_list_course_enrollments_api_v1_admin_org_slug_courses_course_uuid_enro`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/courses/{course_uuid}/enrollments`
|
||||
- Mode: READ
|
||||
- Summary: List users enrolled in a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
|
||||
### api_admin_reset_user_progress_api_v1_admin_org_slug_progress_user_id_course_uuid
|
||||
|
||||
- Operation ID: `api_admin_reset_user_progress_api_v1_admin_org_slug_progress_user_id_course_uuid`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/progress/{user_id}/{course_uuid}/reset`
|
||||
- Mode: WRITE
|
||||
- Summary: Reset a user's progress in a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_award_certificate_api_v1_admin_org_slug_certifications_user_id_course_
|
||||
|
||||
- Operation ID: `api_admin_award_certificate_api_v1_admin_org_slug_certifications_user_id_course_`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/certifications/{user_id}/{course_uuid}/award`
|
||||
- Mode: WRITE
|
||||
- Summary: Manually award a certificate
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_revoke_certificate_api_v1_admin_org_slug_certifications_user_id_user_c
|
||||
|
||||
- Operation ID: `api_admin_revoke_certificate_api_v1_admin_org_slug_certifications_user_id_user_c`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/certifications/{user_id}/{user_certification_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Revoke a user's certificate
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- `user_certification_uuid` in `path` required
|
||||
|
||||
### api_admin_add_usergroup_member_api_v1_admin_org_slug_usergroups_usergroup_uuid_m
|
||||
|
||||
- Operation ID: `api_admin_add_usergroup_member_api_v1_admin_org_slug_usergroups_usergroup_uuid_m`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Add a user to a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_remove_usergroup_member_api_v1_admin_org_slug_usergroups_usergroup_uui
|
||||
|
||||
- Operation ID: `api_admin_remove_usergroup_member_api_v1_admin_org_slug_usergroups_usergroup_uui`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Remove a user from a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_change_user_role_api_v1_admin_org_slug_users_user_id_role_patch
|
||||
|
||||
- Operation ID: `api_admin_change_user_role_api_v1_admin_org_slug_users_user_id_role_patch`
|
||||
- Route: `PATCH /api/v1/admin/{org_slug}/users/{user_id}/role`
|
||||
- Mode: WRITE
|
||||
- Summary: Change a user's org role
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_create_usergroup_api_v1_admin_org_slug_usergroups_post
|
||||
|
||||
- Operation ID: `api_admin_create_usergroup_api_v1_admin_org_slug_usergroups_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/usergroups`
|
||||
- Mode: WRITE
|
||||
- Summary: Create a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_admin_delete_usergroup_api_v1_admin_org_slug_usergroups_usergroup_uuid_delet
|
||||
|
||||
- Operation ID: `api_admin_delete_usergroup_api_v1_admin_org_slug_usergroups_usergroup_uuid_delet`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
|
||||
### api_admin_list_usergroup_members_api_v1_admin_org_slug_usergroups_usergroup_uuid
|
||||
|
||||
- Operation ID: `api_admin_list_usergroup_members_api_v1_admin_org_slug_usergroups_usergroup_uuid`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/members`
|
||||
- Mode: READ
|
||||
- Summary: List members of a user group
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
|
||||
### api_admin_get_user_groups_api_v1_admin_org_slug_users_user_id_groups_get
|
||||
|
||||
- Operation ID: `api_admin_get_user_groups_api_v1_admin_org_slug_users_user_id_groups_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/users/{user_id}/groups`
|
||||
- Mode: READ
|
||||
- Summary: List user groups a user belongs to
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_add_course_to_usergroup_api_v1_admin_org_slug_usergroups_usergroup_uui
|
||||
|
||||
- Operation ID: `api_admin_add_course_to_usergroup_api_v1_admin_org_slug_usergroups_usergroup_uui`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/courses/{course_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Grant a cohort access to a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_remove_course_from_usergroup_api_v1_admin_org_slug_usergroups_usergrou
|
||||
|
||||
- Operation ID: `api_admin_remove_course_from_usergroup_api_v1_admin_org_slug_usergroups_usergrou`
|
||||
- Route: `DELETE /api/v1/admin/{org_slug}/usergroups/{usergroup_uuid}/courses/{course_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Revoke a cohort's access to a course
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `usergroup_uuid` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_admin_export_user_data_api_v1_admin_org_slug_users_user_id_export_get
|
||||
|
||||
- Operation ID: `api_admin_export_user_data_api_v1_admin_org_slug_users_user_id_export_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/users/{user_id}/export`
|
||||
- Mode: READ
|
||||
- Summary: Full GDPR data export for a user
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_anonymize_user_api_v1_admin_org_slug_users_user_id_anonymize_post
|
||||
### api_admin_anonymize_user_api_v1_admin_org_slug_users_c139c61306
|
||||
|
||||
- Operation ID: `api_admin_anonymize_user_api_v1_admin_org_slug_users_user_id_anonymize_post`
|
||||
- Route: `POST /api/v1/admin/{org_slug}/users/{user_id}/anonymize`
|
||||
@@ -394,12 +373,33 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_get_course_analytics_api_v1_admin_org_slug_courses_course_uuid_analyti
|
||||
### api_admin_export_user_data_api_v1_admin_org_slug_user_6635cbdeac
|
||||
|
||||
- Operation ID: `api_admin_get_course_analytics_api_v1_admin_org_slug_courses_course_uuid_analyti`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/courses/{course_uuid}/analytics`
|
||||
- Operation ID: `api_admin_export_user_data_api_v1_admin_org_slug_users_user_id_export_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/users/{user_id}/export`
|
||||
- Mode: READ
|
||||
- Summary: Aggregate stats for a course
|
||||
- Summary: Full GDPR data export for a user
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_get_user_groups_api_v1_admin_org_slug_users_d6394b6aa3
|
||||
|
||||
- Operation ID: `api_admin_get_user_groups_api_v1_admin_org_slug_users_user_id_groups_get`
|
||||
- Route: `GET /api/v1/admin/{org_slug}/users/{user_id}/groups`
|
||||
- Mode: READ
|
||||
- Summary: List user groups a user belongs to
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_admin_change_user_role_api_v1_admin_org_slug_user_8865c0c139
|
||||
|
||||
- Operation ID: `api_admin_change_user_role_api_v1_admin_org_slug_users_user_id_role_patch`
|
||||
- Route: `PATCH /api/v1/admin/{org_slug}/users/{user_id}/role`
|
||||
- Mode: WRITE
|
||||
- Summary: Change a user's org role
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -13,60 +13,53 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### api_ai_start_activity_chat_session_api_v1_ai_start_activity_chat_session_post
|
||||
### finalize_course_plan_api_v1_ai_courseplanning_finalize_post
|
||||
|
||||
- Operation ID: `api_ai_start_activity_chat_session_api_v1_ai_start_activity_chat_session_post`
|
||||
- Route: `POST /api/v1/ai/start/activity_chat_session`
|
||||
- Operation ID: `finalize_course_plan_api_v1_ai_courseplanning_finalize_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/finalize`
|
||||
- Mode: WRITE
|
||||
- Summary: Start activity AI chat session
|
||||
- Summary: Finalize course plan
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_ai_send_activity_chat_message_api_v1_ai_send_activity_chat_message_post
|
||||
### generate_activity_content_api_v1_ai_courseplanning_ge_5b69f64714
|
||||
|
||||
- Operation ID: `api_ai_send_activity_chat_message_api_v1_ai_send_activity_chat_message_post`
|
||||
- Route: `POST /api/v1/ai/send/activity_chat_message`
|
||||
- Operation ID: `generate_activity_content_api_v1_ai_courseplanning_generate_activity_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/generate-activity`
|
||||
- Mode: WRITE
|
||||
- Summary: Send activity AI chat message
|
||||
- Summary: Generate activity content (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_ai_start_activity_chat_session_stream_api_v1_ai_stream_start_activity_chat_s
|
||||
### iterate_course_planning_session_api_v1_ai_courseplann_fcddd5c16c
|
||||
|
||||
- Operation ID: `api_ai_start_activity_chat_session_stream_api_v1_ai_stream_start_activity_chat_s`
|
||||
- Route: `POST /api/v1/ai/stream/start/activity_chat_session`
|
||||
- Operation ID: `iterate_course_planning_session_api_v1_ai_courseplanning_iterate_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/iterate`
|
||||
- Mode: WRITE
|
||||
- Summary: Start activity AI chat session (streaming)
|
||||
- Summary: Iterate course planning session (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_ai_send_activity_chat_message_stream_api_v1_ai_stream_send_activity_chat_mes
|
||||
### save_activity_content_api_v1_ai_courseplanning_save_a_d3dd4f9c10
|
||||
|
||||
- Operation ID: `api_ai_send_activity_chat_message_stream_api_v1_ai_stream_send_activity_chat_mes`
|
||||
- Route: `POST /api/v1/ai/stream/send/activity_chat_message`
|
||||
- Operation ID: `save_activity_content_api_v1_ai_courseplanning_save_activity_content_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/save-activity-content`
|
||||
- Mode: WRITE
|
||||
- Summary: Send activity AI chat message (streaming)
|
||||
- Summary: Save AI-generated activity content
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_editor_ai_start_chat_session_stream_api_v1_ai_stream_editor_start_post
|
||||
### get_session_state_api_v1_ai_courseplanning_session_se_20cccc01b5
|
||||
|
||||
- Operation ID: `api_editor_ai_start_chat_session_stream_api_v1_ai_stream_editor_start_post`
|
||||
- Route: `POST /api/v1/ai/stream/editor/start`
|
||||
- Operation ID: `get_session_state_api_v1_ai_courseplanning_session_session_uuid_get`
|
||||
- Route: `GET /api/v1/ai/courseplanning/session/{session_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get course planning session state
|
||||
- Parameters:
|
||||
- `session_uuid` in `path` required
|
||||
|
||||
### start_course_planning_session_api_v1_ai_courseplannin_c933cdf9de
|
||||
|
||||
- Operation ID: `start_course_planning_session_api_v1_ai_courseplanning_start_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/start`
|
||||
- Mode: WRITE
|
||||
- Summary: Start editor AI chat session (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_editor_ai_send_message_stream_api_v1_ai_stream_editor_message_post
|
||||
|
||||
- Operation ID: `api_editor_ai_send_message_stream_api_v1_ai_stream_editor_message_post`
|
||||
- Route: `POST /api/v1/ai/stream/editor/message`
|
||||
- Mode: WRITE
|
||||
- Summary: Send editor AI chat message (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### start_magicblock_session_api_v1_ai_magicblocks_start_post
|
||||
|
||||
- Operation ID: `start_magicblock_session_api_v1_ai_magicblocks_start_post`
|
||||
- Route: `POST /api/v1/ai/magicblocks/start`
|
||||
- Mode: WRITE
|
||||
- Summary: Start MagicBlock session (streaming)
|
||||
- Summary: Start course planning session (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### iterate_magicblock_session_api_v1_ai_magicblocks_iterate_post
|
||||
@@ -86,55 +79,14 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `session_uuid` in `path` required
|
||||
|
||||
### start_course_planning_session_api_v1_ai_courseplanning_start_post
|
||||
### start_magicblock_session_api_v1_ai_magicblocks_start_post
|
||||
|
||||
- Operation ID: `start_course_planning_session_api_v1_ai_courseplanning_start_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/start`
|
||||
- Operation ID: `start_magicblock_session_api_v1_ai_magicblocks_start_post`
|
||||
- Route: `POST /api/v1/ai/magicblocks/start`
|
||||
- Mode: WRITE
|
||||
- Summary: Start course planning session (streaming)
|
||||
- Summary: Start MagicBlock session (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### iterate_course_planning_session_api_v1_ai_courseplanning_iterate_post
|
||||
|
||||
- Operation ID: `iterate_course_planning_session_api_v1_ai_courseplanning_iterate_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/iterate`
|
||||
- Mode: WRITE
|
||||
- Summary: Iterate course planning session (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### finalize_course_plan_api_v1_ai_courseplanning_finalize_post
|
||||
|
||||
- Operation ID: `finalize_course_plan_api_v1_ai_courseplanning_finalize_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/finalize`
|
||||
- Mode: WRITE
|
||||
- Summary: Finalize course plan
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### generate_activity_content_api_v1_ai_courseplanning_generate_activity_post
|
||||
|
||||
- Operation ID: `generate_activity_content_api_v1_ai_courseplanning_generate_activity_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/generate-activity`
|
||||
- Mode: WRITE
|
||||
- Summary: Generate activity content (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### save_activity_content_api_v1_ai_courseplanning_save_activity_content_post
|
||||
|
||||
- Operation ID: `save_activity_content_api_v1_ai_courseplanning_save_activity_content_post`
|
||||
- Route: `POST /api/v1/ai/courseplanning/save-activity-content`
|
||||
- Mode: WRITE
|
||||
- Summary: Save AI-generated activity content
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### get_session_state_api_v1_ai_courseplanning_session_session_uuid_get
|
||||
|
||||
- Operation ID: `get_session_state_api_v1_ai_courseplanning_session_session_uuid_get`
|
||||
- Route: `GET /api/v1/ai/courseplanning/session/{session_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get course planning session state
|
||||
- Parameters:
|
||||
- `session_uuid` in `path` required
|
||||
|
||||
### api_rag_chat_api_v1_ai_rag_chat_post
|
||||
|
||||
- Operation ID: `api_rag_chat_api_v1_ai_rag_chat_post`
|
||||
@@ -160,15 +112,6 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `org_slug` in `query`
|
||||
|
||||
### api_rag_session_messages_api_v1_ai_rag_sessions_aichat_uuid_messages_get
|
||||
|
||||
- Operation ID: `api_rag_session_messages_api_v1_ai_rag_sessions_aichat_uuid_messages_get`
|
||||
- Route: `GET /api/v1/ai/rag/sessions/{aichat_uuid}/messages`
|
||||
- Mode: READ
|
||||
- Summary: Get RAG chat session messages
|
||||
- Parameters:
|
||||
- `aichat_uuid` in `path` required
|
||||
|
||||
### api_rag_session_delete_api_v1_ai_rag_sessions_aichat_uuid_delete
|
||||
|
||||
- Operation ID: `api_rag_session_delete_api_v1_ai_rag_sessions_aichat_uuid_delete`
|
||||
@@ -187,3 +130,60 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `aichat_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_rag_session_messages_api_v1_ai_rag_sessions_aicha_93db1eb0a3
|
||||
|
||||
- Operation ID: `api_rag_session_messages_api_v1_ai_rag_sessions_aichat_uuid_messages_get`
|
||||
- Route: `GET /api/v1/ai/rag/sessions/{aichat_uuid}/messages`
|
||||
- Mode: READ
|
||||
- Summary: Get RAG chat session messages
|
||||
- Parameters:
|
||||
- `aichat_uuid` in `path` required
|
||||
|
||||
### api_ai_send_activity_chat_message_api_v1_ai_send_acti_8d30491e5d
|
||||
|
||||
- Operation ID: `api_ai_send_activity_chat_message_api_v1_ai_send_activity_chat_message_post`
|
||||
- Route: `POST /api/v1/ai/send/activity_chat_message`
|
||||
- Mode: WRITE
|
||||
- Summary: Send activity AI chat message
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_ai_start_activity_chat_session_api_v1_ai_start_ac_d961c7ae9c
|
||||
|
||||
- Operation ID: `api_ai_start_activity_chat_session_api_v1_ai_start_activity_chat_session_post`
|
||||
- Route: `POST /api/v1/ai/start/activity_chat_session`
|
||||
- Mode: WRITE
|
||||
- Summary: Start activity AI chat session
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_editor_ai_send_message_stream_api_v1_ai_stream_ed_ee3d464bfd
|
||||
|
||||
- Operation ID: `api_editor_ai_send_message_stream_api_v1_ai_stream_editor_message_post`
|
||||
- Route: `POST /api/v1/ai/stream/editor/message`
|
||||
- Mode: WRITE
|
||||
- Summary: Send editor AI chat message (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_editor_ai_start_chat_session_stream_api_v1_ai_str_5c40758487
|
||||
|
||||
- Operation ID: `api_editor_ai_start_chat_session_stream_api_v1_ai_stream_editor_start_post`
|
||||
- Route: `POST /api/v1/ai/stream/editor/start`
|
||||
- Mode: WRITE
|
||||
- Summary: Start editor AI chat session (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_ai_send_activity_chat_message_stream_api_v1_ai_st_7782e357c5
|
||||
|
||||
- Operation ID: `api_ai_send_activity_chat_message_stream_api_v1_ai_stream_send_activity_chat_mes`
|
||||
- Route: `POST /api/v1/ai/stream/send/activity_chat_message`
|
||||
- Mode: WRITE
|
||||
- Summary: Send activity AI chat message (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_ai_start_activity_chat_session_stream_api_v1_ai_s_660f1d8627
|
||||
|
||||
- Operation ID: `api_ai_start_activity_chat_session_stream_api_v1_ai_stream_start_activity_chat_s`
|
||||
- Route: `POST /api/v1/ai/stream/start/activity_chat_session`
|
||||
- Mode: WRITE
|
||||
- Summary: Start activity AI chat session (streaming)
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -13,22 +13,39 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### analytics_status_api_v1_analytics_status_get
|
||||
### query_course_dashboard_detail_api_v1_analytics_dashbo_685fbd7181
|
||||
|
||||
- Operation ID: `analytics_status_api_v1_analytics_status_get`
|
||||
- Route: `GET /api/v1/analytics/status`
|
||||
- Operation ID: `query_course_dashboard_detail_api_v1_analytics_dashboard_course_detail_query_nam`
|
||||
- Route: `GET /api/v1/analytics/dashboard/course/detail/{query_name}`
|
||||
- Mode: READ
|
||||
- Summary: Check analytics configuration
|
||||
- Summary: Run a course-level detail analytics query
|
||||
- Parameters:
|
||||
- `query_name` in `path` required
|
||||
- `org_id` in `query` required
|
||||
- `course_uuid` in `query` required
|
||||
|
||||
### ingest_frontend_event_api_v1_analytics_events_post
|
||||
### query_course_dashboard_api_v1_analytics_dashboard_cou_99f6534696
|
||||
|
||||
- Operation ID: `ingest_frontend_event_api_v1_analytics_events_post`
|
||||
- Route: `POST /api/v1/analytics/events`
|
||||
- Mode: WRITE
|
||||
- Summary: Ingest a frontend analytics event
|
||||
- Body: JSON request body accepted.
|
||||
- Operation ID: `query_course_dashboard_api_v1_analytics_dashboard_course_query_name_get`
|
||||
- Route: `GET /api/v1/analytics/dashboard/course/{query_name}`
|
||||
- Mode: READ
|
||||
- Summary: Run a course-level analytics query
|
||||
- Parameters:
|
||||
- `query_name` in `path` required
|
||||
- `org_id` in `query` required
|
||||
- `course_uuid` in `query` required
|
||||
|
||||
### query_dashboard_detail_api_v1_analytics_dashboard_detail_query_name_get
|
||||
### query_dashboard_db_api_v1_analytics_dashboard_db_query_name_get
|
||||
|
||||
- Operation ID: `query_dashboard_db_api_v1_analytics_dashboard_db_query_name_get`
|
||||
- Route: `GET /api/v1/analytics/dashboard/db/{query_name}`
|
||||
- Mode: READ
|
||||
- Summary: Run a PostgreSQL-backed dashboard query
|
||||
- Parameters:
|
||||
- `query_name` in `path` required
|
||||
- `org_id` in `query` required
|
||||
|
||||
### query_dashboard_detail_api_v1_analytics_dashboard_det_7aa7e71f25
|
||||
|
||||
- Operation ID: `query_dashboard_detail_api_v1_analytics_dashboard_detail_query_name_get`
|
||||
- Route: `GET /api/v1/analytics/dashboard/detail/{query_name}`
|
||||
@@ -48,37 +65,13 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `query_name` in `path` required
|
||||
- `org_id` in `query` required
|
||||
|
||||
### query_dashboard_db_api_v1_analytics_dashboard_db_query_name_get
|
||||
### ingest_frontend_event_api_v1_analytics_events_post
|
||||
|
||||
- Operation ID: `query_dashboard_db_api_v1_analytics_dashboard_db_query_name_get`
|
||||
- Route: `GET /api/v1/analytics/dashboard/db/{query_name}`
|
||||
- Mode: READ
|
||||
- Summary: Run a PostgreSQL-backed dashboard query
|
||||
- Parameters:
|
||||
- `query_name` in `path` required
|
||||
- `org_id` in `query` required
|
||||
|
||||
### query_course_dashboard_detail_api_v1_analytics_dashboard_course_detail_query_nam
|
||||
|
||||
- Operation ID: `query_course_dashboard_detail_api_v1_analytics_dashboard_course_detail_query_nam`
|
||||
- Route: `GET /api/v1/analytics/dashboard/course/detail/{query_name}`
|
||||
- Mode: READ
|
||||
- Summary: Run a course-level detail analytics query
|
||||
- Parameters:
|
||||
- `query_name` in `path` required
|
||||
- `org_id` in `query` required
|
||||
- `course_uuid` in `query` required
|
||||
|
||||
### query_course_dashboard_api_v1_analytics_dashboard_course_query_name_get
|
||||
|
||||
- Operation ID: `query_course_dashboard_api_v1_analytics_dashboard_course_query_name_get`
|
||||
- Route: `GET /api/v1/analytics/dashboard/course/{query_name}`
|
||||
- Mode: READ
|
||||
- Summary: Run a course-level analytics query
|
||||
- Parameters:
|
||||
- `query_name` in `path` required
|
||||
- `org_id` in `query` required
|
||||
- `course_uuid` in `query` required
|
||||
- Operation ID: `ingest_frontend_event_api_v1_analytics_events_post`
|
||||
- Route: `POST /api/v1/analytics/events`
|
||||
- Mode: WRITE
|
||||
- Summary: Ingest a frontend analytics event
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### export_analytics_api_v1_analytics_export_get
|
||||
|
||||
@@ -97,3 +90,10 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Get analytics plan tier for an organization
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
|
||||
### analytics_status_api_v1_analytics_status_get
|
||||
|
||||
- Operation ID: `analytics_status_api_v1_analytics_status_get`
|
||||
- Route: `GET /api/v1/analytics/status`
|
||||
- Mode: READ
|
||||
- Summary: Check analytics configuration
|
||||
|
||||
@@ -21,6 +21,51 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Create assignment
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_assignment_from_activity_api_v1_assignment_03b43fbe63
|
||||
|
||||
- Operation ID: `api_delete_assignment_from_activity_api_v1_assignments_activity_activity_uuid_de`
|
||||
- Route: `DELETE /api/v1/assignments/activity/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete assignment by activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_read_assignment_from_activity_api_v1_assignments_15438e211d
|
||||
|
||||
- Operation ID: `api_read_assignment_from_activity_api_v1_assignments_activity_activity_uuid_get`
|
||||
- Route: `GET /api/v1/assignments/activity/{activity_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get assignment by activity
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_get_assignments_api_v1_assignments_course_course_uuid_get
|
||||
|
||||
- Operation ID: `api_get_assignments_api_v1_assignments_course_course_uuid_get`
|
||||
- Route: `GET /api/v1/assignments/course/{course_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: List course assignments
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_read_assignment_task_api_v1_assignments_task_assi_f5b895f41d
|
||||
|
||||
- Operation ID: `api_read_assignment_task_api_v1_assignments_task_assignment_task_uuid_get`
|
||||
- Route: `GET /api/v1/assignments/task/{assignment_task_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get assignment task
|
||||
- Parameters:
|
||||
- `assignment_task_uuid` in `path` required
|
||||
|
||||
### api_delete_assignment_api_v1_assignments_assignment_uuid_delete
|
||||
|
||||
- Operation ID: `api_delete_assignment_api_v1_assignments_assignment_uuid_delete`
|
||||
- Route: `DELETE /api/v1/assignments/{assignment_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete assignment
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_assignment_api_v1_assignments_assignment_uuid_get
|
||||
|
||||
- Operation ID: `api_read_assignment_api_v1_assignments_assignment_uuid_get`
|
||||
@@ -40,34 +85,116 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `assignment_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_assignment_api_v1_assignments_assignment_uuid_delete
|
||||
### api_read_assignment_submissions_api_v1_assignments_as_a37a62d4fd
|
||||
|
||||
- Operation ID: `api_delete_assignment_api_v1_assignments_assignment_uuid_delete`
|
||||
- Route: `DELETE /api/v1/assignments/{assignment_uuid}`
|
||||
- Operation ID: `api_read_assignment_submissions_api_v1_assignments_assignment_uuid_submissions_g`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions`
|
||||
- Mode: READ
|
||||
- Summary: List assignment submissions
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `limit` in `query`
|
||||
- `offset` in `query`
|
||||
|
||||
### api_create_assignment_submissions_api_v1_assignments_ed06af7175
|
||||
|
||||
- Operation ID: `api_create_assignment_submissions_api_v1_assignments_assignment_uuid_submissions`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete assignment
|
||||
- Summary: Create assignment submission
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_assignment_from_activity_api_v1_assignments_activity_activity_uuid_get
|
||||
### api_read_user_assignment_submission_me_api_v1_assignm_fe3bf8fda6
|
||||
|
||||
- Operation ID: `api_read_assignment_from_activity_api_v1_assignments_activity_activity_uuid_get`
|
||||
- Route: `GET /api/v1/assignments/activity/{activity_uuid}`
|
||||
- Operation ID: `api_read_user_assignment_submission_me_api_v1_assignments_assignment_uuid_submis`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/me`
|
||||
- Mode: READ
|
||||
- Summary: Get assignment by activity
|
||||
- Summary: Get current user's assignment submission
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_delete_assignment_from_activity_api_v1_assignments_activity_activity_uuid_de
|
||||
### api_retry_assignment_submission_api_v1_assignments_as_8d4519952a
|
||||
|
||||
- Operation ID: `api_delete_assignment_from_activity_api_v1_assignments_activity_activity_uuid_de`
|
||||
- Route: `DELETE /api/v1/assignments/activity/{activity_uuid}`
|
||||
- Operation ID: `api_retry_assignment_submission_api_v1_assignments_assignment_uuid_submissions_m`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/me/retry`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete assignment by activity
|
||||
- Summary: Retry assignment for current user
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_create_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_post
|
||||
### api_delete_user_assignment_submissions_api_v1_assignm_603b7be994
|
||||
|
||||
- Operation ID: `api_delete_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis`
|
||||
- Route: `DELETE /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete assignment submission for user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_read_user_assignment_submissions_api_v1_assignmen_418c30c0cc
|
||||
|
||||
- Operation ID: `api_read_user_assignment_submissions_api_v1_assignments_assignment_uuid_submissi`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get assignment submission for user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_update_user_assignment_submissions_api_v1_assignm_448f3c3b93
|
||||
|
||||
- Operation ID: `api_update_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis`
|
||||
- Route: `PUT /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update assignment submission for user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_submission_mark_as_done_api_v1_assignments_assign_b02ccec981
|
||||
|
||||
- Operation ID: `api_submission_mark_as_done_api_v1_assignments_assignment_uuid_submissions_user_`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/done`
|
||||
- Mode: WRITE
|
||||
- Summary: Mark assignment as done for user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_get_submission_grade_api_v1_assignments_assignmen_b024cafc47
|
||||
|
||||
- Operation ID: `api_get_submission_grade_api_v1_assignments_assignment_uuid_submissions_user_id_`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/grade`
|
||||
- Mode: READ
|
||||
- Summary: Get assignment submission grade
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_final_grade_submission_api_v1_assignments_assignm_11826cf3af
|
||||
|
||||
- Operation ID: `api_final_grade_submission_api_v1_assignments_assignment_uuid_submissions_user_i`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/grade`
|
||||
- Mode: WRITE
|
||||
- Summary: Finalize assignment submission grade
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_read_assignment_tasks_api_v1_assignments_assignme_1e93416d91
|
||||
|
||||
- Operation ID: `api_read_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_get`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks`
|
||||
- Mode: READ
|
||||
- Summary: List assignment tasks
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_create_assignment_tasks_api_v1_assignments_assign_bcb71120f2
|
||||
|
||||
- Operation ID: `api_create_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_post`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/tasks`
|
||||
@@ -77,25 +204,26 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `assignment_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_read_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_get
|
||||
### api_read_user_assignment_task_submissions_me_batch_ap_fc9cf6bb95
|
||||
|
||||
- Operation ID: `api_read_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_get`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks`
|
||||
- Operation ID: `api_read_user_assignment_task_submissions_me_batch_api_v1_assignments_assignment`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/submissions/me`
|
||||
- Mode: READ
|
||||
- Summary: List assignment tasks
|
||||
- Summary: Batch read current user's task submissions
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_assignment_task_api_v1_assignments_task_assignment_task_uuid_get
|
||||
### api_delete_assignment_tasks_api_v1_assignments_assign_3f54457409
|
||||
|
||||
- Operation ID: `api_read_assignment_task_api_v1_assignments_task_assignment_task_uuid_get`
|
||||
- Route: `GET /api/v1/assignments/task/{assignment_task_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get assignment task
|
||||
- Operation ID: `api_delete_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_`
|
||||
- Route: `DELETE /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete assignment task
|
||||
- Parameters:
|
||||
- `assignment_task_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_update_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_
|
||||
### api_update_assignment_tasks_api_v1_assignments_assign_8d462d2dd6
|
||||
|
||||
- Operation ID: `api_update_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_`
|
||||
- Route: `PUT /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}`
|
||||
@@ -106,17 +234,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `assignment_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_
|
||||
|
||||
- Operation ID: `api_delete_assignment_tasks_api_v1_assignments_assignment_uuid_tasks_assignment_`
|
||||
- Route: `DELETE /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete assignment task
|
||||
- Parameters:
|
||||
- `assignment_task_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_put_assignment_task_ref_file_api_v1_assignments_assignment_uuid_tasks_assign
|
||||
### api_put_assignment_task_ref_file_api_v1_assignments_a_96815eea6b
|
||||
|
||||
- Operation ID: `api_put_assignment_task_ref_file_api_v1_assignments_assignment_uuid_tasks_assign`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/ref_file`
|
||||
@@ -127,7 +245,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `assignment_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_put_assignment_task_sub_file_api_v1_assignments_assignment_uuid_tasks_assign
|
||||
### api_put_assignment_task_sub_file_api_v1_assignments_a_cb17029db0
|
||||
|
||||
- Operation ID: `api_put_assignment_task_sub_file_api_v1_assignments_assignment_uuid_tasks_assign`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/sub_file`
|
||||
@@ -138,18 +256,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `assignment_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_handle_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_
|
||||
|
||||
- Operation ID: `api_handle_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_`
|
||||
- Route: `PUT /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions`
|
||||
- Mode: WRITE
|
||||
- Summary: Upsert assignment task submission
|
||||
- Parameters:
|
||||
- `assignment_task_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_read_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_as
|
||||
### api_read_assignment_task_submissions_api_v1_assignmen_033c29b5c6
|
||||
|
||||
- Operation ID: `api_read_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_as`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions`
|
||||
@@ -161,7 +268,28 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `offset` in `query`
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_user_assignment_task_submissions_api_v1_assignments_assignment_uuid_tas
|
||||
### api_handle_assignment_task_submissions_api_v1_assignm_5861bf59b4
|
||||
|
||||
- Operation ID: `api_handle_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_`
|
||||
- Route: `PUT /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions`
|
||||
- Mode: WRITE
|
||||
- Summary: Upsert assignment task submission
|
||||
- Parameters:
|
||||
- `assignment_task_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_read_user_assignment_task_submissions_me_api_v1_a_1e22c33789
|
||||
|
||||
- Operation ID: `api_read_user_assignment_task_submissions_me_api_v1_assignments_assignment_uuid_`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions/me`
|
||||
- Mode: READ
|
||||
- Summary: Get current user's task submission
|
||||
- Parameters:
|
||||
- `assignment_task_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_user_assignment_task_submissions_api_v1_assi_8aad7676b8
|
||||
|
||||
- Operation ID: `api_read_user_assignment_task_submissions_api_v1_assignments_assignment_uuid_tas`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions/user/{user_id}`
|
||||
@@ -172,26 +300,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `user_id` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_user_assignment_task_submissions_me_batch_api_v1_assignments_assignment
|
||||
|
||||
- Operation ID: `api_read_user_assignment_task_submissions_me_batch_api_v1_assignments_assignment`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/submissions/me`
|
||||
- Mode: READ
|
||||
- Summary: Batch read current user's task submissions
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_user_assignment_task_submissions_me_api_v1_assignments_assignment_uuid_
|
||||
|
||||
- Operation ID: `api_read_user_assignment_task_submissions_me_api_v1_assignments_assignment_uuid_`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions/me`
|
||||
- Mode: READ
|
||||
- Summary: Get current user's task submission
|
||||
- Parameters:
|
||||
- `assignment_task_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_delete_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_
|
||||
### api_delete_assignment_task_submissions_api_v1_assignm_9a21ef312c
|
||||
|
||||
- Operation ID: `api_delete_assignment_task_submissions_api_v1_assignments_assignment_uuid_tasks_`
|
||||
- Route: `DELETE /api/v1/assignments/{assignment_uuid}/tasks/{assignment_task_uuid}/submissions/{assignment_task_submission_uuid}`
|
||||
@@ -201,112 +310,3 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `assignment_task_submission_uuid` in `path` required
|
||||
- `assignment_uuid` in `path` required
|
||||
- `assignment_task_uuid` in `path` required
|
||||
|
||||
### api_create_assignment_submissions_api_v1_assignments_assignment_uuid_submissions
|
||||
|
||||
- Operation ID: `api_create_assignment_submissions_api_v1_assignments_assignment_uuid_submissions`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions`
|
||||
- Mode: WRITE
|
||||
- Summary: Create assignment submission
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_assignment_submissions_api_v1_assignments_assignment_uuid_submissions_g
|
||||
|
||||
- Operation ID: `api_read_assignment_submissions_api_v1_assignments_assignment_uuid_submissions_g`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions`
|
||||
- Mode: READ
|
||||
- Summary: List assignment submissions
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `limit` in `query`
|
||||
- `offset` in `query`
|
||||
|
||||
### api_read_user_assignment_submission_me_api_v1_assignments_assignment_uuid_submis
|
||||
|
||||
- Operation ID: `api_read_user_assignment_submission_me_api_v1_assignments_assignment_uuid_submis`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/me`
|
||||
- Mode: READ
|
||||
- Summary: Get current user's assignment submission
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_read_user_assignment_submissions_api_v1_assignments_assignment_uuid_submissi
|
||||
|
||||
- Operation ID: `api_read_user_assignment_submissions_api_v1_assignments_assignment_uuid_submissi`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get assignment submission for user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_update_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis
|
||||
|
||||
- Operation ID: `api_update_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis`
|
||||
- Route: `PUT /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update assignment submission for user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis
|
||||
|
||||
- Operation ID: `api_delete_user_assignment_submissions_api_v1_assignments_assignment_uuid_submis`
|
||||
- Route: `DELETE /api/v1/assignments/{assignment_uuid}/submissions/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete assignment submission for user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_get_submission_grade_api_v1_assignments_assignment_uuid_submissions_user_id_
|
||||
|
||||
- Operation ID: `api_get_submission_grade_api_v1_assignments_assignment_uuid_submissions_user_id_`
|
||||
- Route: `GET /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/grade`
|
||||
- Mode: READ
|
||||
- Summary: Get assignment submission grade
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_final_grade_submission_api_v1_assignments_assignment_uuid_submissions_user_i
|
||||
|
||||
- Operation ID: `api_final_grade_submission_api_v1_assignments_assignment_uuid_submissions_user_i`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/grade`
|
||||
- Mode: WRITE
|
||||
- Summary: Finalize assignment submission grade
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_retry_assignment_submission_api_v1_assignments_assignment_uuid_submissions_m
|
||||
|
||||
- Operation ID: `api_retry_assignment_submission_api_v1_assignments_assignment_uuid_submissions_m`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/me/retry`
|
||||
- Mode: WRITE
|
||||
- Summary: Retry assignment for current user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
|
||||
### api_submission_mark_as_done_api_v1_assignments_assignment_uuid_submissions_user_
|
||||
|
||||
- Operation ID: `api_submission_mark_as_done_api_v1_assignments_assignment_uuid_submissions_user_`
|
||||
- Route: `POST /api/v1/assignments/{assignment_uuid}/submissions/{user_id}/done`
|
||||
- Mode: WRITE
|
||||
- Summary: Mark assignment as done for user
|
||||
- Parameters:
|
||||
- `assignment_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_get_assignments_api_v1_assignments_course_course_uuid_get
|
||||
|
||||
- Operation ID: `api_get_assignments_api_v1_assignments_course_course_uuid_get`
|
||||
- Route: `GET /api/v1/assignments/course/{course_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: List course assignments
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
@@ -13,13 +13,6 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### refresh_api_v1_auth_refresh_get
|
||||
|
||||
- Operation ID: `refresh_api_v1_auth_refresh_get`
|
||||
- Route: `GET /api/v1/auth/refresh`
|
||||
- Mode: READ
|
||||
- Summary: Refresh access token
|
||||
|
||||
### login_api_v1_auth_login_post
|
||||
|
||||
- Operation ID: `login_api_v1_auth_login_post`
|
||||
@@ -28,6 +21,13 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Log in with email and password
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### logout_api_v1_auth_logout_delete
|
||||
|
||||
- Operation ID: `logout_api_v1_auth_logout_delete`
|
||||
- Route: `DELETE /api/v1/auth/logout`
|
||||
- Mode: WRITE
|
||||
- Summary: Log out the current user
|
||||
|
||||
### third_party_login_api_v1_auth_oauth_post
|
||||
|
||||
- Operation ID: `third_party_login_api_v1_auth_oauth_post`
|
||||
@@ -38,12 +38,20 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_id` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### logout_api_v1_auth_logout_delete
|
||||
### refresh_api_v1_auth_refresh_get
|
||||
|
||||
- Operation ID: `logout_api_v1_auth_logout_delete`
|
||||
- Route: `DELETE /api/v1/auth/logout`
|
||||
- Operation ID: `refresh_api_v1_auth_refresh_get`
|
||||
- Route: `GET /api/v1/auth/refresh`
|
||||
- Mode: READ
|
||||
- Summary: Refresh access token
|
||||
|
||||
### api_resend_verification_email_api_v1_auth_resend_veri_048a435ed9
|
||||
|
||||
- Operation ID: `api_resend_verification_email_api_v1_auth_resend_verification_post`
|
||||
- Route: `POST /api/v1/auth/resend-verification`
|
||||
- Mode: WRITE
|
||||
- Summary: Log out the current user
|
||||
- Summary: Resend verification email
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_verify_email_api_v1_auth_verify_email_post
|
||||
|
||||
@@ -52,11 +60,3 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Mode: WRITE
|
||||
- Summary: Verify user email
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_resend_verification_email_api_v1_auth_resend_verification_post
|
||||
|
||||
- Operation ID: `api_resend_verification_email_api_v1_auth_resend_verification_post`
|
||||
- Route: `POST /api/v1/auth/resend-verification`
|
||||
- Mode: WRITE
|
||||
- Summary: Resend verification email
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -13,54 +13,12 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### api_create_image_file_block_api_v1_blocks_image_post
|
||||
### api_get_audio_file_block_api_v1_blocks_audio_get
|
||||
|
||||
- Operation ID: `api_create_image_file_block_api_v1_blocks_image_post`
|
||||
- Route: `POST /api/v1/blocks/image`
|
||||
- Mode: WRITE
|
||||
- Summary: Create image block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_image_file_block_api_v1_blocks_image_get
|
||||
|
||||
- Operation ID: `api_get_image_file_block_api_v1_blocks_image_get`
|
||||
- Route: `GET /api/v1/blocks/image`
|
||||
- Operation ID: `api_get_audio_file_block_api_v1_blocks_audio_get`
|
||||
- Route: `GET /api/v1/blocks/audio`
|
||||
- Mode: READ
|
||||
- Summary: Get image block
|
||||
- Parameters:
|
||||
- `block_uuid` in `query` required
|
||||
|
||||
### api_create_video_file_block_api_v1_blocks_video_post
|
||||
|
||||
- Operation ID: `api_create_video_file_block_api_v1_blocks_video_post`
|
||||
- Route: `POST /api/v1/blocks/video`
|
||||
- Mode: WRITE
|
||||
- Summary: Create video block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_video_file_block_api_v1_blocks_video_get
|
||||
|
||||
- Operation ID: `api_get_video_file_block_api_v1_blocks_video_get`
|
||||
- Route: `GET /api/v1/blocks/video`
|
||||
- Mode: READ
|
||||
- Summary: Get video block
|
||||
- Parameters:
|
||||
- `block_uuid` in `query` required
|
||||
|
||||
### api_create_pdf_file_block_api_v1_blocks_pdf_post
|
||||
|
||||
- Operation ID: `api_create_pdf_file_block_api_v1_blocks_pdf_post`
|
||||
- Route: `POST /api/v1/blocks/pdf`
|
||||
- Mode: WRITE
|
||||
- Summary: Create PDF block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_pdf_file_block_api_v1_blocks_pdf_get
|
||||
|
||||
- Operation ID: `api_get_pdf_file_block_api_v1_blocks_pdf_get`
|
||||
- Route: `GET /api/v1/blocks/pdf`
|
||||
- Mode: READ
|
||||
- Summary: Get PDF block
|
||||
- Summary: Get audio block
|
||||
- Parameters:
|
||||
- `block_uuid` in `query` required
|
||||
|
||||
@@ -72,11 +30,53 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Create audio block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_audio_file_block_api_v1_blocks_audio_get
|
||||
### api_get_image_file_block_api_v1_blocks_image_get
|
||||
|
||||
- Operation ID: `api_get_audio_file_block_api_v1_blocks_audio_get`
|
||||
- Route: `GET /api/v1/blocks/audio`
|
||||
- Operation ID: `api_get_image_file_block_api_v1_blocks_image_get`
|
||||
- Route: `GET /api/v1/blocks/image`
|
||||
- Mode: READ
|
||||
- Summary: Get audio block
|
||||
- Summary: Get image block
|
||||
- Parameters:
|
||||
- `block_uuid` in `query` required
|
||||
|
||||
### api_create_image_file_block_api_v1_blocks_image_post
|
||||
|
||||
- Operation ID: `api_create_image_file_block_api_v1_blocks_image_post`
|
||||
- Route: `POST /api/v1/blocks/image`
|
||||
- Mode: WRITE
|
||||
- Summary: Create image block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_pdf_file_block_api_v1_blocks_pdf_get
|
||||
|
||||
- Operation ID: `api_get_pdf_file_block_api_v1_blocks_pdf_get`
|
||||
- Route: `GET /api/v1/blocks/pdf`
|
||||
- Mode: READ
|
||||
- Summary: Get PDF block
|
||||
- Parameters:
|
||||
- `block_uuid` in `query` required
|
||||
|
||||
### api_create_pdf_file_block_api_v1_blocks_pdf_post
|
||||
|
||||
- Operation ID: `api_create_pdf_file_block_api_v1_blocks_pdf_post`
|
||||
- Route: `POST /api/v1/blocks/pdf`
|
||||
- Mode: WRITE
|
||||
- Summary: Create PDF block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_video_file_block_api_v1_blocks_video_get
|
||||
|
||||
- Operation ID: `api_get_video_file_block_api_v1_blocks_video_get`
|
||||
- Route: `GET /api/v1/blocks/video`
|
||||
- Mode: READ
|
||||
- Summary: Get video block
|
||||
- Parameters:
|
||||
- `block_uuid` in `query` required
|
||||
|
||||
### api_create_video_file_block_api_v1_blocks_video_post
|
||||
|
||||
- Operation ID: `api_create_video_file_block_api_v1_blocks_video_post`
|
||||
- Route: `POST /api/v1/blocks/video`
|
||||
- Mode: WRITE
|
||||
- Summary: Create video block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -32,6 +32,40 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- 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`
|
||||
@@ -51,15 +85,6 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `board_uuid` in `path` required
|
||||
- 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_duplicate_board_api_v1_boards_board_uuid_duplicate_post
|
||||
|
||||
- Operation ID: `api_duplicate_board_api_v1_boards_board_uuid_duplicate_post`
|
||||
@@ -88,17 +113,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `board_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_board_thumbnail_api_v1_boards_board_uuid_thumbnail_post
|
||||
|
||||
- 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_add_board_members_batch_api_v1_boards_board_uuid_members_batch_post
|
||||
### 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`
|
||||
@@ -108,7 +123,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `board_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_remove_board_member_api_v1_boards_board_uuid_members_user_id_delete
|
||||
### 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}`
|
||||
@@ -118,7 +133,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `board_uuid` in `path` required
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_check_board_membership_api_v1_boards_board_uuid_membership_get
|
||||
### 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`
|
||||
@@ -127,6 +142,16 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- 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`
|
||||
@@ -146,28 +171,3 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `board_uuid` in `path` required
|
||||
- `x-internal-key` in `header` required
|
||||
|
||||
### start_boards_playground_session_api_v1_boards_playground_start_post
|
||||
|
||||
- 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.
|
||||
|
||||
### iterate_boards_playground_session_api_v1_boards_playground_iterate_post
|
||||
|
||||
- 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_session_uuid_get
|
||||
|
||||
- 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
|
||||
|
||||
@@ -21,53 +21,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Create certification
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_certification_api_v1_certifications_certification_uuid_get
|
||||
|
||||
- Operation ID: `api_get_certification_api_v1_certifications_certification_uuid_get`
|
||||
- Route: `GET /api/v1/certifications/{certification_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get certification
|
||||
- Parameters:
|
||||
- `certification_uuid` in `path` required
|
||||
|
||||
### api_update_certification_api_v1_certifications_certification_uuid_put
|
||||
|
||||
- Operation ID: `api_update_certification_api_v1_certifications_certification_uuid_put`
|
||||
- Route: `PUT /api/v1/certifications/{certification_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update certification
|
||||
- Parameters:
|
||||
- `certification_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_certification_api_v1_certifications_certification_uuid_delete
|
||||
|
||||
- Operation ID: `api_delete_certification_api_v1_certifications_certification_uuid_delete`
|
||||
- Route: `DELETE /api/v1/certifications/{certification_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete certification
|
||||
- Parameters:
|
||||
- `certification_uuid` in `path` required
|
||||
|
||||
### api_get_certifications_by_course_api_v1_certifications_course_course_uuid_get
|
||||
|
||||
- Operation ID: `api_get_certifications_by_course_api_v1_certifications_course_course_uuid_get`
|
||||
- Route: `GET /api/v1/certifications/course/{course_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: List course certifications
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_get_user_certificates_for_course_api_v1_certifications_user_course_course_uu
|
||||
|
||||
- Operation ID: `api_get_user_certificates_for_course_api_v1_certifications_user_course_course_uu`
|
||||
- Route: `GET /api/v1/certifications/user/course/{course_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: List my certificates for course
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_get_certificate_by_user_certification_uuid_api_v1_certifications_certificate
|
||||
### api_get_certificate_by_user_certification_uuid_api_v1_a9c108794f
|
||||
|
||||
- Operation ID: `api_get_certificate_by_user_certification_uuid_api_v1_certifications_certificate`
|
||||
- Route: `GET /api/v1/certifications/certificate/{user_certification_uuid}`
|
||||
@@ -76,9 +30,55 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `user_certification_uuid` in `path` required
|
||||
|
||||
### api_get_certifications_by_course_api_v1_certification_23cdc7aa43
|
||||
|
||||
- Operation ID: `api_get_certifications_by_course_api_v1_certifications_course_course_uuid_get`
|
||||
- Route: `GET /api/v1/certifications/course/{course_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: List course certifications
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_get_all_user_certificates_api_v1_certifications_user_all_get
|
||||
|
||||
- Operation ID: `api_get_all_user_certificates_api_v1_certifications_user_all_get`
|
||||
- Route: `GET /api/v1/certifications/user/all`
|
||||
- Mode: READ
|
||||
- Summary: List my certificates
|
||||
|
||||
### api_get_user_certificates_for_course_api_v1_certifica_d13c2c6452
|
||||
|
||||
- Operation ID: `api_get_user_certificates_for_course_api_v1_certifications_user_course_course_uu`
|
||||
- Route: `GET /api/v1/certifications/user/course/{course_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: List my certificates for course
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_delete_certification_api_v1_certifications_certif_047809d136
|
||||
|
||||
- Operation ID: `api_delete_certification_api_v1_certifications_certification_uuid_delete`
|
||||
- Route: `DELETE /api/v1/certifications/{certification_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete certification
|
||||
- Parameters:
|
||||
- `certification_uuid` in `path` required
|
||||
|
||||
### api_get_certification_api_v1_certifications_certifica_d620aa6759
|
||||
|
||||
- Operation ID: `api_get_certification_api_v1_certifications_certification_uuid_get`
|
||||
- Route: `GET /api/v1/certifications/{certification_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get certification
|
||||
- Parameters:
|
||||
- `certification_uuid` in `path` required
|
||||
|
||||
### api_update_certification_api_v1_certifications_certif_2d168ec134
|
||||
|
||||
- Operation ID: `api_update_certification_api_v1_certifications_certification_uuid_put`
|
||||
- Route: `PUT /api/v1/certifications/{certification_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update certification
|
||||
- Parameters:
|
||||
- `certification_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -21,6 +21,45 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- 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`
|
||||
@@ -40,46 +79,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `chapter_id` 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_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_uuid_order_put
|
||||
|
||||
- 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_get_chapter_by_api_v1_chapters_course_course_id_page_page_limit_limit_get
|
||||
|
||||
- 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_list_chapter_usergroups_api_v1_chapters_chapter_uuid_usergroups_get
|
||||
### 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`
|
||||
@@ -88,17 +88,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `chapter_uuid` in `path` required
|
||||
|
||||
### api_add_chapter_usergroup_api_v1_chapters_chapter_uuid_usergroups_usergroup_uuid
|
||||
|
||||
- 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
|
||||
|
||||
### api_remove_chapter_usergroup_api_v1_chapters_chapter_uuid_usergroups_usergroup_u
|
||||
### 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}`
|
||||
@@ -107,3 +97,13 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- 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
|
||||
|
||||
@@ -29,14 +29,6 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Execute code against a batch of test cases
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### upload_sqlite_db_api_v1_code_upload_sqlite_post
|
||||
|
||||
- Operation ID: `upload_sqlite_db_api_v1_code_upload_sqlite_post`
|
||||
- Route: `POST /api/v1/code/upload-sqlite`
|
||||
- Mode: WRITE
|
||||
- Summary: Upload a SQLite database for a code playground block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### get_submission_history_api_v1_code_submissions_history_get
|
||||
|
||||
- Operation ID: `get_submission_history_api_v1_code_submissions_history_get`
|
||||
@@ -56,3 +48,11 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Mode: WRITE
|
||||
- Summary: Save a code submission
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### upload_sqlite_db_api_v1_code_upload_sqlite_post
|
||||
|
||||
- Operation ID: `upload_sqlite_db_api_v1_code_upload_sqlite_post`
|
||||
- Route: `POST /api/v1/code/upload-sqlite`
|
||||
- Mode: WRITE
|
||||
- Summary: Upload a SQLite database for a code playground block
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -21,6 +21,26 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Create collection
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_collections_by_api_v1_collections_org_org_id_0c679cc6e7
|
||||
|
||||
- Operation ID: `api_get_collections_by_api_v1_collections_org_org_id_page_page_limit_limit_get`
|
||||
- Route: `GET /api/v1/collections/org/{org_id}/page/{page}/limit/{limit}`
|
||||
- Mode: READ
|
||||
- Summary: List collections for org
|
||||
- Parameters:
|
||||
- `page` in `path` required
|
||||
- `limit` in `path` required
|
||||
- `org_id` in `path` required
|
||||
|
||||
### api_delete_collection_api_v1_collections_collection_uuid_delete
|
||||
|
||||
- Operation ID: `api_delete_collection_api_v1_collections_collection_uuid_delete`
|
||||
- Route: `DELETE /api/v1/collections/{collection_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete collection
|
||||
- Parameters:
|
||||
- `collection_uuid` in `path` required
|
||||
|
||||
### api_get_collection_api_v1_collections_collection_uuid_get
|
||||
|
||||
- Operation ID: `api_get_collection_api_v1_collections_collection_uuid_get`
|
||||
@@ -39,23 +59,3 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `collection_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_collection_api_v1_collections_collection_uuid_delete
|
||||
|
||||
- Operation ID: `api_delete_collection_api_v1_collections_collection_uuid_delete`
|
||||
- Route: `DELETE /api/v1/collections/{collection_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete collection
|
||||
- Parameters:
|
||||
- `collection_uuid` in `path` required
|
||||
|
||||
### api_get_collections_by_api_v1_collections_org_org_id_page_page_limit_limit_get
|
||||
|
||||
- Operation ID: `api_get_collections_by_api_v1_collections_org_org_id_page_page_limit_limit_get`
|
||||
- Route: `GET /api/v1/collections/org/{org_id}/page/{page}/limit/{limit}`
|
||||
- Mode: READ
|
||||
- Summary: List collections for org
|
||||
- Parameters:
|
||||
- `page` in `path` required
|
||||
- `limit` in `path` required
|
||||
- `org_id` in `path` required
|
||||
|
||||
@@ -13,6 +13,15 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### api_delete_comment_api_v1_comments_comment_uuid_delete
|
||||
|
||||
- Operation ID: `api_delete_comment_api_v1_comments_comment_uuid_delete`
|
||||
- Route: `DELETE /api/v1/comments/{comment_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete a comment
|
||||
- Parameters:
|
||||
- `comment_uuid` in `path` required
|
||||
|
||||
### api_update_comment_api_v1_comments_comment_uuid_put
|
||||
|
||||
- Operation ID: `api_update_comment_api_v1_comments_comment_uuid_put`
|
||||
@@ -23,12 +32,12 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `comment_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_comment_api_v1_comments_comment_uuid_delete
|
||||
### api_remove_comment_upvote_api_v1_comments_comment_uui_b71c8dd381
|
||||
|
||||
- Operation ID: `api_delete_comment_api_v1_comments_comment_uuid_delete`
|
||||
- Route: `DELETE /api/v1/comments/{comment_uuid}`
|
||||
- Operation ID: `api_remove_comment_upvote_api_v1_comments_comment_uuid_vote_delete`
|
||||
- Route: `DELETE /api/v1/comments/{comment_uuid}/vote`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete a comment
|
||||
- Summary: Remove an upvote from a comment
|
||||
- Parameters:
|
||||
- `comment_uuid` in `path` required
|
||||
|
||||
@@ -40,12 +49,3 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Upvote a comment
|
||||
- Parameters:
|
||||
- `comment_uuid` in `path` required
|
||||
|
||||
### api_remove_comment_upvote_api_v1_comments_comment_uuid_vote_delete
|
||||
|
||||
- Operation ID: `api_remove_comment_upvote_api_v1_comments_comment_uuid_vote_delete`
|
||||
- Route: `DELETE /api/v1/comments/{comment_uuid}/vote`
|
||||
- Mode: WRITE
|
||||
- Summary: Remove an upvote from a comment
|
||||
- Parameters:
|
||||
- `comment_uuid` in `path` required
|
||||
|
||||
@@ -23,6 +23,35 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_community_by_course_api_v1_communities_course_c4cb30a78d
|
||||
|
||||
- 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_get_communities_by_org_api_v1_communities_org_org_c6eb1c41e2
|
||||
|
||||
- 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_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_community_api_v1_communities_community_uuid_get
|
||||
|
||||
- Operation ID: `api_get_community_api_v1_communities_community_uuid_get`
|
||||
@@ -42,84 +71,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `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
|
||||
### api_get_discussions_by_community_api_v1_communities_c_75b1bd1ff3
|
||||
|
||||
- Operation ID: `api_get_discussions_by_community_api_v1_communities_community_uuid_discussions_g`
|
||||
- Route: `GET /api/v1/communities/{community_uuid}/discussions`
|
||||
@@ -131,3 +83,51 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
- `label` in `query`
|
||||
|
||||
### api_create_discussion_api_v1_communities_community_uu_c13906d3a0
|
||||
|
||||
- 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_link_community_to_course_api_v1_communities_commu_6eb6f4f798
|
||||
|
||||
- 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_get_community_rights_api_v1_communities_community_331882d520
|
||||
|
||||
- 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_com_99782c46c1
|
||||
|
||||
- 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_unlink_community_from_course_api_v1_communities_c_809005bfcd
|
||||
|
||||
- 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
|
||||
|
||||
@@ -11,8 +11,28 @@ Use the generated operation tools to make real API calls. Do not invent API resp
|
||||
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.
|
||||
|
||||
Deployment context for this LearnHouse instance:
|
||||
|
||||
- It runs single-organization tenancy.
|
||||
- Existing organization: A2A Cloud Academy
|
||||
- Default `org_slug`: `default`
|
||||
- Default `org_id`: `1`
|
||||
- When listing courses and the user does not provide pagination, use `page=1` and `limit=50`.
|
||||
- When creating a course, use query parameter `org_id=1` unless the user explicitly provides another org ID.
|
||||
- Course creation must send multipart form fields `name`, `description`, `public`, and `about`. If the user only gives a title, use it as `name`, provide short `description` and `about` values, and set `public=false` unless the user asks for a public course.
|
||||
|
||||
## Operations
|
||||
|
||||
### api_create_course_api_v1_courses_post
|
||||
|
||||
- Operation ID: `api_create_course_api_v1_courses_post`
|
||||
- Route: `POST /api/v1/courses/`
|
||||
- Mode: WRITE
|
||||
- Summary: Create course
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
- Body: multipart form fields `name`, `description`, `public`, and `about`.
|
||||
|
||||
### api_export_courses_batch_api_v1_courses_export_batch_post
|
||||
|
||||
- Operation ID: `api_export_courses_batch_api_v1_courses_export_batch_post`
|
||||
@@ -21,6 +41,25 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Export multiple courses as ZIP
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_course_by_id_api_v1_courses_id_course_id_get
|
||||
|
||||
- Operation ID: `api_get_course_by_id_api_v1_courses_id_course_id_get`
|
||||
- Route: `GET /api/v1/courses/id/{course_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get course by ID
|
||||
- Parameters:
|
||||
- `course_id` in `path` required
|
||||
|
||||
### api_import_courses_api_v1_courses_import_post
|
||||
|
||||
- Operation ID: `api_import_courses_api_v1_courses_import_post`
|
||||
- Route: `POST /api/v1/courses/import`
|
||||
- Mode: WRITE
|
||||
- Summary: Import courses from an analyzed package
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_analyze_import_package_api_v1_courses_import_analyze_post
|
||||
|
||||
- Operation ID: `api_analyze_import_package_api_v1_courses_import_analyze_post`
|
||||
@@ -31,35 +70,78 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_import_courses_api_v1_courses_import_post
|
||||
### api_create_from_migration_api_v1_courses_migrate_create_post
|
||||
|
||||
- Operation ID: `api_import_courses_api_v1_courses_import_post`
|
||||
- Route: `POST /api/v1/courses/import`
|
||||
- Operation ID: `api_create_from_migration_api_v1_courses_migrate_create_post`
|
||||
- Route: `POST /api/v1/courses/migrate/create`
|
||||
- Mode: WRITE
|
||||
- Summary: Import courses from an analyzed package
|
||||
- Summary: Create course from migration
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_course_api_v1_courses_post
|
||||
### api_suggest_structure_api_v1_courses_migrate_suggest_post
|
||||
|
||||
- Operation ID: `api_create_course_api_v1_courses_post`
|
||||
- Route: `POST /api/v1/courses/`
|
||||
- Operation ID: `api_suggest_structure_api_v1_courses_migrate_suggest_post`
|
||||
- Route: `POST /api/v1/courses/migrate/suggest`
|
||||
- Mode: WRITE
|
||||
- Summary: Create course
|
||||
- Summary: Suggest migration structure
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_course_thumbnail_api_v1_courses_course_uuid_thumbnail_put
|
||||
### api_upload_migration_files_api_v1_courses_migrate_upload_post
|
||||
|
||||
- Operation ID: `api_create_course_thumbnail_api_v1_courses_course_uuid_thumbnail_put`
|
||||
- Route: `PUT /api/v1/courses/{course_uuid}/thumbnail`
|
||||
- Operation ID: `api_upload_migration_files_api_v1_courses_migrate_upload_post`
|
||||
- Route: `POST /api/v1/courses/migrate/upload`
|
||||
- Mode: WRITE
|
||||
- Summary: Update course thumbnail
|
||||
- Summary: Upload migration files
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
- `temp_id` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_courses_count_api_v1_courses_org_slug_org_slug_count_get
|
||||
|
||||
- Operation ID: `api_get_courses_count_api_v1_courses_org_slug_org_slug_count_get`
|
||||
- Route: `GET /api/v1/courses/org_slug/{org_slug}/count`
|
||||
- Mode: READ
|
||||
- Summary: Count courses in an organization
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
|
||||
### api_get_course_by_orgslug_api_v1_courses_org_slug_org_2dfd4569fc
|
||||
|
||||
- Operation ID: `api_get_course_by_orgslug_api_v1_courses_org_slug_org_slug_page_page_limit_limit`
|
||||
- Route: `GET /api/v1/courses/org_slug/{org_slug}/page/{page}/limit/{limit}`
|
||||
- Mode: READ
|
||||
- Summary: List courses for an organization
|
||||
- Parameters:
|
||||
- `page` in `path` required
|
||||
- `limit` in `path` required
|
||||
- `org_slug` in `path` required
|
||||
- `include_unpublished` in `query`
|
||||
|
||||
### api_search_courses_api_v1_courses_org_slug_org_slug_search_get
|
||||
|
||||
- Operation ID: `api_search_courses_api_v1_courses_org_slug_org_slug_search_get`
|
||||
- Route: `GET /api/v1/courses/org_slug/{org_slug}/search`
|
||||
- Mode: READ
|
||||
- Summary: Search courses
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `query` in `query` required
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
|
||||
### api_delete_course_api_v1_courses_course_uuid_delete
|
||||
|
||||
- Operation ID: `api_delete_course_api_v1_courses_course_uuid_delete`
|
||||
- Route: `DELETE /api/v1/courses/{course_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete course
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_course_api_v1_courses_course_uuid_get
|
||||
|
||||
@@ -80,23 +162,73 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `course_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_course_api_v1_courses_course_uuid_delete
|
||||
### api_apply_course_contributor_api_v1_courses_course_uu_a35b28139c
|
||||
|
||||
- Operation ID: `api_delete_course_api_v1_courses_course_uuid_delete`
|
||||
- Route: `DELETE /api/v1/courses/{course_uuid}`
|
||||
- Operation ID: `api_apply_course_contributor_api_v1_courses_course_uuid_apply_contributor_post`
|
||||
- Route: `POST /api/v1/courses/{course_uuid}/apply-contributor`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete course
|
||||
- Summary: Apply as course contributor
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_get_course_by_id_api_v1_courses_id_course_id_get
|
||||
### api_add_bulk_course_contributors_api_v1_courses_cours_3da08940ff
|
||||
|
||||
- Operation ID: `api_get_course_by_id_api_v1_courses_id_course_id_get`
|
||||
- Route: `GET /api/v1/courses/id/{course_id}`
|
||||
- Mode: READ
|
||||
- Summary: Get course by ID
|
||||
- Operation ID: `api_add_bulk_course_contributors_api_v1_courses_course_uuid_bulk_add_contributor`
|
||||
- Route: `POST /api/v1/courses/{course_uuid}/bulk-add-contributors`
|
||||
- Mode: WRITE
|
||||
- Summary: Bulk add course contributors
|
||||
- Parameters:
|
||||
- `course_id` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_remove_bulk_course_contributors_api_v1_courses_co_3117ba4aab
|
||||
|
||||
- Operation ID: `api_remove_bulk_course_contributors_api_v1_courses_course_uuid_bulk_remove_contr`
|
||||
- Route: `PUT /api/v1/courses/{course_uuid}/bulk-remove-contributors`
|
||||
- Mode: WRITE
|
||||
- Summary: Bulk remove course contributors
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_clone_course_api_v1_courses_course_uuid_clone_post
|
||||
|
||||
- Operation ID: `api_clone_course_api_v1_courses_course_uuid_clone_post`
|
||||
- Route: `POST /api/v1/courses/{course_uuid}/clone`
|
||||
- Mode: WRITE
|
||||
- Summary: Clone course
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_get_course_contributors_api_v1_courses_course_uui_f1e2d0838a
|
||||
|
||||
- Operation ID: `api_get_course_contributors_api_v1_courses_course_uuid_contributors_get`
|
||||
- Route: `GET /api/v1/courses/{course_uuid}/contributors`
|
||||
- Mode: READ
|
||||
- Summary: List course contributors
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_update_course_contributor_api_v1_courses_course_u_803ac35801
|
||||
|
||||
- Operation ID: `api_update_course_contributor_api_v1_courses_course_uuid_contributors_contributo`
|
||||
- Route: `PUT /api/v1/courses/{course_uuid}/contributors/{contributor_user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update course contributor
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- `contributor_user_id` in `path` required
|
||||
- `authorship` in `query` required
|
||||
- `authorship_status` in `query` required
|
||||
|
||||
### api_export_course_api_v1_courses_course_uuid_export_get
|
||||
|
||||
- Operation ID: `api_export_course_api_v1_courses_course_uuid_export_get`
|
||||
- Route: `GET /api/v1/courses/{course_uuid}/export`
|
||||
- Mode: READ
|
||||
- Summary: Export course as ZIP
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_get_course_meta_api_v1_courses_course_uuid_meta_get
|
||||
|
||||
@@ -109,65 +241,45 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `with_unpublished_activities` in `query`
|
||||
- `slim` in `query`
|
||||
|
||||
### api_get_course_by_orgslug_api_v1_courses_org_slug_org_slug_page_page_limit_limit
|
||||
### api_get_course_user_rights_api_v1_courses_course_uuid_rights_get
|
||||
|
||||
- Operation ID: `api_get_course_by_orgslug_api_v1_courses_org_slug_org_slug_page_page_limit_limit`
|
||||
- Route: `GET /api/v1/courses/org_slug/{org_slug}/page/{page}/limit/{limit}`
|
||||
- Operation ID: `api_get_course_user_rights_api_v1_courses_course_uuid_rights_get`
|
||||
- Route: `GET /api/v1/courses/{course_uuid}/rights`
|
||||
- Mode: READ
|
||||
- Summary: List courses for an organization
|
||||
- Summary: Get course user rights
|
||||
- Parameters:
|
||||
- `page` in `path` required
|
||||
- `limit` in `path` required
|
||||
- `org_slug` in `path` required
|
||||
- `include_unpublished` in `query`
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_get_courses_count_api_v1_courses_org_slug_org_slug_count_get
|
||||
### api_create_course_thumbnail_api_v1_courses_course_uui_dc5e5c11d8
|
||||
|
||||
- Operation ID: `api_get_courses_count_api_v1_courses_org_slug_org_slug_count_get`
|
||||
- Route: `GET /api/v1/courses/org_slug/{org_slug}/count`
|
||||
- Mode: READ
|
||||
- Summary: Count courses in an organization
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
|
||||
### api_search_courses_api_v1_courses_org_slug_org_slug_search_get
|
||||
|
||||
- Operation ID: `api_search_courses_api_v1_courses_org_slug_org_slug_search_get`
|
||||
- Route: `GET /api/v1/courses/org_slug/{org_slug}/search`
|
||||
- Mode: READ
|
||||
- Summary: Search courses
|
||||
- Parameters:
|
||||
- `org_slug` in `path` required
|
||||
- `query` in `query` required
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
|
||||
### api_clone_course_api_v1_courses_course_uuid_clone_post
|
||||
|
||||
- Operation ID: `api_clone_course_api_v1_courses_course_uuid_clone_post`
|
||||
- Route: `POST /api/v1/courses/{course_uuid}/clone`
|
||||
- Operation ID: `api_create_course_thumbnail_api_v1_courses_course_uuid_thumbnail_put`
|
||||
- Route: `PUT /api/v1/courses/{course_uuid}/thumbnail`
|
||||
- Mode: WRITE
|
||||
- Summary: Clone course
|
||||
- Summary: Update course thumbnail
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_export_course_api_v1_courses_course_uuid_export_get
|
||||
### api_delete_course_update_api_v1_courses_course_uuid_u_686f93b204
|
||||
|
||||
- Operation ID: `api_export_course_api_v1_courses_course_uuid_export_get`
|
||||
- Route: `GET /api/v1/courses/{course_uuid}/export`
|
||||
- Mode: READ
|
||||
- Summary: Export course as ZIP
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_apply_course_contributor_api_v1_courses_course_uuid_apply_contributor_post
|
||||
|
||||
- Operation ID: `api_apply_course_contributor_api_v1_courses_course_uuid_apply_contributor_post`
|
||||
- Route: `POST /api/v1/courses/{course_uuid}/apply-contributor`
|
||||
- Operation ID: `api_delete_course_update_api_v1_courses_course_uuid_update_courseupdate_uuid_del`
|
||||
- Route: `DELETE /api/v1/courses/{course_uuid}/update/{courseupdate_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Apply as course contributor
|
||||
- Summary: Delete course update
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- `courseupdate_uuid` in `path` required
|
||||
|
||||
### api_update_course_update_api_v1_courses_course_uuid_u_01971e1e0f
|
||||
|
||||
- Operation ID: `api_update_course_update_api_v1_courses_course_uuid_update_courseupdate_uuid_put`
|
||||
- Route: `PUT /api/v1/courses/{course_uuid}/update/{courseupdate_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update course update
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- `courseupdate_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_course_updates_api_v1_courses_course_uuid_updates_get
|
||||
|
||||
@@ -187,105 +299,3 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_course_update_api_v1_courses_course_uuid_update_courseupdate_uuid_put
|
||||
|
||||
- Operation ID: `api_update_course_update_api_v1_courses_course_uuid_update_courseupdate_uuid_put`
|
||||
- Route: `PUT /api/v1/courses/{course_uuid}/update/{courseupdate_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update course update
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- `courseupdate_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_course_update_api_v1_courses_course_uuid_update_courseupdate_uuid_del
|
||||
|
||||
- Operation ID: `api_delete_course_update_api_v1_courses_course_uuid_update_courseupdate_uuid_del`
|
||||
- Route: `DELETE /api/v1/courses/{course_uuid}/update/{courseupdate_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete course update
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- `courseupdate_uuid` in `path` required
|
||||
|
||||
### api_get_course_contributors_api_v1_courses_course_uuid_contributors_get
|
||||
|
||||
- Operation ID: `api_get_course_contributors_api_v1_courses_course_uuid_contributors_get`
|
||||
- Route: `GET /api/v1/courses/{course_uuid}/contributors`
|
||||
- Mode: READ
|
||||
- Summary: List course contributors
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_update_course_contributor_api_v1_courses_course_uuid_contributors_contributo
|
||||
|
||||
- Operation ID: `api_update_course_contributor_api_v1_courses_course_uuid_contributors_contributo`
|
||||
- Route: `PUT /api/v1/courses/{course_uuid}/contributors/{contributor_user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update course contributor
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- `contributor_user_id` in `path` required
|
||||
- `authorship` in `query` required
|
||||
- `authorship_status` in `query` required
|
||||
|
||||
### api_add_bulk_course_contributors_api_v1_courses_course_uuid_bulk_add_contributor
|
||||
|
||||
- Operation ID: `api_add_bulk_course_contributors_api_v1_courses_course_uuid_bulk_add_contributor`
|
||||
- Route: `POST /api/v1/courses/{course_uuid}/bulk-add-contributors`
|
||||
- Mode: WRITE
|
||||
- Summary: Bulk add course contributors
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_remove_bulk_course_contributors_api_v1_courses_course_uuid_bulk_remove_contr
|
||||
|
||||
- Operation ID: `api_remove_bulk_course_contributors_api_v1_courses_course_uuid_bulk_remove_contr`
|
||||
- Route: `PUT /api/v1/courses/{course_uuid}/bulk-remove-contributors`
|
||||
- Mode: WRITE
|
||||
- Summary: Bulk remove course contributors
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_course_user_rights_api_v1_courses_course_uuid_rights_get
|
||||
|
||||
- Operation ID: `api_get_course_user_rights_api_v1_courses_course_uuid_rights_get`
|
||||
- Route: `GET /api/v1/courses/{course_uuid}/rights`
|
||||
- Mode: READ
|
||||
- Summary: Get course user rights
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_upload_migration_files_api_v1_courses_migrate_upload_post
|
||||
|
||||
- Operation ID: `api_upload_migration_files_api_v1_courses_migrate_upload_post`
|
||||
- Route: `POST /api/v1/courses/migrate/upload`
|
||||
- Mode: WRITE
|
||||
- Summary: Upload migration files
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
- `temp_id` in `query`
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_suggest_structure_api_v1_courses_migrate_suggest_post
|
||||
|
||||
- Operation ID: `api_suggest_structure_api_v1_courses_migrate_suggest_post`
|
||||
- Route: `POST /api/v1/courses/migrate/suggest`
|
||||
- Mode: WRITE
|
||||
- Summary: Suggest migration structure
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_from_migration_api_v1_courses_migrate_create_post
|
||||
|
||||
- Operation ID: `api_create_from_migration_api_v1_courses_migrate_create_post`
|
||||
- Route: `POST /api/v1/courses/migrate/create`
|
||||
- Mode: WRITE
|
||||
- Summary: Create course from migration
|
||||
- Parameters:
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -20,6 +20,23 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Mode: READ
|
||||
- Summary: List discussion labels
|
||||
|
||||
### api_get_user_votes_batch_api_v1_discussions_votes_batch_post
|
||||
|
||||
- Operation ID: `api_get_user_votes_batch_api_v1_discussions_votes_batch_post`
|
||||
- Route: `POST /api/v1/discussions/votes/batch`
|
||||
- Mode: WRITE
|
||||
- Summary: Batch check user vote status
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_discussion_api_v1_discussions_discussion_uuid_delete
|
||||
|
||||
- Operation ID: `api_delete_discussion_api_v1_discussions_discussion_uuid_delete`
|
||||
- Route: `DELETE /api/v1/discussions/{discussion_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
|
||||
### api_get_discussion_api_v1_discussions_discussion_uuid_get
|
||||
|
||||
- Operation ID: `api_get_discussion_api_v1_discussions_discussion_uuid_get`
|
||||
@@ -39,25 +56,36 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `discussion_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_discussion_api_v1_discussions_discussion_uuid_delete
|
||||
### api_get_comments_by_discussion_api_v1_discussions_dis_87a0b55e1c
|
||||
|
||||
- Operation ID: `api_delete_discussion_api_v1_discussions_discussion_uuid_delete`
|
||||
- Route: `DELETE /api/v1/discussions/{discussion_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete a discussion
|
||||
- Operation ID: `api_get_comments_by_discussion_api_v1_discussions_discussion_uuid_comments_get`
|
||||
- Route: `GET /api/v1/discussions/{discussion_uuid}/comments`
|
||||
- Mode: READ
|
||||
- Summary: List comments for a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
|
||||
### api_pin_discussion_api_v1_discussions_discussion_uuid_pin_put
|
||||
### api_create_comment_api_v1_discussions_discussion_uuid_bc6989627c
|
||||
|
||||
- Operation ID: `api_pin_discussion_api_v1_discussions_discussion_uuid_pin_put`
|
||||
- Route: `PUT /api/v1/discussions/{discussion_uuid}/pin`
|
||||
- Operation ID: `api_create_comment_api_v1_discussions_discussion_uuid_comments_post`
|
||||
- Route: `POST /api/v1/discussions/{discussion_uuid}/comments`
|
||||
- Mode: WRITE
|
||||
- Summary: Pin or unpin a discussion
|
||||
- Summary: Create a comment
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_comment_count_api_v1_discussions_discussion_u_15e933154e
|
||||
|
||||
- Operation ID: `api_get_comment_count_api_v1_discussions_discussion_uuid_comments_count_get`
|
||||
- Route: `GET /api/v1/discussions/{discussion_uuid}/comments/count`
|
||||
- Mode: READ
|
||||
- Summary: Get comment count for a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
|
||||
### api_lock_discussion_api_v1_discussions_discussion_uuid_lock_put
|
||||
|
||||
- Operation ID: `api_lock_discussion_api_v1_discussions_discussion_uuid_lock_put`
|
||||
@@ -68,14 +96,34 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `discussion_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_upvote_discussion_api_v1_discussions_discussion_uuid_vote_post
|
||||
### api_pin_discussion_api_v1_discussions_discussion_uuid_pin_put
|
||||
|
||||
- Operation ID: `api_upvote_discussion_api_v1_discussions_discussion_uuid_vote_post`
|
||||
- Route: `POST /api/v1/discussions/{discussion_uuid}/vote`
|
||||
- Operation ID: `api_pin_discussion_api_v1_discussions_discussion_uuid_pin_put`
|
||||
- Route: `PUT /api/v1/discussions/{discussion_uuid}/pin`
|
||||
- Mode: WRITE
|
||||
- Summary: Upvote a discussion
|
||||
- Summary: Pin or unpin a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_reactions_api_v1_discussions_discussion_uuid_c7dd806798
|
||||
|
||||
- Operation ID: `api_get_reactions_api_v1_discussions_discussion_uuid_reactions_get`
|
||||
- Route: `GET /api/v1/discussions/{discussion_uuid}/reactions`
|
||||
- Mode: READ
|
||||
- Summary: List reactions on a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
|
||||
### api_toggle_reaction_api_v1_discussions_discussion_uui_0ce0c91549
|
||||
|
||||
- Operation ID: `api_toggle_reaction_api_v1_discussions_discussion_uuid_reactions_post`
|
||||
- Route: `POST /api/v1/discussions/{discussion_uuid}/reactions`
|
||||
- Mode: WRITE
|
||||
- Summary: Toggle a reaction on a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_remove_upvote_api_v1_discussions_discussion_uuid_vote_delete
|
||||
|
||||
@@ -86,59 +134,11 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
|
||||
### api_get_user_votes_batch_api_v1_discussions_votes_batch_post
|
||||
### api_upvote_discussion_api_v1_discussions_discussion_u_70125b3df6
|
||||
|
||||
- Operation ID: `api_get_user_votes_batch_api_v1_discussions_votes_batch_post`
|
||||
- Route: `POST /api/v1/discussions/votes/batch`
|
||||
- Operation ID: `api_upvote_discussion_api_v1_discussions_discussion_uuid_vote_post`
|
||||
- Route: `POST /api/v1/discussions/{discussion_uuid}/vote`
|
||||
- Mode: WRITE
|
||||
- Summary: Batch check user vote status
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_comment_api_v1_discussions_discussion_uuid_comments_post
|
||||
|
||||
- Operation ID: `api_create_comment_api_v1_discussions_discussion_uuid_comments_post`
|
||||
- Route: `POST /api/v1/discussions/{discussion_uuid}/comments`
|
||||
- Mode: WRITE
|
||||
- Summary: Create a comment
|
||||
- Summary: Upvote a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_comments_by_discussion_api_v1_discussions_discussion_uuid_comments_get
|
||||
|
||||
- Operation ID: `api_get_comments_by_discussion_api_v1_discussions_discussion_uuid_comments_get`
|
||||
- Route: `GET /api/v1/discussions/{discussion_uuid}/comments`
|
||||
- Mode: READ
|
||||
- Summary: List comments for a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
- `page` in `query`
|
||||
- `limit` in `query`
|
||||
|
||||
### api_get_comment_count_api_v1_discussions_discussion_uuid_comments_count_get
|
||||
|
||||
- Operation ID: `api_get_comment_count_api_v1_discussions_discussion_uuid_comments_count_get`
|
||||
- Route: `GET /api/v1/discussions/{discussion_uuid}/comments/count`
|
||||
- Mode: READ
|
||||
- Summary: Get comment count for a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
|
||||
### api_get_reactions_api_v1_discussions_discussion_uuid_reactions_get
|
||||
|
||||
- Operation ID: `api_get_reactions_api_v1_discussions_discussion_uuid_reactions_get`
|
||||
- Route: `GET /api/v1/discussions/{discussion_uuid}/reactions`
|
||||
- Mode: READ
|
||||
- Summary: List reactions on a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
|
||||
### api_toggle_reaction_api_v1_discussions_discussion_uuid_reactions_post
|
||||
|
||||
- Operation ID: `api_toggle_reaction_api_v1_discussions_discussion_uuid_reactions_post`
|
||||
- Route: `POST /api/v1/discussions/{discussion_uuid}/reactions`
|
||||
- Mode: WRITE
|
||||
- Summary: Toggle a reaction on a discussion
|
||||
- Parameters:
|
||||
- `discussion_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -13,12 +13,14 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### zapier_me_api_v1_integrations_zapier_me_get
|
||||
### zapier_list_courses_api_v1_integrations_zapier_courses_get
|
||||
|
||||
- Operation ID: `zapier_me_api_v1_integrations_zapier_me_get`
|
||||
- Route: `GET /api/v1/integrations/zapier/me`
|
||||
- Operation ID: `zapier_list_courses_api_v1_integrations_zapier_courses_get`
|
||||
- Route: `GET /api/v1/integrations/zapier/courses`
|
||||
- Mode: READ
|
||||
- Summary: Identify Zapier caller
|
||||
- Summary: List courses for Zapier
|
||||
- Parameters:
|
||||
- `limit` in `query`
|
||||
|
||||
### zapier_list_events_api_v1_integrations_zapier_events_get
|
||||
|
||||
@@ -27,12 +29,43 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Mode: READ
|
||||
- Summary: List webhook events
|
||||
|
||||
### zapier_list_courses_api_v1_integrations_zapier_courses_get
|
||||
### zapier_me_api_v1_integrations_zapier_me_get
|
||||
|
||||
- Operation ID: `zapier_list_courses_api_v1_integrations_zapier_courses_get`
|
||||
- Route: `GET /api/v1/integrations/zapier/courses`
|
||||
- Operation ID: `zapier_me_api_v1_integrations_zapier_me_get`
|
||||
- Route: `GET /api/v1/integrations/zapier/me`
|
||||
- Mode: READ
|
||||
- Summary: List courses for Zapier
|
||||
- Summary: Identify Zapier caller
|
||||
|
||||
### zapier_list_subscriptions_api_v1_integrations_zapier_df14135b86
|
||||
|
||||
- Operation ID: `zapier_list_subscriptions_api_v1_integrations_zapier_subscriptions_get`
|
||||
- Route: `GET /api/v1/integrations/zapier/subscriptions`
|
||||
- Mode: READ
|
||||
- Summary: List Zap subscriptions
|
||||
|
||||
### zapier_create_subscription_api_v1_integrations_zapier_f6cc5be3cc
|
||||
|
||||
- Operation ID: `zapier_create_subscription_api_v1_integrations_zapier_subscriptions_post`
|
||||
- Route: `POST /api/v1/integrations/zapier/subscriptions`
|
||||
- Mode: WRITE
|
||||
- Summary: Create Zap subscription
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### zapier_delete_subscription_api_v1_integrations_zapier_19ee38abf1
|
||||
|
||||
- Operation ID: `zapier_delete_subscription_api_v1_integrations_zapier_subscriptions_subscription`
|
||||
- Route: `DELETE /api/v1/integrations/zapier/subscriptions/{subscription_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete Zap subscription
|
||||
- Parameters:
|
||||
- `subscription_id` in `path` required
|
||||
|
||||
### zapier_list_usergroups_api_v1_integrations_zapier_usergroups_get
|
||||
|
||||
- Operation ID: `zapier_list_usergroups_api_v1_integrations_zapier_usergroups_get`
|
||||
- Route: `GET /api/v1/integrations/zapier/usergroups`
|
||||
- Mode: READ
|
||||
- Summary: List user groups for Zapier
|
||||
- Parameters:
|
||||
- `limit` in `query`
|
||||
|
||||
@@ -44,36 +77,3 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: List users for Zapier
|
||||
- Parameters:
|
||||
- `limit` in `query`
|
||||
|
||||
### zapier_list_usergroups_api_v1_integrations_zapier_usergroups_get
|
||||
|
||||
- Operation ID: `zapier_list_usergroups_api_v1_integrations_zapier_usergroups_get`
|
||||
- Route: `GET /api/v1/integrations/zapier/usergroups`
|
||||
- Mode: READ
|
||||
- Summary: List user groups for Zapier
|
||||
- Parameters:
|
||||
- `limit` in `query`
|
||||
|
||||
### zapier_list_subscriptions_api_v1_integrations_zapier_subscriptions_get
|
||||
|
||||
- Operation ID: `zapier_list_subscriptions_api_v1_integrations_zapier_subscriptions_get`
|
||||
- Route: `GET /api/v1/integrations/zapier/subscriptions`
|
||||
- Mode: READ
|
||||
- Summary: List Zap subscriptions
|
||||
|
||||
### zapier_create_subscription_api_v1_integrations_zapier_subscriptions_post
|
||||
|
||||
- Operation ID: `zapier_create_subscription_api_v1_integrations_zapier_subscriptions_post`
|
||||
- Route: `POST /api/v1/integrations/zapier/subscriptions`
|
||||
- Mode: WRITE
|
||||
- Summary: Create Zap subscription
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### zapier_delete_subscription_api_v1_integrations_zapier_subscriptions_subscription
|
||||
|
||||
- Operation ID: `zapier_delete_subscription_api_v1_integrations_zapier_subscriptions_subscription`
|
||||
- Route: `DELETE /api/v1/integrations/zapier/subscriptions/{subscription_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete Zap subscription
|
||||
- Parameters:
|
||||
- `subscription_id` in `path` required
|
||||
|
||||
@@ -13,7 +13,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### api_list_all_verified_domains_api_v1_internal_domains_verified_get
|
||||
### api_list_all_verified_domains_api_v1_internal_domains_7b347627c2
|
||||
|
||||
- Operation ID: `api_list_all_verified_domains_api_v1_internal_domains_verified_get`
|
||||
- Route: `GET /api/v1/internal/domains/verified`
|
||||
@@ -33,18 +33,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `x-platform-key` in `header` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_mark_pack_canceling_api_v1_internal_packs_org_id_mark_canceling_patch
|
||||
|
||||
- Operation ID: `api_mark_pack_canceling_api_v1_internal_packs_org_id_mark_canceling_patch`
|
||||
- Route: `PATCH /api/v1/internal/packs/{org_id}/mark-canceling`
|
||||
- Mode: WRITE
|
||||
- Summary: Mark a pack as canceling
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
- `x-platform-key` in `header` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_deactivate_pack_api_v1_internal_packs_org_id_deactivate_delete
|
||||
### api_deactivate_pack_api_v1_internal_packs_org_id_deac_c7867f97dd
|
||||
|
||||
- Operation ID: `api_deactivate_pack_api_v1_internal_packs_org_id_deactivate_delete`
|
||||
- Route: `DELETE /api/v1/internal/packs/{org_id}/deactivate`
|
||||
@@ -55,7 +44,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `x-platform-key` in `header` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_deactivate_all_packs_api_v1_internal_packs_org_id_deactivate_all_delete
|
||||
### api_deactivate_all_packs_api_v1_internal_packs_org_id_81cfc38826
|
||||
|
||||
- Operation ID: `api_deactivate_all_packs_api_v1_internal_packs_org_id_deactivate_all_delete`
|
||||
- Route: `DELETE /api/v1/internal/packs/{org_id}/deactivate-all`
|
||||
@@ -64,3 +53,14 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
- `x-platform-key` in `header` required
|
||||
|
||||
### api_mark_pack_canceling_api_v1_internal_packs_org_id_f6e3ccf606
|
||||
|
||||
- Operation ID: `api_mark_pack_canceling_api_v1_internal_packs_org_id_mark_canceling_patch`
|
||||
- Route: `PATCH /api/v1/internal/packs/{org_id}/mark-canceling`
|
||||
- Mode: WRITE
|
||||
- Summary: Mark a pack as canceling
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
- `x-platform-key` in `header` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
1034
skills/orgs/SKILL.md
1034
skills/orgs/SKILL.md
File diff suppressed because it is too large
Load Diff
@@ -23,6 +23,31 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### iterate_playground_session_api_v1_playgrounds_generat_fa5ceb5c12
|
||||
|
||||
- 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_105a9dd82d
|
||||
|
||||
- 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
|
||||
|
||||
### 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.
|
||||
|
||||
### api_list_org_playgrounds_api_v1_playgrounds_org_org_id_get
|
||||
|
||||
- Operation ID: `api_list_org_playgrounds_api_v1_playgrounds_org_org_id_get`
|
||||
@@ -32,6 +57,15 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
|
||||
### 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_get_playground_api_v1_playgrounds_playground_uuid_get
|
||||
|
||||
- Operation ID: `api_get_playground_api_v1_playgrounds_playground_uuid_get`
|
||||
@@ -51,16 +85,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `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
|
||||
### api_duplicate_playground_api_v1_playgrounds_playgroun_da97e869e2
|
||||
|
||||
- Operation ID: `api_duplicate_playground_api_v1_playgrounds_playground_uuid_duplicate_post`
|
||||
- Route: `POST /api/v1/playgrounds/{playground_uuid}/duplicate`
|
||||
@@ -69,46 +94,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- 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
|
||||
### api_get_playground_reactions_api_v1_playgrounds_playg_a355ed4ba4
|
||||
|
||||
- Operation ID: `api_get_playground_reactions_api_v1_playgrounds_playground_uuid_reactions_get`
|
||||
- Route: `GET /api/v1/playgrounds/{playground_uuid}/reactions`
|
||||
@@ -117,7 +103,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `playground_uuid` in `path` required
|
||||
|
||||
### api_toggle_playground_reaction_api_v1_playgrounds_playground_uuid_reactions_post
|
||||
### api_toggle_playground_reaction_api_v1_playgrounds_pla_9e9d2434c0
|
||||
|
||||
- Operation ID: `api_toggle_playground_reaction_api_v1_playgrounds_playground_uuid_reactions_post`
|
||||
- Route: `POST /api/v1/playgrounds/{playground_uuid}/reactions`
|
||||
@@ -127,27 +113,41 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `playground_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### start_playground_session_api_v1_playgrounds_generate_start_post
|
||||
### api_update_playground_thumbnail_api_v1_playgrounds_pl_f479a3908f
|
||||
|
||||
- Operation ID: `start_playground_session_api_v1_playgrounds_generate_start_post`
|
||||
- Route: `POST /api/v1/playgrounds/generate/start`
|
||||
- Operation ID: `api_update_playground_thumbnail_api_v1_playgrounds_playground_uuid_thumbnail_pos`
|
||||
- Route: `POST /api/v1/playgrounds/{playground_uuid}/thumbnail`
|
||||
- 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
|
||||
- Summary: Upload a playground thumbnail
|
||||
- Parameters:
|
||||
- `session_uuid` in `path` required
|
||||
- `playground_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_playground_usergroups_api_v1_playgrounds_play_59ff5be511
|
||||
|
||||
- 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_remove_usergroup_from_playground_api_v1_playgroun_f515e2a2bf
|
||||
|
||||
- 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_add_usergroup_to_playground_api_v1_playgrounds_pl_f7e126f3af
|
||||
|
||||
- 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
|
||||
|
||||
@@ -23,112 +23,14 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_id` in `query` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_podcast_api_v1_podcasts_podcast_uuid_get
|
||||
### api_delete_episode_api_v1_podcasts_episodes_episode_uuid_delete
|
||||
|
||||
- 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}`
|
||||
- Operation ID: `api_delete_episode_api_v1_podcasts_episodes_episode_uuid_delete`
|
||||
- Route: `DELETE /api/v1/podcasts/episodes/{episode_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update a podcast
|
||||
- Summary: Delete a podcast episode
|
||||
- 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.
|
||||
- `episode_uuid` in `path` required
|
||||
|
||||
### api_get_episode_api_v1_podcasts_episodes_episode_uuid_get
|
||||
|
||||
@@ -149,16 +51,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `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
|
||||
### api_upload_episode_audio_api_v1_podcasts_episodes_epi_b8445e5f99
|
||||
|
||||
- Operation ID: `api_upload_episode_audio_api_v1_podcasts_episodes_episode_uuid_audio_put`
|
||||
- Route: `PUT /api/v1/podcasts/episodes/{episode_uuid}/audio`
|
||||
@@ -168,7 +61,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `episode_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_upload_episode_thumbnail_api_v1_podcasts_episodes_episode_uuid_thumbnail_put
|
||||
### api_upload_episode_thumbnail_api_v1_podcasts_episodes_6b1000e029
|
||||
|
||||
- Operation ID: `api_upload_episode_thumbnail_api_v1_podcasts_episodes_episode_uuid_thumbnail_put`
|
||||
- Route: `PUT /api/v1/podcasts/episodes/{episode_uuid}/thumbnail`
|
||||
@@ -177,3 +70,110 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `episode_uuid` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_podcasts_count_orgslug_api_v1_podcasts_org_sl_c055cd82f8
|
||||
|
||||
- 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_get_podcasts_orgslug_api_v1_podcasts_org_slug_org_0b240cc025
|
||||
|
||||
- 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_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_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_get_podcast_episodes_api_v1_podcasts_podcast_uuid_8327ae9f08
|
||||
|
||||
- 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_epi_eb44af0702
|
||||
|
||||
- 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_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_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_update_podcast_thumbnail_api_v1_podcasts_podcast_b5edd6263f
|
||||
|
||||
- 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.
|
||||
|
||||
@@ -13,6 +13,15 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### api_get_roles_by_organization_api_v1_roles_org_org_id_get
|
||||
|
||||
- Operation ID: `api_get_roles_by_organization_api_v1_roles_org_org_id_get`
|
||||
- Route: `GET /api/v1/roles/org/{org_id}`
|
||||
- Mode: READ
|
||||
- Summary: List roles for organization
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
|
||||
### api_create_role_api_v1_roles_org_org_id_post
|
||||
|
||||
- Operation ID: `api_create_role_api_v1_roles_org_org_id_post`
|
||||
@@ -23,14 +32,14 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `org_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_roles_by_organization_api_v1_roles_org_org_id_get
|
||||
### api_delete_role_api_v1_roles_role_id_delete
|
||||
|
||||
- Operation ID: `api_get_roles_by_organization_api_v1_roles_org_org_id_get`
|
||||
- Route: `GET /api/v1/roles/org/{org_id}`
|
||||
- Mode: READ
|
||||
- Summary: List roles for organization
|
||||
- Operation ID: `api_delete_role_api_v1_roles_role_id_delete`
|
||||
- Route: `DELETE /api/v1/roles/{role_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete role
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
- `role_id` in `path` required
|
||||
|
||||
### api_get_role_api_v1_roles_role_id_get
|
||||
|
||||
@@ -50,12 +59,3 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `role_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_role_api_v1_roles_role_id_delete
|
||||
|
||||
- Operation ID: `api_delete_role_api_v1_roles_role_id_delete`
|
||||
- Route: `DELETE /api/v1/roles/{role_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete role
|
||||
- Parameters:
|
||||
- `role_id` in `path` required
|
||||
|
||||
@@ -13,31 +13,31 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### stream_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_fil
|
||||
### stream_podcast_audio_api_v1_stream_audio_org_uuid_pod_b00337df67
|
||||
|
||||
- Operation ID: `stream_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_fil`
|
||||
- Route: `GET /api/v1/stream/video/{org_uuid}/{course_uuid}/{activity_uuid}/{filename}`
|
||||
- Operation ID: `stream_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_file`
|
||||
- Route: `GET /api/v1/stream/audio/{org_uuid}/{podcast_uuid}/{episode_uuid}/{filename}`
|
||||
- Mode: READ
|
||||
- Summary: Stream an activity video
|
||||
- Summary: Stream a podcast episode audio
|
||||
- Parameters:
|
||||
- `org_uuid` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
- `podcast_uuid` in `path` required
|
||||
- `episode_uuid` in `path` required
|
||||
- `filename` in `path` required
|
||||
|
||||
### head_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_filen
|
||||
### head_podcast_audio_api_v1_stream_audio_org_uuid_podca_c45f413b27
|
||||
|
||||
- Operation ID: `head_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_filen`
|
||||
- Route: `HEAD /api/v1/stream/video/{org_uuid}/{course_uuid}/{activity_uuid}/{filename}`
|
||||
- Operation ID: `head_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_filena`
|
||||
- Route: `HEAD /api/v1/stream/audio/{org_uuid}/{podcast_uuid}/{episode_uuid}/{filename}`
|
||||
- Mode: READ
|
||||
- Summary: Get activity video metadata
|
||||
- Summary: Get podcast audio metadata
|
||||
- Parameters:
|
||||
- `org_uuid` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
- `podcast_uuid` in `path` required
|
||||
- `episode_uuid` in `path` required
|
||||
- `filename` in `path` required
|
||||
|
||||
### stream_block_audio_api_v1_stream_block_audio_org_uuid_course_uuid_activity_uuid_
|
||||
### stream_block_audio_api_v1_stream_block_audio_org_uuid_d22429c1c5
|
||||
|
||||
- Operation ID: `stream_block_audio_api_v1_stream_block_audio_org_uuid_course_uuid_activity_uuid_`
|
||||
- Route: `GET /api/v1/stream/block/audio/{org_uuid}/{course_uuid}/{activity_uuid}/{block_uuid}/{filename}`
|
||||
@@ -50,7 +50,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `block_uuid` in `path` required
|
||||
- `filename` in `path` required
|
||||
|
||||
### head_block_audio_api_v1_stream_block_audio_org_uuid_course_uuid_activity_uuid_bl
|
||||
### head_block_audio_api_v1_stream_block_audio_org_uuid_c_8afea6d24b
|
||||
|
||||
- Operation ID: `head_block_audio_api_v1_stream_block_audio_org_uuid_course_uuid_activity_uuid_bl`
|
||||
- Route: `HEAD /api/v1/stream/block/audio/{org_uuid}/{course_uuid}/{activity_uuid}/{block_uuid}/{filename}`
|
||||
@@ -63,7 +63,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `block_uuid` in `path` required
|
||||
- `filename` in `path` required
|
||||
|
||||
### stream_block_video_api_v1_stream_block_org_uuid_course_uuid_activity_uuid_block_
|
||||
### stream_block_video_api_v1_stream_block_org_uuid_cours_0b2e9e4553
|
||||
|
||||
- Operation ID: `stream_block_video_api_v1_stream_block_org_uuid_course_uuid_activity_uuid_block_`
|
||||
- Route: `GET /api/v1/stream/block/{org_uuid}/{course_uuid}/{activity_uuid}/{block_uuid}/{filename}`
|
||||
@@ -76,7 +76,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `block_uuid` in `path` required
|
||||
- `filename` in `path` required
|
||||
|
||||
### head_block_video_api_v1_stream_block_org_uuid_course_uuid_activity_uuid_block_uu
|
||||
### head_block_video_api_v1_stream_block_org_uuid_course_8b5030265e
|
||||
|
||||
- Operation ID: `head_block_video_api_v1_stream_block_org_uuid_course_uuid_activity_uuid_block_uu`
|
||||
- Route: `HEAD /api/v1/stream/block/{org_uuid}/{course_uuid}/{activity_uuid}/{block_uuid}/{filename}`
|
||||
@@ -89,26 +89,26 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `block_uuid` in `path` required
|
||||
- `filename` in `path` required
|
||||
|
||||
### stream_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_file
|
||||
### stream_activity_video_api_v1_stream_video_org_uuid_co_72317e6010
|
||||
|
||||
- Operation ID: `stream_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_file`
|
||||
- Route: `GET /api/v1/stream/audio/{org_uuid}/{podcast_uuid}/{episode_uuid}/{filename}`
|
||||
- Operation ID: `stream_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_fil`
|
||||
- Route: `GET /api/v1/stream/video/{org_uuid}/{course_uuid}/{activity_uuid}/{filename}`
|
||||
- Mode: READ
|
||||
- Summary: Stream a podcast episode audio
|
||||
- Summary: Stream an activity video
|
||||
- Parameters:
|
||||
- `org_uuid` in `path` required
|
||||
- `podcast_uuid` in `path` required
|
||||
- `episode_uuid` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
- `filename` in `path` required
|
||||
|
||||
### head_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_filena
|
||||
### head_activity_video_api_v1_stream_video_org_uuid_cour_ab5fca5f39
|
||||
|
||||
- Operation ID: `head_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_filena`
|
||||
- Route: `HEAD /api/v1/stream/audio/{org_uuid}/{podcast_uuid}/{episode_uuid}/{filename}`
|
||||
- Operation ID: `head_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_filen`
|
||||
- Route: `HEAD /api/v1/stream/video/{org_uuid}/{course_uuid}/{activity_uuid}/{filename}`
|
||||
- Mode: READ
|
||||
- Summary: Get podcast audio metadata
|
||||
- Summary: Get activity video metadata
|
||||
- Parameters:
|
||||
- `org_uuid` in `path` required
|
||||
- `podcast_uuid` in `path` required
|
||||
- `episode_uuid` in `path` required
|
||||
- `course_uuid` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
- `filename` in `path` required
|
||||
|
||||
@@ -13,14 +13,6 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### api_start_trail_api_v1_trail_start_post
|
||||
|
||||
- Operation ID: `api_start_trail_api_v1_trail_start_post`
|
||||
- Route: `POST /api/v1/trail/start`
|
||||
- Mode: WRITE
|
||||
- Summary: Start a trail
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_user_trail_api_v1_trail_get
|
||||
|
||||
- Operation ID: `api_get_user_trail_api_v1_trail_get`
|
||||
@@ -28,14 +20,14 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Mode: READ
|
||||
- Summary: Get current user's trails
|
||||
|
||||
### api_get_trail_by_org_id_api_v1_trail_org_org_id_trail_get
|
||||
### api_add_activity_to_trail_api_v1_trail_add_activity_a_8f91c5f2dc
|
||||
|
||||
- Operation ID: `api_get_trail_by_org_id_api_v1_trail_org_org_id_trail_get`
|
||||
- Route: `GET /api/v1/trail/org/{org_id}/trail`
|
||||
- Mode: READ
|
||||
- Summary: Get user trail by organization
|
||||
- Operation ID: `api_add_activity_to_trail_api_v1_trail_add_activity_activity_uuid_post`
|
||||
- Route: `POST /api/v1/trail/add_activity/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Add activity to trail
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_add_course_to_trail_api_v1_trail_add_course_course_uuid_post
|
||||
|
||||
@@ -46,7 +38,25 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_remove_course_to_trail_api_v1_trail_remove_course_course_uuid_delete
|
||||
### api_get_trail_by_org_id_api_v1_trail_org_org_id_trail_get
|
||||
|
||||
- Operation ID: `api_get_trail_by_org_id_api_v1_trail_org_org_id_trail_get`
|
||||
- Route: `GET /api/v1/trail/org/{org_id}/trail`
|
||||
- Mode: READ
|
||||
- Summary: Get user trail by organization
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
|
||||
### api_remove_activity_from_trail_api_v1_trail_remove_ac_a1b96b68c0
|
||||
|
||||
- Operation ID: `api_remove_activity_from_trail_api_v1_trail_remove_activity_activity_uuid_delete`
|
||||
- Route: `DELETE /api/v1/trail/remove_activity/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Remove activity from trail
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_remove_course_to_trail_api_v1_trail_remove_course_625748fd1c
|
||||
|
||||
- Operation ID: `api_remove_course_to_trail_api_v1_trail_remove_course_course_uuid_delete`
|
||||
- Route: `DELETE /api/v1/trail/remove_course/{course_uuid}`
|
||||
@@ -55,20 +65,10 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `course_uuid` in `path` required
|
||||
|
||||
### api_add_activity_to_trail_api_v1_trail_add_activity_activity_uuid_post
|
||||
### api_start_trail_api_v1_trail_start_post
|
||||
|
||||
- Operation ID: `api_add_activity_to_trail_api_v1_trail_add_activity_activity_uuid_post`
|
||||
- Route: `POST /api/v1/trail/add_activity/{activity_uuid}`
|
||||
- Operation ID: `api_start_trail_api_v1_trail_start_post`
|
||||
- Route: `POST /api/v1/trail/start`
|
||||
- Mode: WRITE
|
||||
- Summary: Add activity to trail
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
|
||||
### api_remove_activity_from_trail_api_v1_trail_remove_activity_activity_uuid_delete
|
||||
|
||||
- Operation ID: `api_remove_activity_from_trail_api_v1_trail_remove_activity_activity_uuid_delete`
|
||||
- Route: `DELETE /api/v1/trail/remove_activity/{activity_uuid}`
|
||||
- Mode: WRITE
|
||||
- Summary: Remove activity from trail
|
||||
- Parameters:
|
||||
- `activity_uuid` in `path` required
|
||||
- Summary: Start a trail
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
@@ -21,6 +21,33 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Summary: Create a usergroup
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_usergroups_api_v1_usergroups_org_org_id_get
|
||||
|
||||
- Operation ID: `api_get_usergroups_api_v1_usergroups_org_org_id_get`
|
||||
- Route: `GET /api/v1/usergroups/org/{org_id}`
|
||||
- Mode: READ
|
||||
- Summary: List usergroups for an organization
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
|
||||
### api_get_usergroupsby_resource_api_v1_usergroups_resou_65ed5ed760
|
||||
|
||||
- Operation ID: `api_get_usergroupsby_resource_api_v1_usergroups_resource_resource_uuid_get`
|
||||
- Route: `GET /api/v1/usergroups/resource/{resource_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: List usergroups linked to a resource
|
||||
- Parameters:
|
||||
- `resource_uuid` in `path` required
|
||||
|
||||
### api_delete_usergroup_api_v1_usergroups_usergroup_id_delete
|
||||
|
||||
- Operation ID: `api_delete_usergroup_api_v1_usergroups_usergroup_id_delete`
|
||||
- Route: `DELETE /api/v1/usergroups/{usergroup_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
|
||||
### api_get_usergroup_api_v1_usergroups_usergroup_id_get
|
||||
|
||||
- Operation ID: `api_get_usergroup_api_v1_usergroups_usergroup_id_get`
|
||||
@@ -40,72 +67,7 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `usergroup_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_usergroup_api_v1_usergroups_usergroup_id_delete
|
||||
|
||||
- Operation ID: `api_delete_usergroup_api_v1_usergroups_usergroup_id_delete`
|
||||
- Route: `DELETE /api/v1/usergroups/{usergroup_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Delete a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
|
||||
### api_get_users_linked_to_usergroup_api_v1_usergroups_usergroup_id_users_get
|
||||
|
||||
- Operation ID: `api_get_users_linked_to_usergroup_api_v1_usergroups_usergroup_id_users_get`
|
||||
- Route: `GET /api/v1/usergroups/{usergroup_id}/users`
|
||||
- Mode: READ
|
||||
- Summary: List users in a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
|
||||
### api_get_usergroups_api_v1_usergroups_org_org_id_get
|
||||
|
||||
- Operation ID: `api_get_usergroups_api_v1_usergroups_org_org_id_get`
|
||||
- Route: `GET /api/v1/usergroups/org/{org_id}`
|
||||
- Mode: READ
|
||||
- Summary: List usergroups for an organization
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
|
||||
### api_get_resources_linked_to_usergroup_api_v1_usergroups_usergroup_id_resources_g
|
||||
|
||||
- Operation ID: `api_get_resources_linked_to_usergroup_api_v1_usergroups_usergroup_id_resources_g`
|
||||
- Route: `GET /api/v1/usergroups/{usergroup_id}/resources`
|
||||
- Mode: READ
|
||||
- Summary: List resources linked to a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
|
||||
### api_get_usergroupsby_resource_api_v1_usergroups_resource_resource_uuid_get
|
||||
|
||||
- Operation ID: `api_get_usergroupsby_resource_api_v1_usergroups_resource_resource_uuid_get`
|
||||
- Route: `GET /api/v1/usergroups/resource/{resource_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: List usergroups linked to a resource
|
||||
- Parameters:
|
||||
- `resource_uuid` in `path` required
|
||||
|
||||
### api_add_users_to_usergroup_api_v1_usergroups_usergroup_id_add_users_post
|
||||
|
||||
- Operation ID: `api_add_users_to_usergroup_api_v1_usergroups_usergroup_id_add_users_post`
|
||||
- Route: `POST /api/v1/usergroups/{usergroup_id}/add_users`
|
||||
- Mode: WRITE
|
||||
- Summary: Add users to a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
- `user_ids` in `query` required
|
||||
|
||||
### api_delete_users_from_usergroup_api_v1_usergroups_usergroup_id_remove_users_dele
|
||||
|
||||
- Operation ID: `api_delete_users_from_usergroup_api_v1_usergroups_usergroup_id_remove_users_dele`
|
||||
- Route: `DELETE /api/v1/usergroups/{usergroup_id}/remove_users`
|
||||
- Mode: WRITE
|
||||
- Summary: Remove users from a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
- `user_ids` in `query` required
|
||||
|
||||
### api_add_resources_to_usergroup_api_v1_usergroups_usergroup_id_add_resources_post
|
||||
### api_add_resources_to_usergroup_api_v1_usergroups_user_b634bb257c
|
||||
|
||||
- Operation ID: `api_add_resources_to_usergroup_api_v1_usergroups_usergroup_id_add_resources_post`
|
||||
- Route: `POST /api/v1/usergroups/{usergroup_id}/add_resources`
|
||||
@@ -115,7 +77,17 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `usergroup_id` in `path` required
|
||||
- `resource_uuids` in `query` required
|
||||
|
||||
### api_delete_resources_from_usergroup_api_v1_usergroups_usergroup_id_remove_resour
|
||||
### api_add_users_to_usergroup_api_v1_usergroups_usergrou_580b980b98
|
||||
|
||||
- Operation ID: `api_add_users_to_usergroup_api_v1_usergroups_usergroup_id_add_users_post`
|
||||
- Route: `POST /api/v1/usergroups/{usergroup_id}/add_users`
|
||||
- Mode: WRITE
|
||||
- Summary: Add users to a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
- `user_ids` in `query` required
|
||||
|
||||
### api_delete_resources_from_usergroup_api_v1_usergroups_1f25c6c66f
|
||||
|
||||
- Operation ID: `api_delete_resources_from_usergroup_api_v1_usergroups_usergroup_id_remove_resour`
|
||||
- Route: `DELETE /api/v1/usergroups/{usergroup_id}/remove_resources`
|
||||
@@ -124,3 +96,31 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
- `resource_uuids` in `query` required
|
||||
|
||||
### api_delete_users_from_usergroup_api_v1_usergroups_use_976c3491af
|
||||
|
||||
- Operation ID: `api_delete_users_from_usergroup_api_v1_usergroups_usergroup_id_remove_users_dele`
|
||||
- Route: `DELETE /api/v1/usergroups/{usergroup_id}/remove_users`
|
||||
- Mode: WRITE
|
||||
- Summary: Remove users from a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
- `user_ids` in `query` required
|
||||
|
||||
### api_get_resources_linked_to_usergroup_api_v1_usergrou_503b3fdf32
|
||||
|
||||
- Operation ID: `api_get_resources_linked_to_usergroup_api_v1_usergroups_usergroup_id_resources_g`
|
||||
- Route: `GET /api/v1/usergroups/{usergroup_id}/resources`
|
||||
- Mode: READ
|
||||
- Summary: List resources linked to a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
|
||||
### api_get_users_linked_to_usergroup_api_v1_usergroups_u_9d301543fb
|
||||
|
||||
- Operation ID: `api_get_users_linked_to_usergroup_api_v1_usergroups_usergroup_id_users_get`
|
||||
- Route: `GET /api/v1/usergroups/{usergroup_id}/users`
|
||||
- Mode: READ
|
||||
- Summary: List users in a usergroup
|
||||
- Parameters:
|
||||
- `usergroup_id` in `path` required
|
||||
|
||||
@@ -13,21 +13,15 @@ For write, update, or delete operations, state the intended action before callin
|
||||
|
||||
## Operations
|
||||
|
||||
### api_get_current_user_api_v1_users_profile_get
|
||||
### api_create_user_without_org_api_v1_users_post
|
||||
|
||||
- Operation ID: `api_get_current_user_api_v1_users_profile_get`
|
||||
- Route: `GET /api/v1/users/profile`
|
||||
- Mode: READ
|
||||
- Summary: Get current user profile
|
||||
- Operation ID: `api_create_user_without_org_api_v1_users_post`
|
||||
- Route: `POST /api/v1/users/`
|
||||
- Mode: WRITE
|
||||
- Summary: Create user without organization
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_current_user_session_api_v1_users_session_get
|
||||
|
||||
- Operation ID: `api_get_current_user_session_api_v1_users_session_get`
|
||||
- Route: `GET /api/v1/users/session`
|
||||
- Mode: READ
|
||||
- Summary: Get current user session
|
||||
|
||||
### api_get_authorization_status_api_v1_users_authorize_ressource_ressource_uuid_act
|
||||
### api_get_authorization_status_api_v1_users_authorize_r_0a440f1ada
|
||||
|
||||
- Operation ID: `api_get_authorization_status_api_v1_users_authorize_ressource_ressource_uuid_act`
|
||||
- Route: `GET /api/v1/users/authorize/ressource/{ressource_uuid}/action/{action}`
|
||||
@@ -37,33 +31,14 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `ressource_uuid` in `path` required
|
||||
- `action` in `path` required
|
||||
|
||||
### api_create_user_with_orgid_api_v1_users_org_id_post
|
||||
### api_update_user_password_api_v1_users_change_password_f5dd4723f7
|
||||
|
||||
- Operation ID: `api_create_user_with_orgid_api_v1_users_org_id_post`
|
||||
- Route: `POST /api/v1/users/{org_id}`
|
||||
- Operation ID: `api_update_user_password_api_v1_users_change_password_user_id_put`
|
||||
- Route: `PUT /api/v1/users/change_password/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Create user in organization
|
||||
- Summary: Change user password
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_user_with_orgid_and_invite_api_v1_users_org_id_invite_invite_code_pos
|
||||
|
||||
- Operation ID: `api_create_user_with_orgid_and_invite_api_v1_users_org_id_invite_invite_code_pos`
|
||||
- Route: `POST /api/v1/users/{org_id}/invite/{invite_code}`
|
||||
- Mode: WRITE
|
||||
- Summary: Create user with invite code
|
||||
- Parameters:
|
||||
- `invite_code` in `path` required
|
||||
- `org_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_user_without_org_api_v1_users_post
|
||||
|
||||
- Operation ID: `api_create_user_without_org_api_v1_users_post`
|
||||
- Route: `POST /api/v1/users/`
|
||||
- Mode: WRITE
|
||||
- Summary: Create user without organization
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_user_by_id_api_v1_users_id_user_id_get
|
||||
@@ -75,34 +50,91 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_get_user_by_uuid_api_v1_users_uuid_user_uuid_get
|
||||
### api_get_current_user_api_v1_users_profile_get
|
||||
|
||||
- Operation ID: `api_get_user_by_uuid_api_v1_users_uuid_user_uuid_get`
|
||||
- Route: `GET /api/v1/users/uuid/{user_uuid}`
|
||||
- Operation ID: `api_get_current_user_api_v1_users_profile_get`
|
||||
- Route: `GET /api/v1/users/profile`
|
||||
- Mode: READ
|
||||
- Summary: Get user by UUID
|
||||
- Parameters:
|
||||
- `user_uuid` in `path` required
|
||||
- Summary: Get current user profile
|
||||
|
||||
### api_get_user_by_username_api_v1_users_username_username_get
|
||||
### api_change_password_with_reset_code_v2_api_v1_users_r_9e5bb417e3
|
||||
|
||||
- Operation ID: `api_get_user_by_username_api_v1_users_username_username_get`
|
||||
- Route: `GET /api/v1/users/username/{username}`
|
||||
- Mode: READ
|
||||
- Summary: Get user by username
|
||||
- Parameters:
|
||||
- `username` in `path` required
|
||||
|
||||
### api_update_user_api_v1_users_user_id_put
|
||||
|
||||
- Operation ID: `api_update_user_api_v1_users_user_id_put`
|
||||
- Route: `PUT /api/v1/users/{user_id}`
|
||||
- Operation ID: `api_change_password_with_reset_code_v2_api_v1_users_reset_password_change_passwo`
|
||||
- Route: `POST /api/v1/users/reset_password/change_password`
|
||||
- Mode: WRITE
|
||||
- Summary: Update user
|
||||
- Parameters:
|
||||
- `user_id` in `path` required
|
||||
- Summary: Change password with reset code
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_change_password_with_reset_code_api_v1_users_rese_dd97d2e9a8
|
||||
|
||||
- Operation ID: `api_change_password_with_reset_code_api_v1_users_reset_password_change_password_`
|
||||
- Route: `POST /api/v1/users/reset_password/change_password/{email}`
|
||||
- Mode: WRITE
|
||||
- Summary: Change password with reset code (legacy path)
|
||||
- Parameters:
|
||||
- `email` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_change_password_with_reset_code_platform_v2_api_v_b1301db94f
|
||||
|
||||
- Operation ID: `api_change_password_with_reset_code_platform_v2_api_v1_users_reset_password_plat`
|
||||
- Route: `POST /api/v1/users/reset_password/platform/change_password`
|
||||
- Mode: WRITE
|
||||
- Summary: Change platform password with reset code
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_change_password_with_reset_code_platform_api_v1_u_985bafaf3c
|
||||
|
||||
- Operation ID: `api_change_password_with_reset_code_platform_api_v1_users_reset_password_platfor`
|
||||
- Route: `POST /api/v1/users/reset_password/platform/change_password/{email}`
|
||||
- Mode: WRITE
|
||||
- Summary: Change platform password with reset code (legacy path)
|
||||
- Parameters:
|
||||
- `email` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_send_password_reset_email_platform_v2_api_v1_user_c7f6ef5fb4
|
||||
|
||||
- Operation ID: `api_send_password_reset_email_platform_v2_api_v1_users_reset_password_platform_s`
|
||||
- Route: `POST /api/v1/users/reset_password/platform/send_reset_code`
|
||||
- Mode: WRITE
|
||||
- Summary: Send platform password reset code
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_send_password_reset_email_platform_api_v1_users_r_7f7d4ea238
|
||||
|
||||
- Operation ID: `api_send_password_reset_email_platform_api_v1_users_reset_password_platform_send`
|
||||
- Route: `POST /api/v1/users/reset_password/platform/send_reset_code/{email}`
|
||||
- Mode: WRITE
|
||||
- Summary: Send platform password reset code (legacy path)
|
||||
- Parameters:
|
||||
- `email` in `path` required
|
||||
|
||||
### api_send_password_reset_email_v2_api_v1_users_reset_p_c85dfacd2d
|
||||
|
||||
- Operation ID: `api_send_password_reset_email_v2_api_v1_users_reset_password_send_reset_code_pos`
|
||||
- Route: `POST /api/v1/users/reset_password/send_reset_code`
|
||||
- Mode: WRITE
|
||||
- Summary: Send password reset code
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_send_password_reset_email_api_v1_users_reset_pass_fb3b355f5e
|
||||
|
||||
- Operation ID: `api_send_password_reset_email_api_v1_users_reset_password_send_reset_code_email_`
|
||||
- Route: `POST /api/v1/users/reset_password/send_reset_code/{email}`
|
||||
- Mode: WRITE
|
||||
- Summary: Send password reset code (legacy path)
|
||||
- Parameters:
|
||||
- `email` in `path` required
|
||||
- `org_id` in `query` required
|
||||
|
||||
### api_get_current_user_session_api_v1_users_session_get
|
||||
|
||||
- Operation ID: `api_get_current_user_session_api_v1_users_session_get`
|
||||
- Route: `GET /api/v1/users/session`
|
||||
- Mode: READ
|
||||
- Summary: Get current user session
|
||||
|
||||
### api_update_avatar_user_api_v1_users_update_avatar_user_id_put
|
||||
|
||||
- Operation ID: `api_update_avatar_user_api_v1_users_update_avatar_user_id_put`
|
||||
@@ -113,87 +145,6 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_user_password_api_v1_users_change_password_user_id_put
|
||||
|
||||
- Operation ID: `api_update_user_password_api_v1_users_change_password_user_id_put`
|
||||
- Route: `PUT /api/v1/users/change_password/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Change user password
|
||||
- Parameters:
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_change_password_with_reset_code_v2_api_v1_users_reset_password_change_passwo
|
||||
|
||||
- Operation ID: `api_change_password_with_reset_code_v2_api_v1_users_reset_password_change_passwo`
|
||||
- Route: `POST /api/v1/users/reset_password/change_password`
|
||||
- Mode: WRITE
|
||||
- Summary: Change password with reset code
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_change_password_with_reset_code_api_v1_users_reset_password_change_password_
|
||||
|
||||
- Operation ID: `api_change_password_with_reset_code_api_v1_users_reset_password_change_password_`
|
||||
- Route: `POST /api/v1/users/reset_password/change_password/{email}`
|
||||
- Mode: WRITE
|
||||
- Summary: Change password with reset code (legacy path)
|
||||
- Parameters:
|
||||
- `email` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_send_password_reset_email_v2_api_v1_users_reset_password_send_reset_code_pos
|
||||
|
||||
- Operation ID: `api_send_password_reset_email_v2_api_v1_users_reset_password_send_reset_code_pos`
|
||||
- Route: `POST /api/v1/users/reset_password/send_reset_code`
|
||||
- Mode: WRITE
|
||||
- Summary: Send password reset code
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_send_password_reset_email_api_v1_users_reset_password_send_reset_code_email_
|
||||
|
||||
- Operation ID: `api_send_password_reset_email_api_v1_users_reset_password_send_reset_code_email_`
|
||||
- Route: `POST /api/v1/users/reset_password/send_reset_code/{email}`
|
||||
- Mode: WRITE
|
||||
- Summary: Send password reset code (legacy path)
|
||||
- Parameters:
|
||||
- `email` in `path` required
|
||||
- `org_id` in `query` required
|
||||
|
||||
### api_send_password_reset_email_platform_v2_api_v1_users_reset_password_platform_s
|
||||
|
||||
- Operation ID: `api_send_password_reset_email_platform_v2_api_v1_users_reset_password_platform_s`
|
||||
- Route: `POST /api/v1/users/reset_password/platform/send_reset_code`
|
||||
- Mode: WRITE
|
||||
- Summary: Send platform password reset code
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_send_password_reset_email_platform_api_v1_users_reset_password_platform_send
|
||||
|
||||
- Operation ID: `api_send_password_reset_email_platform_api_v1_users_reset_password_platform_send`
|
||||
- Route: `POST /api/v1/users/reset_password/platform/send_reset_code/{email}`
|
||||
- Mode: WRITE
|
||||
- Summary: Send platform password reset code (legacy path)
|
||||
- Parameters:
|
||||
- `email` in `path` required
|
||||
|
||||
### api_change_password_with_reset_code_platform_v2_api_v1_users_reset_password_plat
|
||||
|
||||
- Operation ID: `api_change_password_with_reset_code_platform_v2_api_v1_users_reset_password_plat`
|
||||
- Route: `POST /api/v1/users/reset_password/platform/change_password`
|
||||
- Mode: WRITE
|
||||
- Summary: Change platform password with reset code
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_change_password_with_reset_code_platform_api_v1_users_reset_password_platfor
|
||||
|
||||
- Operation ID: `api_change_password_with_reset_code_platform_api_v1_users_reset_password_platfor`
|
||||
- Route: `POST /api/v1/users/reset_password/platform/change_password/{email}`
|
||||
- Mode: WRITE
|
||||
- Summary: Change platform password with reset code (legacy path)
|
||||
- Parameters:
|
||||
- `email` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_delete_user_api_v1_users_user_id_user_id_delete
|
||||
|
||||
- Operation ID: `api_delete_user_api_v1_users_user_id_user_id_delete`
|
||||
@@ -203,6 +154,55 @@ For write, update, or delete operations, state the intended action before callin
|
||||
- Parameters:
|
||||
- `user_id` in `path` required
|
||||
|
||||
### api_get_user_by_username_api_v1_users_username_username_get
|
||||
|
||||
- Operation ID: `api_get_user_by_username_api_v1_users_username_username_get`
|
||||
- Route: `GET /api/v1/users/username/{username}`
|
||||
- Mode: READ
|
||||
- Summary: Get user by username
|
||||
- Parameters:
|
||||
- `username` in `path` required
|
||||
|
||||
### api_get_user_by_uuid_api_v1_users_uuid_user_uuid_get
|
||||
|
||||
- Operation ID: `api_get_user_by_uuid_api_v1_users_uuid_user_uuid_get`
|
||||
- Route: `GET /api/v1/users/uuid/{user_uuid}`
|
||||
- Mode: READ
|
||||
- Summary: Get user by UUID
|
||||
- Parameters:
|
||||
- `user_uuid` in `path` required
|
||||
|
||||
### api_create_user_with_orgid_api_v1_users_org_id_post
|
||||
|
||||
- Operation ID: `api_create_user_with_orgid_api_v1_users_org_id_post`
|
||||
- Route: `POST /api/v1/users/{org_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Create user in organization
|
||||
- Parameters:
|
||||
- `org_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_create_user_with_orgid_and_invite_api_v1_users_or_827b99a284
|
||||
|
||||
- Operation ID: `api_create_user_with_orgid_and_invite_api_v1_users_org_id_invite_invite_code_pos`
|
||||
- Route: `POST /api/v1/users/{org_id}/invite/{invite_code}`
|
||||
- Mode: WRITE
|
||||
- Summary: Create user with invite code
|
||||
- Parameters:
|
||||
- `invite_code` in `path` required
|
||||
- `org_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_update_user_api_v1_users_user_id_put
|
||||
|
||||
- Operation ID: `api_update_user_api_v1_users_user_id_put`
|
||||
- Route: `PUT /api/v1/users/{user_id}`
|
||||
- Mode: WRITE
|
||||
- Summary: Update user
|
||||
- Parameters:
|
||||
- `user_id` in `path` required
|
||||
- Body: JSON request body accepted.
|
||||
|
||||
### api_get_user_courses_api_v1_users_user_id_courses_get
|
||||
|
||||
- Operation ID: `api_get_user_courses_api_v1_users_user_id_courses_get`
|
||||
|
||||
Reference in New Issue
Block a user