chore(automation): trim docstrings to intent only

Cut the docstrings and Field(description=...) text across the entire
automations/ tree down to single-line intent statements, matching the
multi_agent_chat conciseness style:

- Module docstrings: one line stating what the file is.
- Class docstrings: deleted when the class name + module docstring
  already cover intent; kept only where they add a constraint or
  rationale not visible in the signature.
- Pydantic Field descriptions: short noun phrases / clauses, not
  full sentences. Reasoning that belonged in the design plan moved
  out of the code.
- Enum values: per-value docstrings replaced with terse inline
  comments where the meaning isn't obvious from the name.

Behaviour is unchanged. The same 33 files, same public surface, same
imports — verified by re-running the 10-point registry smoke test and
the 8-point schema round-trip / constraint suite from commits 9 and
10.

LOC: 1180 → 691 (-42%).

surfsense_backend/app/automations/schemas/definition/__init__.py

@@ -1,4 +1,4 @@
-"""Automation definition envelope: the editable structured spec users author and run."""
+"""Automation definition envelope and its building blocks."""
 
 from __future__ import annotations
 

surfsense_backend/app/automations/schemas/definition/envelope.py

@@ -1,4 +1,4 @@
-"""``AutomationDefinition`` — the top-level envelope persisted in ``automations.definition``."""
+"""``AutomationDefinition`` — top-level envelope persisted in ``automations.definition``."""
 
 from __future__ import annotations
 
@@ -12,78 +12,15 @@ from .trigger_spec import TriggerSpec
 
 
 class AutomationDefinition(BaseModel):
-    """The top-level JSON shape stored in ``automations.definition``.
-
-    This is the editable spec a user authors (or the NL generator
-    produces). The envelope is structural only — every nested
-    discriminator (``triggers[].type``, ``plan[].action``) is resolved
-    against the registries at validation time, so adding a new
-    trigger or action type does not require touching this schema.
-
-    See ``automation-design-plan.md`` §5 for the worked example and
-    rationale.
-    """
+    """Top-level shape of an automation. See automation-design-plan.md §5."""
 
     model_config = ConfigDict(extra="forbid")
 
-    schema_version: str = Field(
-        default="1.0",
-        description=(
-            "Schema version of the envelope itself. Migrations bump "
-            "this when the envelope shape changes; nested per-type "
-            "configs evolve independently via the registries."
-        ),
-    )
-    name: str = Field(
-        ...,
-        description="Short, user-facing name shown in lists.",
-        min_length=1,
-        max_length=200,
-    )
-    goal: str | None = Field(
-        default=None,
-        description=(
-            "Optional plain-language statement of what the "
-            "automation is for. Used by the NL generator's review "
-            "pass and by the UI's run dialog."
-        ),
-    )
-    inputs: InputsBlock | None = Field(
-        default=None,
-        description=(
-            "Optional input contract. When omitted, the automation "
-            "accepts no inputs at fire time."
-        ),
-    )
-    triggers: list[TriggerSpec] = Field(
-        default_factory=list,
-        description=(
-            "Triggers that fire this automation. Empty list means "
-            "the automation is only runnable via the manual "
-            "``Run now`` path."
-        ),
-    )
-    plan: list[PlanStep] = Field(
-        ...,
-        description=(
-            "Ordered sequence of steps. Executed in array order — "
-            "no parallelism, no DAGs, no loops at the envelope "
-            "level."
-        ),
-        min_length=1,
-    )
-    execution: ExecutionBlock = Field(
-        default_factory=ExecutionBlock,
-        description=(
-            "Execution defaults (timeouts, retries, concurrency, "
-            "budget). All fields default to safe values; the block "
-            "may be omitted entirely."
-        ),
-    )
-    metadata: MetadataBlock = Field(
-        default_factory=MetadataBlock,
-        description=(
-            "Free-form metadata (tags, NL-generator breadcrumbs, "
-            "UI annotations). Tolerates unknown keys by design."
-        ),
-    )
+    schema_version: str = "1.0"
+    name: str = Field(..., min_length=1, max_length=200)
+    goal: str | None = None
+    inputs: InputsBlock | 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)

surfsense_backend/app/automations/schemas/definition/execution.py

@@ -1,4 +1,4 @@
-"""``ExecutionBlock`` — the ``execution`` section of the automation definition."""
+"""``ExecutionBlock`` — automation-wide execution defaults (overridable per step)."""
 
 from __future__ import annotations
 
@@ -10,67 +10,16 @@ from .plan_step import PlanStep
 
 
 class ExecutionBlock(BaseModel):
-    """The ``execution`` block of an ``AutomationDefinition``.
-
-    Carries automation-wide defaults that individual ``PlanStep``s
-    can override. Every field has a sane default so an automation
-    definition may omit the block entirely; in that case all defaults
-    apply.
-
-    ``on_failure`` is a secondary plan that runs only when the main
-    ``plan`` fails after retries exhaust. It uses the same
-    ``PlanStep`` shape as the main plan and shares the same execution
-    semantics.
-    """
-
     model_config = ConfigDict(extra="forbid")
 
