Skip to content

base_models

A collection of base Pydantic models.

MessageResponse pydantic-model

Bases: BaseModel

Response model for a generic, str message response.

Fields:

  • message (str)

NamedEntityCreate pydantic-model

Bases: _NamedEntityFields

Create payload for named entities.

name is required. tags and description default to None.

Fields:

name pydantic-field

The name of the entity.

NamedEntityUpdate pydantic-model

Bases: _NamedEntityFields

PATCH payload for named entities.

Universal field semantics:

  • Omit a field to leave it unchanged.
  • Include a field with a value to update it.
  • Include a field with null to clear it (where the field is nullable in storage — e.g. description, tags).

name is the exception: it is required in storage and cannot be cleared. Sending {"name": null} is rejected with 422 — omit the field if you don't want to change it.

Fields:

name = None pydantic-field

New name for the entity. Omit to leave unchanged. Cannot be null.

name_cannot_be_explicit_null()

Reject {"name": null} while still allowing name to be omitted.

Sending an explicit null is rejected because name is required in storage; clearing it would leave the entity in an invalid state. Omit the field if you don't want to change it.