apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-05-29 19:35:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor(automation): drop Block suffix from definition components

Browse source
This commit is contained in:
CREDO23 2026-05-27 13:48:41 +02:00
parent 7f4c1c25ab
commit 56b3e1bfc4
6 changed files with 25 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

12
surfsense_backend/app/automations/schemas/__init__.py
View file

@ -5,9 +5,9 @@ from __future__ import annotations
from .actions import AgentTaskActionParams
from .definition import (
AutomationDefinition,
ExecutionBlock,
InputsBlock,
MetadataBlock,
Execution,
Inputs,
Metadata,
PlanStep,
TriggerSpec,
)
@ -16,10 +16,10 @@ from .triggers import ManualTriggerParams, ScheduleTriggerParams
__all__ = [
"AgentTaskActionParams",
"AutomationDefinition",
"ExecutionBlock",
"InputsBlock",
"Execution",
"Inputs",
"ManualTriggerParams",
"MetadataBlock",
"Metadata",
"PlanStep",
"ScheduleTriggerParams",
"TriggerSpec",

14
surfsense_backend/app/automations/schemas/definition/__init__.py
View file

@ -1,19 +1,19 @@
"""Automation definition envelope and its building blocks."""
"""Automation definition envelope and its components."""
from __future__ import annotations
from .envelope import AutomationDefinition
from .execution import ExecutionBlock
from .inputs import InputsBlock
from .metadata import MetadataBlock
from .execution import Execution
from .inputs import Inputs
from .metadata import Metadata
from .plan_step import PlanStep
from .trigger_spec import TriggerSpec
__all__ = [
"AutomationDefinition",
"ExecutionBlock",
"InputsBlock",
"MetadataBlock",
"Execution",
"Inputs",
"Metadata",
"PlanStep",
"TriggerSpec",
]

12
surfsense_backend/app/automations/schemas/definition/envelope.py
View file

@ -4,9 +4,9 @@ from __future__ import annotations
from pydantic import BaseModel, ConfigDict, Field
from .execution import ExecutionBlock
from .inputs import InputsBlock
from .metadata import MetadataBlock
from .execution import Execution
from .inputs import Inputs
from .metadata import Metadata
from .plan_step import PlanStep
from .trigger_spec import TriggerSpec
@ -19,8 +19,8 @@ class AutomationDefinition(BaseModel):
schema_version: str = "1.0"
name: str = Field(..., min_length=1, max_length=200)
goal: str | None = None
inputs: InputsBlock | None = None
inputs: Inputs | None = None
triggers: list[TriggerSpec] = Field(default_factory=list)
plan: list[PlanStep] = Field(..., min_length=1)
execution: ExecutionBlock = Field(default_factory=ExecutionBlock)
metadata: MetadataBlock = Field(default_factory=MetadataBlock)
execution: Execution = Field(default_factory=Execution)
metadata: Metadata = Field(default_factory=Metadata)

4
surfsense_backend/app/automations/schemas/definition/execution.py
View file

@ -1,4 +1,4 @@
"""``ExecutionBlock`` — automation-wide execution defaults (overridable per step)."""
"""``Execution`` — automation-wide execution defaults (overridable per step)."""
from __future__ import annotations
@ -9,7 +9,7 @@ from pydantic import BaseModel, ConfigDict, Field
from .plan_step import PlanStep
class ExecutionBlock(BaseModel):
class Execution(BaseModel):
model_config = ConfigDict(extra="forbid")
timeout_seconds: int = Field(default=600, gt=0, description="Wall-clock cap for the run.")

4
surfsense_backend/app/automations/schemas/definition/inputs.py
View file

@ -1,4 +1,4 @@
"""``InputsBlock`` — JSON Schema for inputs an automation accepts at fire time."""
"""``Inputs`` — JSON Schema for inputs an automation accepts at fire time."""
from __future__ import annotations
@ -7,7 +7,7 @@ from typing import Any
from pydantic import BaseModel, ConfigDict, Field
class InputsBlock(BaseModel):
class Inputs(BaseModel):
model_config = ConfigDict(
extra="forbid",
populate_by_name=True,

4
surfsense_backend/app/automations/schemas/definition/metadata.py
View file

@ -1,11 +1,11 @@
"""``MetadataBlock`` — free-form metadata on a definition. Extra keys allowed."""
"""``Metadata`` — free-form metadata on a definition. Extra keys allowed."""
from __future__ import annotations
from pydantic import BaseModel, ConfigDict, Field
class MetadataBlock(BaseModel):
class Metadata(BaseModel):
model_config = ConfigDict(extra="allow")
tags: list[str] = Field(default_factory=list)