update_model
Idempotent
Update the active model's metadata: name, documentation, and properties with merge support.
Instructions
Update the active model's name, documentation, and properties.
Updates is a dict containing only the fields to change; other fields
are left untouched and properties are merged into the existing ones.
There is no `model_id` parameter because exactly one model is active.
Works on a loaded model, not only on one created by this server.
Unlike `update_element`, unknown keys are rejected rather than
ignored: a mis-keyed update would silently leave model metadata
unwritten while still reporting success.
Args:
updates: Mapping of fields to update. Supported keys:
- `name` (str): New model name. Must be non-blank; it is
stripped, exactly as in `create_empty_model`.
- `description` (str): New model documentation. Reported
back as `documentation`.
- `documentation` (str): Accepted alias for `description`.
- `properties` (dict[str, str]): Property updates merged
into the existing model properties.
Returns:
Success envelope with `data.model_info` (same shape as
`pyarchimate://activemodel/info`).
Errors:
`INVALID_MODEL_UPDATE` when `updates` is not an object or
contains unsupported keys (`error.details.unsupported_keys`
and `error.details.supported_keys` list which).
`INVALID_MODEL_NAME` when `name` is present but not a non-blank
string.
`ModelNotFoundError` if no model is active.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| updates | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||