-    timeout_seconds: int = Field(
-        default=600,
-        gt=0,
-        description=(
-            "Hard wall-clock cap for the entire run. The executor "
-            "transitions the run to ``timed_out`` when this is "
-            "exceeded."
-        ),
-    )
-    max_retries: int = Field(
-        default=2,
-        ge=0,
-        description=(
-            "Per-step retry budget applied when a step raises a "
-            "retryable error. Steps may override per-step."
-        ),
-    )
-    retry_backoff: Literal["exponential", "linear", "none"] = Field(
-        default="exponential",
-        description="Backoff policy between retries.",
-    )
-    concurrency: Literal[
-        "drop_if_running", "queue", "always"
-    ] = Field(
-        default="drop_if_running",
-        description=(
-            "Behaviour when a new fire arrives while a previous run "
-            "is still in progress. ``drop_if_running`` skips the new "
-            "fire, ``queue`` enqueues it, ``always`` runs it in "
-            "parallel."
-        ),
-    )
+    timeout_seconds: int = Field(default=600, gt=0, description="Wall-clock cap for the run.")
+    max_retries: int = Field(default=2, ge=0, description="Per-step retry budget.")
+    retry_backoff: Literal["exponential", "linear", "none"] = "exponential"
+    concurrency: Literal["drop_if_running", "queue", "always"] = "drop_if_running"
     budget_cap_usd: float | None = Field(
-        default=None,
-        gt=0,
-        description=(
-            "Optional mid-flight cost cap in USD. The executor kills "
-            "the run when accumulated cost exceeds this value. v1 "
-            "treats this as an advisory because cost tracking lands "
-            "with the executor in a later step."
-        ),
+        default=None, gt=0, description="Kill the run when accumulated cost exceeds this."
     )
     on_failure: list[PlanStep] = Field(
         default_factory=list,
-        description=(
-            "Secondary plan executed only when the main plan fails "
-            "after retries exhaust. Empty list means no fallback."
-        ),
+        description="Steps run when the main plan fails after retries.",
     )

surfsense_backend/app/automations/schemas/definition/inputs.py

@@ -1,4 +1,4 @@
-"""``InputsBlock`` — the ``inputs`` section of the automation definition."""
+"""``InputsBlock`` — JSON Schema for inputs an automation accepts at fire time."""
 
 from __future__ import annotations
 
@@ -8,23 +8,6 @@ from pydantic import BaseModel, ConfigDict, Field
 
 
 class InputsBlock(BaseModel):
