ulams bookmarks

Generated from front/cli (ulams schema)

`ulams bookmarks create`

Store a newly created bookmark.

Kind: write. Stability: stable. MCP tool: bookmarks_create. Scopes: learner:write.

Endpoints: POST /api/admin/bookmarks.

Flag	Type	Required	Description
`--bookmarkable-id`	integer	yes	bookmarkable_id
`--bookmarkable-type`	string	yes	bookmarkable_type
`--user-id`	integer		user_id
`--value`	string		value

# Store a newly created bookmark
ulams bookmarks create --bookmarkable-id text --bookmarkable-type text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "bookmarkable_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "bookmarkable_id"
    },
    "bookmarkable_type": {
      "type": "string",
      "description": "bookmarkable_type"
    },
    "user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "user_id"
    },
    "value": {
      "type": "string",
      "description": "value"
    }
  },
  "required": [
    "bookmarkable_id",
    "bookmarkable_type"
  ],
  "additionalProperties": {}
}

`ulams bookmarks delete`

Remove the specified bookmark.

Kind: destructive (idempotent). Stability: stable. MCP tool: bookmarks_delete. Scopes: learner:write.

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

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

# Remove the specified bookmark
ulams bookmarks 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 bookmark"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams bookmarks list`

Get a listing of the bookmarks.

Kind: read (idempotent). Stability: stable. MCP tool: bookmarks_list. Scopes: learner:read.

Endpoints: GET /api/admin/bookmarks.

Flag	Type	Description
`--order-by`	string
`--order`	string
`--page`	number	Pagination Page Number
`--per-page`	number	Pagination Per Page
`--has-value`	boolean	Has value
`--bookmarkable-id`	number	Bookmarkalbe ID
`--bookmarkable-ids[]`	array	An array of bookmark IDs.
`--bookmarkable-type`	string	Bookmarkalbe type

# Get a listing of the bookmarks
ulams bookmarks list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "order_by": {
      "type": "string",
      "enum": [
        "created_at",
        "id",
        "value"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "page": {
      "type": "number",
      "description": "Pagination Page Number"
    },
    "per_page": {
      "type": "number",
      "description": "Pagination Per Page"
    },
    "has_value": {
      "type": "boolean",
      "description": "Has value"
    },
    "bookmarkable_id": {
      "type": "number",
      "description": "Bookmarkalbe ID"
    },
    "bookmarkable_ids[]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "An array of bookmark IDs."
    },
    "bookmarkable_type": {
      "type": "string",
      "description": "Bookmarkalbe type"
    }
  },
  "additionalProperties": {}
}

`ulams bookmarks update`

Update bookmark.

Kind: write. Stability: stable. MCP tool: bookmarks_update. Scopes: learner:write.

Endpoints: PATCH /api/admin/bookmarks/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	ID of bookmark
`--bookmarkable-id`	integer		bookmarkable_id
`--bookmarkable-type`	string		bookmarkable_type
`--user-id`	integer		user_id
`--value`	string		value

# Update bookmark
ulams bookmarks 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 bookmark"
    },
    "bookmarkable_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "bookmarkable_id"
    },
    "bookmarkable_type": {
      "type": "string",
      "description": "bookmarkable_type"
    },
    "user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "user_id"
    },
    "value": {
      "type": "string",
      "description": "value"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}