ulams dictionary-words

Generated from front/cli (ulams schema)

`ulams dictionary-words create`

Store a newly created dictionary word in storage.

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

Endpoints: POST /api/admin/dictionary-words.

Flag	Type	Required	Description
`--categories`	array		categories
`--data`	object
`--description`	string
`--dictionary-id`	integer	yes
`--word`	string	yes

# Store a newly created dictionary word in storage
ulams dictionary-words create --dictionary-id text --word text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "categories": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      },
      "description": "categories"
    },
    "data": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "description": {
      "type": "string"
    },
    "dictionary_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "word": {
      "type": "string"
    }
  },
  "required": [
    "dictionary_id",
    "word"
  ],
  "additionalProperties": {}
}

`ulams dictionary-words delete`

Remove the specified Dictionary Word from storage.

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

Endpoints: DELETE /api/admin/dictionary-words/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	id of Dictionary

# Remove the specified Dictionary Word from storage
ulams dictionary-words 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 Dictionary"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams dictionary-words get`

Display the specified Dictionary Word.

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

Endpoints: GET /api/admin/dictionary-words/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	id of Dictionary Word

# Display the specified Dictionary Word
ulams dictionary-words 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 Dictionary Word"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams dictionary-words import`

Import dictionary words from file.

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

Endpoints: POST /api/admin/dictionary-words/import.

Flag	Type	Required	Description
`--dictionary-id`	integer	yes
`--file`	string	yes	file (path of a local file)

# Import dictionary words from file
ulams dictionary-words import --dictionary-id text --file text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dictionary_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "file": {
      "type": "string",
      "description": "file (path of a local file)"
    }
  },
  "required": [
    "dictionary_id",
    "file"
  ],
  "additionalProperties": {}
}

`ulams dictionary-words list`

Get a listing of the Dictionary Word.

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

Endpoints: GET /api/admin/dictionary-words.

Flag	Type	Description
`--order-by`	string
`--order`	string
`--page`	number	Pagination Page Number
`--per-page`	number	Pagination Per Page
`--word`	string	word %LIKE%
`--dictionary-id`	integer
`--category-ids[]`	array

# Get a listing of the Dictionary Word
ulams dictionary-words list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "order_by": {
      "type": "string",
      "enum": [
        "id",
        "name",
        "created_at"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "page": {
      "type": "number",
      "description": "Pagination Page Number"
    },
    "per_page": {
      "type": "number",
      "description": "Pagination Per Page"
    },
    "word": {
      "type": "string",
      "description": "word %LIKE%"
    },
    "dictionary_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "category_ids[]": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": {}
}

`ulams dictionary-words update`

Update the specified Dictionary Word in storage.

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

Endpoints: PUT /api/admin/dictionary-words/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	id of Dictionary
`--categories`	array		categories
`--data`	object
`--description`	string
`--dictionary-id`	integer
`--word`	string

# Update the specified Dictionary Word in storage
ulams dictionary-words 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 Dictionary"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      },
      "description": "categories"
    },
    "data": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "description": {
      "type": "string"
    },
    "dictionary_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "word": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}