-    """The ``inputs`` block of an ``AutomationDefinition``.
-
-    Holds a JSON Schema describing what data the automation accepts at
-    fire time. The same schema is used by:
-
-    - The form editor (to render the manual-run dialog).
-    - The dispatcher (to validate trigger payloads before enqueueing
-      executor work).
-    - The template engine (to expose ``{{ inputs.* }}`` references in
-      plan-step configs).
-
-    The ``schema`` value is the JSON-Schema dict itself, not a
-    Pydantic model — automations express their input contract in pure
-    JSON Schema so it round-trips losslessly through the database and
-    the NL generator.
-    """
-
     model_config = ConfigDict(
         extra="forbid",
         populate_by_name=True,
@@ -34,10 +17,5 @@ class InputsBlock(BaseModel):
     schema_: dict[str, Any] = Field(
         ...,
         alias="schema",
-        description=(
-            "JSON Schema (draft-07 compatible) describing the inputs "
-            "this automation accepts. Properties may use the special "
-            "``$last_fired_at`` default literal to bind to the "
-            "trigger's last fire time."
-        ),
+        description="JSON Schema (draft-07) for accepted inputs.",
     )

surfsense_backend/app/automations/schemas/definition/metadata.py

@@ -1,4 +1,4 @@
-"""``MetadataBlock`` — the ``metadata`` section of the automation definition."""
+"""``MetadataBlock`` — free-form metadata on a definition. Extra keys allowed."""
 
 from __future__ import annotations
 
@@ -6,31 +6,9 @@ from pydantic import BaseModel, ConfigDict, Field
 
 
 class MetadataBlock(BaseModel):
-    """Free-form metadata attached to the automation definition.
-
-    Unlike the rest of the envelope this block tolerates unknown keys
-    (``extra='allow'``) — it's a deliberate extension point for
-    UI annotations, NL-generator breadcrumbs, custom tags, etc.
-
-    Two fields are first-class so the rest of the system can rely on
-    them without reaching into the loose extras:
-
-    ``tags`` — used by the UI for filtering and grouping.
-    ``created_from_nl`` — set by the NL generator so we can later
-    measure how many runs came from natural-language authoring.
-    """
-
     model_config = ConfigDict(extra="allow")
 
-    tags: list[str] = Field(
-        default_factory=list,
-        description="UI-facing tags. No semantic meaning to the engine.",
-    )
+    tags: list[str] = Field(default_factory=list)
     created_from_nl: bool = Field(
-        default=False,
-        description=(
-            "True when the definition was produced by the NL "
-            "generator (set automatically by the generator path; "
-            "human-authored definitions keep this false)."
-        ),
+        default=False, description="True when produced by the NL generator."
     )

surfsense_backend/app/automations/schemas/definition/plan_step.py

@@ -1,4 +1,4 @@
-"""``PlanStep`` — one entry in the envelope's ``plan`` array."""
+"""``PlanStep`` — one step in the sequential plan."""
 
 from __future__ import annotations
 
@@ -8,79 +8,21 @@ from pydantic import BaseModel, ConfigDict, Field
 
 
 class PlanStep(BaseModel):
-    """One step in an automation's sequential plan.
-
-    Steps run in array order, no parallelism, no DAGs, no loops. The
-    ``when`` Jinja expression provides conditional skip; branching is
-    achieved by ``when`` clauses on multiple steps. For looping or
-    parallel work, the user routes through ``agent_task`` and lets the
-    agent reason about it.
-
-    ``config`` is dispatched against the action registry at
-    validation time — its shape is determined by
-    ``ActionDefinition.config_schema`` for the ``action`` value.
-
-    ``output_as`` binds the step's typed output into the template
-    namespace for later steps, e.g. ``output_as: 'summary'`` then
-    ``{{ summary.bullets }}`` in a downstream step's config.
-    """
-
     model_config = ConfigDict(extra="forbid")
 
-    step_id: str = Field(
-        ...,
-        description=(
-            "Unique-within-plan identifier. Used in run logs and as "
-            "the default for ``output_as`` when not provided."
-        ),
-        min_length=1,
-    )
-    action: str = Field(
-        ...,
-        description=(
-            "Action-type discriminator (e.g., ``agent_task``). "
-            "Resolved against the action registry."
-        ),
-        min_length=1,
-    )
+    step_id: str = Field(..., min_length=1, description="Unique within the plan.")
+    action: str = Field(..., min_length=1, description="Action type; resolved via registry.")
     when: str | None = Field(
         default=None,
-        description=(
-            "Optional Jinja expression evaluated against the run "
-            "context. Step is skipped when the expression is "
-            "falsy."
-        ),
+        description="Optional Jinja expression; step is skipped when falsy.",
     )
     config: dict[str, Any] = Field(
         default_factory=dict,
-        description=(
-            "Action-type-specific config. Validated against the "
-            "registered ``ActionDefinition.config_schema`` for "
-            "``action`` at definition-save time. Jinja templates "
-            "inside config are rendered at step-execute time."
-        ),
+        description="Action-type-specific config; Jinja-rendered at execute time.",
     )
     output_as: str | None = Field(
         default=None,
-        description=(
-            "Name to bind the step output under for downstream "
-            "steps. Defaults to ``step_id`` when omitted."
-        ),
-    )
-    max_retries: int | None = Field(
-        default=None,
-        ge=0,
-        description=(
-            "Per-step override of the automation-level ``max_retries``. "
-            "Omitted means inherit from execution block."
-        ),
-    )
-    timeout_seconds: int | None = Field(
-        default=None,
-        gt=0,
-        description=(
-            "Per-step override of the automation-level "
-            "``timeout_seconds``. Omitted means inherit from "
-            "execution block."
-        ),
+        description="Bind step output under this name. Defaults to step_id.",
     )
+    max_retries: int | None = Field(default=None, ge=0)
+    timeout_seconds: int | None = Field(default=None, gt=0)

surfsense_backend/app/automations/schemas/definition/trigger_spec.py

@@ -1,4 +1,4 @@
-"""``TriggerSpec`` — one entry in the envelope's ``triggers`` array."""
+"""``TriggerSpec`` — one entry in the definition's ``triggers[]`` array."""
 
 from __future__ import annotations
 
@@ -8,33 +8,10 @@ from pydantic import BaseModel, ConfigDict, Field
 
 
 class TriggerSpec(BaseModel):
-    """One trigger attached to an automation, as it appears in the definition.
-
-    The envelope keeps ``config`` as an untyped JSON object on purpose
-    — the per-type config schemas live in
-    ``app.automations.schemas.triggers`` and are dispatched at
-    validation time by looking up ``type`` in the trigger registry.
-
-    This mirrors the design's "definitions are pure data" principle:
-    the envelope describes shape, the registry resolves names to
-    behaviour.
-    """
-
     model_config = ConfigDict(extra="forbid")
 
-    type: str = Field(
-        ...,
-        description=(
-            "Trigger-type discriminator (e.g., ``schedule``, ``manual``). "
-            "Resolved against the trigger registry."
-        ),
-        min_length=1,
-    )
+    type: str = Field(..., min_length=1, description="Trigger type; resolved via registry.")
     config: dict[str, Any] = Field(
         default_factory=dict,
-        description=(
-            "Trigger-type-specific config. Validated against the "
-            "registered ``TriggerDefinition.config_schema`` for "
-            "``type`` at definition-save time."
-        ),
+        description="Type-specific config; validated against the trigger's schema.",
     )