Skip to content

ulams lessons

Generated from front/cli (ulams schema)

Clone Lesson.

Kind: write. Stability: stable. MCP tool: lessons_clone. Scopes: courses:write.

Endpoints: POST /api/admin/lessons/{id}/clone.

Flag Type Required Description
--id (positional) integer yes id of Lesson
--body unknown Request body (JSON)
Terminal window
# Clone Lesson
ulams lessons clone 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id of Lesson"
},
"body": {
"description": "Request body (JSON)"
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Store a newly created Lesson in storage.

Kind: write. Stability: stable. MCP tool: lessons_create. Scopes: courses:write.

Endpoints: POST /api/admin/lessons.

Flag Type Required Description
--active-from string active_from
--active-to string active_to
--course-id integer yes course_id
--duration string duration
--id integer id
--order integer yes order
--parent-lesson-id integer parent_lesson_id
--summary string summary
--title string yes title
Terminal window
# Store a newly created Lesson in storage
ulams lessons create --course-id text --order text --title Example --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"active_from": {
"type": "string",
"description": "active_from"
},
"active_to": {
"type": "string",
"description": "active_to"
},
"course_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "course_id"
},
"duration": {
"type": "string",
"description": "duration"
},
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id"
},
"order": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "order"
},
"parent_lesson_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "parent_lesson_id"
},
"summary": {
"type": "string",
"description": "summary"
},
"title": {
"type": "string",
"description": "title"
}
},
"required": [
"course_id",
"order",
"title"
],
"additionalProperties": {}
}

Remove the specified Lesson from storage.

Kind: destructive (idempotent). Stability: stable. MCP tool: lessons_delete. Scopes: courses:write.

Endpoints: DELETE /api/admin/lessons/{id}.

Flag Type Required Description
--id (positional) integer yes id of Lesson
Terminal window
# Remove the specified Lesson from storage
ulams lessons delete 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id of Lesson"
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Display the specified Lesson.

Kind: read (idempotent). Stability: stable. MCP tool: lessons_get. Scopes: courses:read.

Endpoints: GET /api/admin/lessons/{id}.

Flag Type Required Description
--id (positional) integer yes id of Lesson
Terminal window
# Display the specified Lesson
ulams lessons get 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id of Lesson"
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Get a listing of the Lessons.

Kind: read (idempotent). Stability: stable. MCP tool: lessons_list. Scopes: courses:read.

Endpoints: GET /api/admin/lessons.

Terminal window
# Get a listing of the Lessons
ulams lessons list --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": {}
}

Update the specified Lesson in storage.

Kind: write (idempotent). Stability: stable. MCP tool: lessons_update. Scopes: courses:write.

Endpoints: PUT /api/admin/lessons/{id}.

Flag Type Required Description
--id (positional) integer yes id of Lesson
--active-from string active_from
--active-to string active_to
--course-id integer course_id
--duration string duration
--order integer order
--parent-lesson-id integer parent_lesson_id
--summary string summary
--title string title
Terminal window
# Update the specified Lesson in storage
ulams lessons update 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "id of Lesson"
},
"active_from": {
"type": "string",
"description": "active_from"
},
"active_to": {
"type": "string",
"description": "active_to"
},
"course_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "course_id"
},
"duration": {
"type": "string",
"description": "duration"
},
"order": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "order"
},
"parent_lesson_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "parent_lesson_id"
},
"summary": {
"type": "string",
"description": "summary"
},
"title": {
"type": "string",
"description": "title"
}
},
"required": [
"id"
],
"additionalProperties": {}
}