Instructors API
Auto-generated from the OpenAPI spec. Run
node docs-site/scripts/fetch-openapi.jsto regenerate.
GET /api/v1/instructors/me
Get Own Instructor Profile
Responses
- 200 — Successful Response
GET /api/v1/instructors
List Instructors
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
search | query | No | ||
include_inactive | query | No | boolean | |
page | query | No | integer | |
page_size | query | No | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/instructors
Create Instructor
Request body
| Field | Required | Type | Description |
|---|---|---|---|
email | Yes | string | |
password | Yes | string | |
full_name | Yes | string | |
bio | No | string |
Responses
- 201 — Successful Response
- 422 — Validation Error
PATCH /api/v1/instructors/{instructor_id}/reactivate
Reactivate Instructor
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
instructor_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
GET /api/v1/instructors/{instructor_id}
Get Instructor
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
instructor_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
PUT /api/v1/instructors/{instructor_id}
Update Instructor
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
instructor_id | path | Yes | integer |
Request body
| Field | Required | Type | Description |
|---|---|---|---|
full_name | No | string | |
bio | No | string |
Responses
- 200 — Successful Response
- 422 — Validation Error
DELETE /api/v1/instructors/{instructor_id}
Deactivate Instructor
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
instructor_id | path | Yes | integer |
Responses
- 204 — Successful Response
- 422 — Validation Error
POST /api/v1/instructors/{instructor_id}/photo
Upload Instructor Photo
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
instructor_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
DELETE /api/v1/instructors/{instructor_id}/photo
Remove Instructor Photo
Clear an instructor's profile photo without uploading a replacement.
Idempotent: calling this when no photo is set is a no-op success, not a 404 — the end state (no photo) is what the caller asked for either way.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
instructor_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
DELETE /api/v1/instructors/{instructor_id}/remove
Remove Instructor
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
instructor_id | path | Yes | integer |
Responses
- 204 — Successful Response
- 422 — Validation Error