HWM-related schemas¶
- pydantic model horizon.commons.schemas.v1.hwm.HWMResponseV1¶
HWM response.
- field id: int [Required]¶
HWM id
- field namespace_id: int [Required]¶
Namespace id HWM is bound to
- field name: str [Required]¶
HWM name, unique in the namespace
- field description: str [Required]¶
HWM description
- field type: str [Required]¶
HWM type, any non-empty string
- field value: Any [Required]¶
HWM value, any JSON serializable value
- field entity: str | None = None¶
Name of entity associated with the HWM. Can be any string
- field expression: str | None = None¶
Expression used to calculate HWM value. Can be any string
- field changed_at: datetime [Required]¶
Timestamp of last change of the HWM data
- field changed_by: str | None = None¶
Latest user who changed the HWM data
- class Config¶
- pydantic model horizon.commons.schemas.v1.hwm.HWMListResponseV1¶
- field hwms: List[HWMResponseV1] [Required]¶
- pydantic model horizon.commons.schemas.v1.hwm.HWMPaginateQueryV1¶
Query params for HWM pagination request.
- field namespace_id: int [Required]¶
- field name: str | None = None¶
- Constraints:
min_length = 1
max_length = 2048
- field page: int = 1¶
Page number
- Constraints:
gt = 0
- field page_size: int = 20¶
Number of items per page
- Constraints:
gt = 0
le = 50
- pydantic model horizon.commons.schemas.v1.hwm.HWMCreateRequestV1¶
Request body for HWM create request.
- field namespace_id: int [Required]¶
- field name: str [Required]¶
- Constraints:
min_length = 1
max_length = 2048
- field description: str = ''¶
- field type: str [Required]¶
- Constraints:
min_length = 1
max_length = 64
- field value: Any [Required]¶
- field entity: str | None = None¶
- field expression: str | None = None¶
- pydantic model horizon.commons.schemas.v1.hwm.HWMUpdateRequestV1¶
Request body for HWM update request.
If field value is not set, it will not be updated.
- field name: str = Unset()¶
- Constraints:
min_length = 1
max_length = 2048
- field description: str = Unset()¶
- field type: str = Unset()¶
- Constraints:
min_length = 1
max_length = 64
- field value: Any = Unset()¶
- field entity: str | None = Unset()¶
- field expression: str | None = Unset()¶
- class Config¶
- pydantic model horizon.commons.schemas.v1.hwm.HWMBulkCopyRequestV1¶
Schema for request body of HWM copy operation.
- field source_namespace_id: int [Required]¶
Source namespace ID from which HWMs are copied.
- field target_namespace_id: int [Required]¶
Target namespace ID to which HWMs are copied.
- field hwm_ids: List[int] [Required]¶
List of HWM IDs to be copied.
- field with_history: bool = False¶
Whether to copy HWM history.