Skip to content

ulams categories

Generated from front/cli (ulams schema)

Category create.

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

Endpoints: POST /api/admin/categories.

Flag Type Required Description
--description string
--icon-class string
--is-active boolean
--name string
--order number
--parent-id unknown
Terminal window
# Category create
ulams categories create --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"description": {
"type": "string"
},
"icon_class": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
},
"parent_id": {}
},
"additionalProperties": {}
}

Destroy category.

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

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

Flag Type Required Description
--id (positional) integer yes
Terminal window
# Destroy category
ulams categories 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
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Get single Categories.

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

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

Flag Type Required Description
--id (positional) integer yes
Terminal window
# Get single Categories
ulams categories 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
}
},
"required": [
"id"
],
"additionalProperties": {}
}

POST /api/admin/categories/sort.

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

Endpoints: POST /api/admin/categories/sort.

Flag Type Required Description
--orders array orders
Terminal window
# POST /api/admin/categories/sort
ulams categories sort --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"order": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": {}
},
"description": "orders"
}
},
"additionalProperties": {}
}

Update category.

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

Endpoints: POST /api/admin/categories/{id}.

Flag Type Required Description
--id (positional) integer yes
--description string
--icon-class string
--is-active boolean
--name string
--order number
--parent-id unknown
Terminal window
# Update category
ulams categories 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": {
"type": "string"
},
"icon_class": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
},
"parent_id": {}
},
"required": [
"id"
],
"additionalProperties": {}
}