75 lines
2.4 KiB
Markdown
75 lines
2.4 KiB
Markdown
---
|
|
name: trail-routes
|
|
description: Handle 7 OpenAPI operation(s) under /api/v1/trail for the trail route group.
|
|
---
|
|
|
|
# trail API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /api/v1/trail for the trail route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### api_get_user_trail_api_v1_trail_get
|
|
|
|
- Operation ID: `api_get_user_trail_api_v1_trail_get`
|
|
- Route: `GET /api/v1/trail/`
|
|
- Mode: READ
|
|
- Summary: Get current user's trails
|
|
|
|
### api_add_activity_to_trail_api_v1_trail_add_activity_a_8f91c5f2dc
|
|
|
|
- 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:
|
|
- `activity_uuid` in `path` required
|
|
|
|
### api_add_course_to_trail_api_v1_trail_add_course_course_uuid_post
|
|
|
|
- Operation ID: `api_add_course_to_trail_api_v1_trail_add_course_course_uuid_post`
|
|
- Route: `POST /api/v1/trail/add_course/{course_uuid}`
|
|
- Mode: WRITE
|
|
- Summary: Add course to trail
|
|
- Parameters:
|
|
- `course_uuid` in `path` required
|
|
|
|
### 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}`
|
|
- Mode: WRITE
|
|
- Summary: Remove course from trail
|
|
- Parameters:
|
|
- `course_uuid` in `path` required
|
|
|
|
### 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.
|