{
"openapi": "3.1.0",
"info": {
"title": "Moadim Server API",
"description": "REST API for managing routines",
"license": {
"name": "MIT",
"identifier": "MIT"
},
"version": "1.7.4"
},
"servers": [
{
"url": "/api/v1",
"description": "This server"
}
],
"paths": {
"/agents": {
"get": {
"tags": [
"crate::routes::list_agents"
],
"summary": "`GET /agents` — list the agent registry keys a routine may target.",
"operationId": "list_agents",
"responses": {
"200": {
"description": "Available agent names",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/config/max-concurrent-runs": {
"get": {
"tags": [
"crate::routes::http"
],
"summary": "`GET /config/max-concurrent-runs` — the global routine concurrency cap (issue #1155).",
"operationId": "get_max_concurrent_runs",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaxConcurrentRunsResponse"
}
}
}
}
}
},
"put": {
"tags": [
"crate::routes::http"
],
"summary": "`PUT /config/max-concurrent-runs` — set or clear the persisted concurrency-cap override.",
"description": "Writes to `machine.local.toml`. The `MOADIM_MAX_CONCURRENT_RUNS` env var still takes\nprecedence at runtime when set; this only takes effect while the env var is unset. Takes\neffect on the next trigger check (read live from disk, like the env var today) — no restart\nrequired. Returns `500` if the write fails.",
"operationId": "put_max_concurrent_runs",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetMaxConcurrentRunsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaxConcurrentRunsResponse"
}
}
}
},
"500": {
"description": "Write failed"
}
}
}
},
"/config/user-prompt": {
"get": {
"tags": [
"crate::routes::http"
],
"summary": "`GET /config/user-prompt` — the persistent system prompt appended to every routine's agent\ninstructions file (see [`crate::paths::user_prompt_path`]), as plain text. Empty (not an\nerror) when nothing has been saved yet.",
"operationId": "get_user_prompt",
"responses": {
"200": {
"description": "User prompt contents as plain text"
}
}
},
"put": {
"tags": [
"crate::routes::http"
],
"summary": "`PUT /config/user-prompt` — replace the persistent system prompt.",
"description": "Creates the config directory if absent. Every routine's next run picks up the change (the\nlaunch command re-reads this file each time — see `command::system_prompt_stmts`); already\nrunning agents are unaffected.",
"operationId": "put_user_prompt",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetUserPromptRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Saved"
},
"500": {
"description": "Write failed"
}
}
}
},
"/health": {
"get": {
"tags": [
"crate::routes::health"
],
"summary": "`GET /health` — health check with uptime.",
"operationId": "health",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponse"
}
}
}
}
}
}
},
"/machine": {
"get": {
"tags": [
"crate::routes::http"
],
"summary": "`GET /machine` — the current machine's resolved identity.",
"description": "Returns the name this daemon uses to match `machines[]` targeting lists on routines. Useful for\nclients (e.g. the UI) that want to default their views to local entries only.",
"operationId": "get_current_machine",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MachineResponse"
}
}
}
}
}
},
"put": {
"tags": [
"crate::routes::http"
],
"summary": "`PUT /machine` — rename this machine's identity.",
"description": "Writes the new name to `machine.local.toml` and returns it trimmed. Returns `400` if the name\nis empty, `500` if the write fails. The `MOADIM_MACHINE` env var takes precedence at runtime;\nsetting the name here persists it for when the env var is absent.\n\nAs a side-effect, every routine whose `machines` list contained the old name is updated in\nmemory, on disk, and in the crontab so that the rename propagates atomically.",
"operationId": "put_machine",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetMachineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MachineResponse"
}
}
}
},
"400": {
"description": "Empty name"
},
"500": {
"description": "Write failed"
}
}
}
},
"/machines": {
"get": {
"tags": [
"crate::routes::http"
],
"summary": "`GET /machines` — distinct machine names this daemon knows about.",
"description": "There is no central machine registry, so the \"known\" set is the union of every `machines`\ntargeting list declared by a routine, plus this machine's own resolved identity\n([`crate::machine::current_machine`]) so the local machine is always pickable even before\nanything targets it. Sorted and de-duplicated. Backs the UI machine picker; mirrors the\n`moadim machine list` CLI but reads the live in-memory store instead of disk.",
"operationId": "list_machines",
"responses": {
"200": {
"description": "Known machine names, sorted",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/metrics": {
"get": {
"tags": [
"crate::routes::metrics"
],
"summary": "`GET /api/v1/metrics` — Prometheus text-exposition metrics. See the module doc for how each\nseries is derived; `/health` remains the cheap liveness probe, this is the richer surface.",
"operationId": "metrics",
"responses": {
"200": {
"description": "Prometheus text exposition format (version 0.0.4)",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/restart": {
"post": {
"tags": [
"crate::routes::restart"
],
"summary": "`POST /restart` — stop this server and start a fresh instance.",
"description": "The running server cannot rebind its own port, so it spawns a detached `moadim restart` helper\nthat stops it and starts a new process, mirroring the `moadim restart` CLI command and the\n`restart` MCP tool. Responds with the helper's PID before the restart completes.",
"operationId": "restart",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestartResponse"
}
}
}
},
"500": {
"description": "could not spawn the restart helper"
}
}
}
},
"/routines": {
"get": {
"tags": [
"crate::routes::list_routines"
],
"summary": "`GET /routines` — list routines, optionally filtered and sorted by repository.",
"operationId": "list_routines",
"parameters": [
{
"name": "repository",
"in": "query",
"description": "Keep only routines with at least one repository whose URL contains this\nsubstring (case-insensitive). Empty or absent keeps every routine.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "Field to sort by (default: creation time).",
"required": false,
"schema": {
"$ref": "#/components/schemas/RoutineSort"
}
},
{
"name": "order",
"in": "query",
"description": "Sort direction (default: ascending).",
"required": false,
"schema": {
"$ref": "#/components/schemas/SortOrder"
}
},
{
"name": "local_only",
"in": "query",
"description": "When `true`, only return routines whose `machines` list includes the current machine.\nDefaults to `false` (return all routines, preserving backwards compatibility).",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "include_prompts",
"in": "query",
"description": "When `true`, include each routine's `prompt` in the response. Defaults to `false`:\nthe prompt (often the largest field) is omitted so listings stay compact. Fetch a\nsingle routine with `svc_get` / `GET /routines/{id}` to always see its prompt.",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoutineResponse"
}
}
}
}
}
}
},
"post": {
"tags": [
"crate::routes::create_routine"
],
"summary": "`POST /routines` — create a new routine.",
"operationId": "create_routine",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRoutineRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutineResponse"
}
}
}
},
"400": {
"description": "Invalid cron expression"
}
}
}
},
"/routines.ics": {
"get": {
"tags": [
"crate::routines"
],
"summary": "`GET /routines.ics` — iCalendar feed of every enabled routine's upcoming fire times.",
"description": "Returns a `text/calendar` body suitable for subscribing to in an external calendar\n(Google Calendar, Apple Calendar, …) so upcoming runs show up alongside other events.\nWith `?routine=<id>` the feed is scoped to a single routine (named after it); without\nit every enabled routine is rendered (issue #263).",
"operationId": "ical_feed",
"parameters": [
{
"name": "routine",
"in": "query",
"description": "Render only the fire times of the routine with this UUID. Absent (the default)\nrenders every enabled routine. An unknown or disabled id yields a well-formed\nempty calendar.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "iCalendar (text/calendar) feed of upcoming routine fire times"
}
}
}
},
"/routines/cleanup": {
"post": {
"tags": [
"crate::routes::cleanup_workbenches"
],
"summary": "`POST /routines/cleanup` — reap finished, expired run workbenches on demand.",
"operationId": "cleanup_workbenches",
"responses": {
"200": {
"description": "Workbenches removed and bytes freed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CleanupResponse"
}
}
}
}
}
}
},
"/routines/lock": {
"get": {
"tags": [
"crate::routes::get_lock_status"
],
"summary": "`GET /routines/lock` — return the current global lock status.",
"operationId": "get_lock_status",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LockStatus"
}
}
}
}
}
},
"post": {
"tags": [
"crate::routes::lock_routines"
],
"summary": "`POST /routines/lock` — create a lock sentinel, halting all routine scheduling and triggers.",
"operationId": "lock_routines",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LockRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LockStatus"
}
}
}
},
"400": {
"description": "Unknown scope"
},
"500": {
"description": "IO error"
}
}
},
"delete": {
"tags": [
"crate::routes::unlock_routines"
],
"summary": "`DELETE /routines/lock` — remove lock sentinel(s), restoring routine scheduling.",
"operationId": "unlock_routines",
"parameters": [
{
"name": "scope",
"in": "query",
"description": "Which sentinel(s) to remove: `\"shared\"`, `\"local\"`, or `\"all\"`.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LockStatus"
}
}
}
},
"400": {
"description": "Unknown scope"
},
"500": {
"description": "IO error"
}
}
}
},
"/routines/runs": {
"get": {
"tags": [
"crate::routines"
],
"summary": "`GET /routines/runs` — the most recent runs across every routine, newest first. Backs the\noverview \"recent runs\" panel with a single workbench scan instead of one request per routine.",
"operationId": "get_all_runs",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Cap on the number of runs returned (default: `DEFAULT_FLEET_RUNS_LIMIT`).",
"required": false,
"schema": {
"type": [
"integer",
"null"
],
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FleetRunSummary"
}
}
}
}
}
}
}
},
"/routines/{id}": {
"get": {
"tags": [
"crate::routes::get_routine"
],
"summary": "`GET /routines/{id}` — retrieve a single routine by UUID.",
"operationId": "get_routine",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutineResponse"
}
}
}
},
"404": {
"description": "Not found"
}
}
},
"put": {
"tags": [
"crate::routes::update_routine"
],
"summary": "`PUT /routines/{id}` — alias for `PATCH`: a partial-merge update, not a full replace.",
"description": "Fields omitted from the body are retained from the existing record, exactly as with `PATCH`.\nA client expecting RFC 7231 full-resource-replacement semantics (omitted fields reset to\ndefault) should not rely on this route for that; use `PATCH` and set every field explicitly.",
"operationId": "replace",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRoutineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutineResponse"
}
}
}
},
"400": {
"description": "Invalid"
},
"404": {
"description": "Not found"
}
}
},
"delete": {
"tags": [
"crate::routes::delete_routine"
],
"summary": "`DELETE /routines/{id}` — delete a routine by UUID.",
"operationId": "delete_routine",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutineResponse"
}
}
}
},
"404": {
"description": "Not found"
}
}
},
"patch": {
"tags": [
"crate::routes::update_routine"
],
"summary": "`PATCH /routines/{id}` — partially update a routine.",
"operationId": "update_routine",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRoutineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutineResponse"
}
}
}
},
"400": {
"description": "Invalid"
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/flags": {
"get": {
"tags": [
"crate::routes::list_flags"
],
"summary": "`GET /routines/{id}/flags` — list open flags raised against a routine.",
"operationId": "list_flags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Flag"
}
}
}
}
},
"404": {
"description": "Not found"
}
}
},
"post": {
"tags": [
"crate::routes::create_flag"
],
"summary": "`POST /routines/{id}/flags` — raise a new flag against a routine.",
"operationId": "create_flag",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFlagRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Flag"
}
}
}
},
"400": {
"description": "Invalid type/description/scope"
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/flags/{filename}": {
"delete": {
"tags": [
"crate::routes::resolve_flag"
],
"summary": "`DELETE /routines/{id}/flags/{filename}` — resolve (delete) a flag.",
"operationId": "resolve_flag",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filename",
"in": "path",
"description": "Flag filename, as returned by create/list",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Resolved"
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/logs": {
"get": {
"tags": [
"crate::routines"
],
"summary": "`GET /routines/{id}/logs` — return the newest workbench `agent.log` as plain text.",
"operationId": "get_logs",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Log file contents as plain text"
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/prompt-preview": {
"get": {
"tags": [
"crate::routines"
],
"summary": "`GET /routines/{id}/prompt-preview` — the exact prompt body a run would receive, computed\nin-memory with no workbench, `prompt.md` write, or agent launch (issue #391). Includes the\nroutine-origin disclosure because it now lives in the composed prompt.",
"operationId": "get_prompt_preview",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Composed prompt body as plain text"
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/runs": {
"get": {
"tags": [
"crate::routes::list_routine_runs"
],
"summary": "`GET /routines/{id}/runs` — list every run workbench for the routine, newest first.",
"operationId": "list_routine_runs",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RunSummary"
}
}
}
}
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/runs/{workbench}/log": {
"get": {
"tags": [
"crate::routines"
],
"summary": "`GET /routines/{id}/runs/{workbench}/log` — return one specific run's `agent.log` as plain text.",
"operationId": "get_run_log",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "workbench",
"in": "path",
"description": "Workbench directory name (`{slug}-{unix_secs}`), from `GET /routines/{id}/runs`",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Log file contents as plain text"
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/runs/{workbench}/summary": {
"get": {
"tags": [
"crate::routines"
],
"summary": "`GET /routines/{id}/runs/{workbench}/summary` — return one specific run's agent-authored\n`summary.md` as plain text (empty when the agent hasn't written one).",
"operationId": "get_run_summary",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "workbench",
"in": "path",
"description": "Workbench directory name (`{slug}-{unix_secs}`), from `GET /routines/{id}/runs`",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Summary file contents as plain text"
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/scheduled-trigger": {
"post": {
"tags": [
"crate::routines"
],
"summary": "`POST /routines/{id}/scheduled-trigger` — run a routine on its schedule.",
"description": "The daemon-side endpoint the generated crontab line invokes (`moadim schedule trigger <id>`).\nUnlike [`crate::routes::trigger_routine::trigger_routine`] it does not record a manual\ntrigger; the spawned command records the scheduled timestamp itself. See\n[`svc_trigger_scheduled`].",
"operationId": "scheduled_trigger",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Routine"
}
}
}
},
"404": {
"description": "Not found"
}
}
}
},
"/routines/{id}/trigger": {
"post": {
"tags": [
"crate::routes::trigger_routine"
],
"summary": "`POST /routines/{id}/trigger` — manually trigger a routine outside its schedule.",
"description": "Refuses (423, distinct message) when the routine is disabled or in power-saving mode. See\n[`crate::routines::svc_trigger`].",
"operationId": "trigger_routine",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Routine UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Routine"
}
}
}
},
"404": {
"description": "Not found"
}
}
}
},
"/shutdown": {
"post": {
"tags": [
"crate::routes::shutdown"
],
"summary": "`POST /shutdown` — ask the server to stop gracefully.",
"description": "Used by the UI \"STOP\" button (and the `moadim stop` command) to kill a backgrounded server that\nhas no controlling terminal. The response is sent before the graceful shutdown completes.",
"operationId": "shutdown",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShutdownResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"CleanupResponse": {
"type": "object",
"description": "Result of an on-demand workbench cleanup sweep.",
"required": [
"removed",
"freed_bytes"
],
"properties": {
"freed_bytes": {
"type": "integer",
"format": "int64",
"description": "Total disk space reclaimed, in bytes, summed across the removed workbench trees. Additive\nfield: existing `{\"removed\": N}` consumers are unaffected.",
"minimum": 0
},
"removed": {
"type": "integer",
"description": "Number of finished, expired run workbenches removed by this sweep.",
"minimum": 0
}
}
},
"CreateFlagRequest": {
"type": "object",
"description": "Request body for `POST /routines/{id}/flags`.",
"required": [
"type",
"description",
"scope"
],
"properties": {
"description": {
"type": "string",
"description": "Free-text description of what's unclear."
},
"scope": {
"type": "string",
"description": "`\"general\"` (committed, shared via git) or `\"local\"` (gitignored, machine-local)."
},
"type": {
"type": "string",
"description": "Free-text flag category. Common examples: `\"bug\"`, `\"gap\"`, `\"edge_case\"`, `\"question\"`,\n`\"blocker\"` — any string is accepted."
}
}
},
"CreateRoutineRequest": {
"type": "object",
"description": "Request body for creating a new routine.",
"required": [
"schedule",
"title",
"agent",
"prompt"
],
"properties": {
"agent": {
"type": "string",
"description": "Agent registry key to launch."
},
"enabled": {
"type": "boolean",
"description": "Whether to create the routine enabled (defaults to `true`)."
},
"env": {
"type": "object",
"description": "Non-secret environment variables to inject into the agent's shell session at launch,\nwritten to `routine.toml`'s `[env]` table (defaults to empty). Keys must match\n`[A-Za-z_][A-Za-z0-9_]*`; values must not contain newlines (#408). For secrets, edit the\ngitignored `routine.local.toml` sidecar directly on disk instead — it is never accepted\nover the API.",
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"type": "string"
}
},
"goal": {
"type": [
"string",
"null"
],
"description": "A very short (at most 5 lines) statement of the routine's goal. Optional; `None` leaves it\nunset. When present it is rendered into the agent's `prompt.md` as a `## Goal` preamble."
},
"machines": {
"type": "array",
"items": {
"type": "string"
},
"description": "Machines to run this routine on (defaults to empty = runs nowhere until assigned)."
},
"max_runtime_secs": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Max wall-clock seconds a run may execute before the watchdog kills its hung\nsession. `None` uses the default cap (`MAX_RUNTIME_SECS`). Must be greater\nthan zero when set; `0` is rejected (#233).",
"minimum": 0
},
"model": {
"type": [
"string",
"null"
],
"description": "Model ID to run the agent with, or `None` to use the agent's own default. A\nblank/whitespace-only value is treated the same as `None`."
},
"prompt": {
"type": "string",
"description": "Task prompt."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Repository"
},
"description": "Repositories to list as context (defaults to empty)."
},
"schedule": {
"type": "string",
"description": "Cron expression for the new routine. Evaluated in the host's local system\ntimezone (the OS crontab timezone), not UTC."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Free-form labels for the routine (defaults to empty). Each entry is trimmed\nand must be non-blank."
},
"title": {
"type": "string",
"description": "Human name for the routine."
},
"ttl_secs": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Workbench retention in seconds for finished runs; caps the cron-derived\nretention lower. `None` uses `min(MAX_TTL_SECS, cron interval)`. Must be\ngreater than zero when set; `0` is rejected (#233).",
"minimum": 0
}
}
},
"DependencyHealth": {
"type": "object",
"description": "External-binary dependencies the daemon relies on at runtime, and whether each is resolvable on\nthe daemon's `PATH`. Surfaced in [`HealthResponse`] so the UI/CLI can flag a missing dependency\ninstead of having routine runs silently no-op.",
"required": [
"tmux",
"python3"
],
"properties": {
"python3": {
"type": "boolean",
"description": "Whether `python3` resolves on the daemon's `PATH`. The built-in `claude` agent's `setup`\nstep runs a `python3` snippet to pre-seed workspace-trust state; when it is missing that\nstep fails silently and the routine still shows a healthy status (issue #404)."
},
"tmux": {
"type": "boolean",
"description": "Whether `tmux` (used to launch every routine agent) resolves on the daemon's `PATH`."
}
}
},
"Flag": {
"type": "object",
"description": "A single flag raised against a routine.",
"required": [
"filename",
"type",
"description",
"scope",
"created_at"
],
"properties": {
"created_at": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp (seconds) the flag was created.",
"minimum": 0
},
"description": {
"type": "string",
"description": "Free-text body describing what's unclear."
},
"filename": {
"type": "string",
"description": "Filename on disk under the routine's `flags/` dir; the handle used to resolve it."
},
"scope": {
"$ref": "#/components/schemas/FlagScope",
"description": "Whether this flag is committed (general) or machine-local."
},
"type": {
"type": "string",
"description": "Free-text category, e.g. `\"bug\"`, `\"gap\"`, `\"edge_case\"`, `\"question\"`."
}
}
},
"FlagScope": {
"type": "string",
"description": "Whether a flag file is committed to version control or kept machine-local.",
"enum": [
"general",
"local"
]
},
"FleetRunSummary": {
"type": "object",
"description": "One past (or in-progress) run, across every routine, listed newest-first — the fleet-wide\ncounterpart to [`RunSummary`] backing an overview \"recent runs\" view.",
"required": [
"routine_id",
"routine_title",
"workbench",
"started_at",
"started_at_local",
"status"
],
"properties": {
"exit_code": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Process exit code, when recorded."
},
"finished_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Unix seconds the run finished (`exit_code` file's mtime), `None` while running or unknown.",
"minimum": 0
},
"finished_at_local": {
"type": [
"string",
"null"
],
"description": "`finished_at` as a human-readable local timestamp, when finished."
},
"routine_id": {
"type": "string",
"description": "The routine this run belongs to."
},
"routine_title": {
"type": "string",
"description": "The routine's title, at the time of this call (not snapshotted per-run)."
},
"started_at": {
"type": "integer",
"format": "int64",
"description": "Unix seconds the run was triggered.",
"minimum": 0
},
"started_at_local": {
"type": "string",
"description": "`started_at` as a human-readable local (daemon machine's timezone) timestamp."
},
"status": {
"$ref": "#/components/schemas/RunStatus",
"description": "Success/failure/running/unknown, derived from the exit-code file and tmux session liveness."
},
"workbench": {
"type": "string",
"description": "Workbench directory name (`{slug}-{unix_secs}`)."
}
}
},
"HealthResponse": {
"type": "object",
"description": "Response body for `GET /health`.",
"required": [
"status",
"uptime_secs",
"running",
"machine",
"dependencies",
"version",
"git_sha",
"build_date"
],
"properties": {
"build_date": {
"type": "string",
"description": "Committer date (`YYYY-MM-DD`) of the build commit, or `\"unknown\"` outside a git checkout."
},
"dependencies": {
"$ref": "#/components/schemas/DependencyHealth",
"description": "Presence of required external binaries on the daemon's `PATH`."
},
"git_sha": {
"type": "string",
"description": "Short git commit SHA the daemon was built from, or `\"unknown\"` outside a git checkout."
},
"machine": {
"type": "string",
"description": "Resolved name of this machine (from `MOADIM_MACHINE`, `~/.config/moadim/machine.local.toml`, or hostname)."
},
"running": {
"type": "boolean",
"description": "Whether the server is running."
},
"server_exe_dir": {
"type": [
"string",
"null"
],
"description": "Absolute path of the directory containing the server executable, or `None` if unresolvable."
},
"server_root": {
"type": [
"string",
"null"
],
"description": "Absolute path of the server's working directory, or `None` if unresolvable."
},
"status": {
"type": "string",
"description": "Health status string (always `\"ok\"` when reachable)."
},
"uptime_secs": {
"type": "integer",
"format": "int64",
"description": "Seconds elapsed since the server started.",
"minimum": 0
},
"version": {
"type": "string",
"description": "Daemon version (from `CARGO_PKG_VERSION`)."
}
}
},
"LockRequest": {
"type": "object",
"description": "Request body for `POST /routines/lock`.",
"required": [
"scope"
],
"properties": {
"scope": {
"type": "string",
"description": "Which sentinel to create: `\"shared\"` (committed `.lock`) or `\"local\"` (gitignored `.local.lock`)."
}
}
},
"LockStatus": {
"type": "object",
"description": "Current state of both lock sentinels.",
"required": [
"shared",
"local",
"locked"
],
"properties": {
"local": {
"type": "boolean",
"description": "Whether the gitignored `.local.lock` file is present."
},
"locked": {
"type": "boolean",
"description": "`true` if either sentinel is present (all routine scheduling and triggers halted)."
},
"shared": {
"type": "boolean",
"description": "Whether the committed `.lock` file is present."
}
}
},
"MachineResponse": {
"type": "object",
"description": "Response body for `GET /machine`.",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Resolved name of this machine (from `MOADIM_MACHINE`, `~/.config/moadim/machine.local.toml`, or hostname)."
}
}
},
"MaxConcurrentRunsResponse": {
"type": "object",
"description": "Response body for `GET /config/max-concurrent-runs` and `PUT /config/max-concurrent-runs`.",
"required": [
"value"
],
"properties": {
"override_value": {
"type": [
"integer",
"null"
],
"description": "The persisted UI/REST override on its own, independent of the env var — `None` if never\nset. The UI should populate its input from this field (not `value`), so an env-var\noverride in effect doesn't get echoed back as though it were a saved setting.",
"minimum": 0
},
"value": {
"type": "integer",
"description": "Effective cap: the `MOADIM_MAX_CONCURRENT_RUNS` env var if set, else the persisted\nUI/REST override, else the built-in default. `0` means unbounded.",
"minimum": 0
}
}
},
"Repository": {
"type": "object",
"description": "A git repository made available to a routine's agent as prompt context (not cloned by moadim).",
"required": [
"repository"
],
"properties": {
"branch": {
"type": [
"string",
"null"
],
"description": "Branch to use, or `None` for the remote default branch."
},
"repository": {
"type": "string",
"description": "Git remote URL."
}
}
},
"RestartResponse": {
"type": "object",
"description": "Response body for `POST /restart` and the `restart` MCP tool.",
"required": [
"status",
"helper_pid"
],
"properties": {
"helper_pid": {
"type": "integer",
"format": "int32",
"description": "PID of the detached helper process performing the stop-old-then-start-new restart.",
"minimum": 0
},
"status": {
"type": "string",
"description": "Acknowledgement status (always `\"restarting\"`)."
}
}
},
"Routine": {
"type": "object",
"description": "A persisted routine: a scheduled AI-agent task.",
"required": [
"id",
"schedule",
"title",
"agent",
"enabled",
"source",
"created_at",
"updated_at"
],
"properties": {
"agent": {
"type": "string",
"description": "Agent registry key (e.g. `\"claude\"`) resolved from `~/.config/moadim/agents/`."
},
"created_at": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp (seconds) when the routine was created.",
"minimum": 0
},
"enabled": {
"type": "boolean",
"description": "Whether the routine is active."
},
"goal": {
"type": [
"string",
"null"
],
"description": "A very short (at most 5 lines) statement of the routine's goal — the \"why\" behind the\nprompt. Rendered into the agent's `prompt.md` as a `## Goal` preamble. `None` when unset."
},
"id": {
"type": "string",
"description": "Unique identifier (UUID v4)."
},
"last_manual_trigger_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Unix timestamp (seconds) when the routine was last manually triggered, if ever.\n\nOnly manual triggers (`trigger_routine`) update this; scheduled cron firings run the built\ncommand directly and do not. Accepts the legacy `last_triggered_at` key on deserialize.",
"minimum": 0
},
"last_scheduled_trigger_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Unix timestamp (seconds) when the routine was last fired by its cron schedule, if ever.\n\nThe mirror of [`Routine::last_manual_trigger_at`] for scheduled runs: a manual trigger\nupdates only the manual field, a scheduled firing updates only this one. The host OS crontab\nline runs `moadim schedule trigger <id>`, and the launch command the daemon spawns appends\nthe Unix timestamp to the gitignored `scheduled.log` at fire time; the daemon reads the last\nline back on load. The daemon never writes this field directly (it is absent from\n`routine.toml` and the daemon-owned `state.local.toml`), so re-persisting a routine can't\nclobber the log.",
"minimum": 0
},
"machines": {
"type": "array",
"items": {
"type": "string"
},
"description": "Machines this routine runs on. Each daemon schedules a routine only when this list names its\nown machine identity ([`crate::machine::current_machine`]); an **empty list runs nowhere**, so\na routine is dormant until explicitly assigned. Lets one shared config repo drive different\nroutines on different machines."
},
"max_runtime_secs": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Maximum wall-clock seconds a single run may execute before the cleanup watchdog force-kills\nits (hung) tmux session, after which the workbench is reaped under the normal TTL rules.\n`None` uses `min(MAX_RUNTIME_SECS, cron interval)`; an explicit value can only lower that. A\nsession still within this bound is never touched. The cap and\n[`Routine::effective_max_runtime_secs`] live in the cleanup module. Must be greater than\nzero when set; `0` is rejected by `svc_create`/`svc_update` (#233).",
"minimum": 0
},
"model": {
"type": [
"string",
"null"
],
"description": "Model ID to run the agent with (e.g. `\"claude-sonnet-4-6\"`), passed as `--model` on the\nagent invocation. `None` uses the agent's own default."
},
"power_saving": {
"type": "boolean",
"description": "Whether scheduled and manual firing is paused to conserve resources, independent of\n[`Routine::enabled`].\n\n`enabled` is user-owned intent (\"I want this routine on/off\"); `power_saving` is a\nsystem/policy throttle layered on top — both must hold for a firing to launch an agent\n(`enabled && !power_saving`). Never mutated by `svc_create`/`svc_update` (set via\n[`crate::routines::svc_set_power_saving`] instead), so it survives a config edit the same\nway `snoozed_until` and `skip_runs` do. Daemon-owned runtime state: persisted in the\ngitignored `state.local.toml` sidecar, not the version-controlled `routine.toml`."
},
"prompt": {
"type": "string",
"description": "The task prompt handed to the agent.\n\nOmitted from serialized output when empty. A persisted routine always has a\nnon-blank prompt (enforced by `validate_prompt`), so this never affects\n`routine.toml` persistence; it lets list responses drop the prompt by blanking\nit in-memory (see [`RoutineListQuery::include_prompts`] / `svc_list`)."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Repository"
},
"description": "Repositories listed in the prompt as context."
},
"schedule": {
"type": "string",
"description": "Cron expression defining when the routine runs, evaluated in the host's local\nsystem timezone (the OS crontab timezone), not UTC."
},
"skip_runs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Number of upcoming scheduled fires still to skip, or `None`.\n\nDecremented (and cleared once it reaches zero) on each skipped scheduled fire; manual\ntriggers do not consume it. Mutually exclusive with `snoozed_until`.",
"minimum": 0
},
"snoozed_until": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Unix timestamp (seconds) until which scheduled (cron) fires are skipped, or `None`.\n\nCleared automatically the first time a scheduled fire observes `now >= snoozed_until`, which\nalso runs that fire. Manual triggers ([`crate::routines::svc_trigger`]) ignore this entirely.\nSet via the `snooze_routine` MCP tool; mutually exclusive with `skip_runs`.",
"minimum": 0
},
"source": {
"type": "string",
"description": "`\"managed\"` for routines owned by this server."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Free-form labels for grouping and filtering routines (e.g. `\"triage\"`, `\"nightly\"`).\nDefaults to empty; each entry is trimmed and must be non-blank."
},
"title": {
"type": "string",
"description": "Human name; slugified to name the workbench and tmux session."
},
"ttl_secs": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "How long (seconds) a finished run's workbench is retained before auto-cleanup removes it.\nCaps the cron-derived retention (`min(MAX_TTL_SECS, cron interval)`) lower; it can only\nshorten, never extend it. `None` uses the cron-derived value. Sessions still running are\nnever reaped. The cap and [`Routine::effective_ttl_secs`] live in the cleanup module. Must\nbe greater than zero when set; `0` is rejected by `svc_create`/`svc_update` (#233).",
"minimum": 0
},
"updated_at": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp (seconds) when the routine was last updated.",
"minimum": 0
}
}
},
"RoutineResponse": {
"allOf": [
{
"$ref": "#/components/schemas/Routine",
"description": "The underlying routine."
},
{
"type": "object",
"required": [
"agent_registered",
"agent_command_available",
"agent_setup_available",
"file_path",
"flag_count",
"is_running",
"env_keys"
],
"properties": {
"agent_command_available": {
"type": "boolean",
"description": "`true` if the agent config's `command` (e.g. `claude`, `codex`) resolves to an executable\non the daemon's `PATH`. Distinct from [`Self::agent_registered`]: a routine can have a\npresent, well-formed agent config yet reference a binary that isn't installed, in which\ncase the cron firing launches a tmux session that dies immediately with \"command not\nfound\" — a silent no-op indistinguishable from a healthy routine by `agent_registered`\nalone. `false` whenever the agent config is missing, unreadable, or malformed, since no\n`command` can be resolved in that case either."
},
"agent_registered": {
"type": "boolean",
"description": "`true` if an agent config exists at `~/.config/moadim/agents/<agent>.toml` *and* parses\nsuccessfully. A present-but-malformed config is silently dropped at crontab-sync time, so\nit reports `false` here too — file existence alone is not \"registered\"."
},
"agent_setup_available": {
"type": "boolean",
"description": "`true` if the agent config has no `setup` step, or that step's first whitespace-delimited\ntoken (the interpreter/binary it shells out to, e.g. `python3` for the built-in `claude`\nagent's workspace-trust seeding) resolves on the daemon's `PATH`. Distinct from\n[`Self::agent_command_available`]: the agent's own `command` can be installed while its\n`setup` step still shells out to something that isn't — in which case the launch command's\nfail-fast guard (`build_routine_command`) aborts the run before the agent ever starts, a\nfailure otherwise invisible to anything checking only `agent_command_available`. `false`\nhere means the run is expected to abort in `setup` rather than actually launch the agent.\n`false` whenever the agent config is missing, unreadable, or malformed too (mirrors\n`agent_command_available`'s pessimistic default) — `agent_registered` is the field that\ndistinguishes that case. See issue #404."
},
"env_keys": {
"type": "array",
"items": {
"type": "string"
},
"description": "Names (never values) of every environment variable set for this routine, merging the\ntracked `routine.toml` `[env]` table with the untracked `routine.local.toml` sidecar\n(secrets), deduplicated and sorted. Lets a client show *what* is configured without ever\nexposing a secret value over the API (issue #408)."
},
"file_path": {
"type": "string",
"description": "Absolute path to the routine's `routine.toml` file on disk."
},
"flag_count": {
"type": "integer",
"description": "Number of open flags raised against this routine (see [`super::flags`]). Surfaced here so\nlistings can badge it without a separate `list_flags` round-trip per routine.",
"minimum": 0
},
"is_running": {
"type": "boolean",
"description": "`true` if any fire of this routine currently has a live tmux session — i.e. an agent is\nrunning right now. Derived by probing for a session under the routine's\n`moadim-{slug}-` prefix (the same overlap-guard check `svc_trigger` uses, #514), not\npersisted. `false` whenever no `tmux` binary is available, mirroring the probe's existing\nbest-effort \"no tmux, nothing running\" stance. See issue #438."
},
"next_run_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Unix epoch seconds of this routine's next scheduled fire, in the host's local timezone\n(matching crontab semantics) — the future counterpart to `last_scheduled_trigger_at`.\n`None` when disabled, globally locked, or `schedule` is unparseable or has no upcoming\nfire (e.g. `@reboot`). See issue #369.",
"minimum": 0
},
"schedule_description": {
"type": [
"string",
"null"
],
"description": "Human-readable description of the schedule, including the timezone the\ncron expression is interpreted in, or `null` if it cannot be parsed."
},
"timezone": {
"type": [
"string",
"null"
],
"description": "IANA name of the local timezone the schedule is interpreted in (e.g.\n`\"Asia/Jerusalem\"`), or `null` if it cannot be determined. Cron\nexpressions are evaluated in this timezone, **not** UTC."
}
}
}
],
"description": "A [`Routine`] enriched with derived, non-persisted fields for API responses."
},
"RoutineSort": {
"type": "string",
"description": "Field to sort a routine listing by.",
"enum": [
"created",
"updated",
"title",
"repository"
]
},
"RunStatus": {
"type": "string",
"description": "Outcome of a single past run, derived from its workbench on disk.",
"enum": [
"running",
"success",
"failed",
"unknown"
]
},
"RunSummary": {
"type": "object",
"description": "One past (or in-progress) run of a routine, listed newest-first.",
"required": [
"workbench",
"started_at",
"started_at_local",
"status"
],
"properties": {
"exit_code": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Process exit code, when recorded."
},
"finished_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Unix seconds the run finished (`exit_code` file's mtime), `None` while running or unknown.",
"minimum": 0
},
"finished_at_local": {
"type": [
"string",
"null"
],
"description": "`finished_at` as a human-readable local timestamp, when finished."
},
"retention_expires_at": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Unix seconds this run's workbench is due to be reaped (`finished_at` +\n[`Routine::effective_ttl_secs`]). `None` while the run hasn't finished, or once its\nworkbench is already gone (a run restored from `runs.log` after TTL reaping).",
"minimum": 0
},
"started_at": {
"type": "integer",
"format": "int64",
"description": "Unix seconds the run was triggered.",
"minimum": 0
},
"started_at_local": {
"type": "string",
"description": "`started_at` as a human-readable local (daemon machine's timezone) timestamp."
},
"status": {
"$ref": "#/components/schemas/RunStatus",
"description": "Success/failure/running/unknown, derived from the exit-code file and tmux session liveness."
},
"workbench": {
"type": "string",
"description": "Workbench directory name (`{slug}-{unix_secs}`); pass to `GET /routines/{id}/runs/{workbench}/log`."
}
}
},
"SetMachineRequest": {
"type": "object",
"description": "Request body for `PUT /machine`.",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "New machine name. Trimmed; must be non-empty."
}
}
},
"SetMaxConcurrentRunsRequest": {
"type": "object",
"description": "Request body for `PUT /config/max-concurrent-runs`.",
"properties": {
"value": {
"type": [
"integer",
"null"
],
"description": "New override value, or `null`/omitted to clear it and fall back to the env var/default.",
"minimum": 0
}
}
},
"SetUserPromptRequest": {
"type": "object",
"description": "Request body for `PUT /config/user-prompt`.",
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"description": "New persistent prompt contents. An empty string clears it."
}
}
},
"ShutdownResponse": {
"type": "object",
"description": "Response body for `POST /shutdown`.",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"description": "Acknowledgement status (always `\"shutting down\"`)."
}
}
},
"SortOrder": {
"type": "string",
"description": "Sort direction for a routine listing.",
"enum": [
"asc",
"desc"
]
},
"UpdateRoutineRequest": {
"type": "object",
"description": "Request body for partially updating an existing routine.",
"properties": {
"agent": {
"type": [
"string",
"null"
],
"description": "New agent key, or `None` to keep the existing value."
},
"enabled": {
"type": [
"boolean",
"null"
],
"description": "New enabled state, or `None` to keep the existing value."
},
"env": {
"type": [
"object",
"null"
],
"description": "New tracked `[env]` map, or `None` to keep the existing value. Replaces the whole map (not\nmerged); send the full desired set. See [`CreateRoutineRequest::env`] for validation rules\nand the `routine.local.toml` secrets sidecar.",
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"type": "string"
}
},
"goal": {
"type": [
"string",
"null"
],
"description": "New goal, or `None` to keep the existing value. Send an empty string to clear it."
},
"machines": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "New machines targeting list, or `None` to keep the existing value."
},
"max_runtime_secs": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "New max runtime (seconds) for a single run, or `None` to keep the existing value. Must be\ngreater than zero when set; `0` is rejected (#233).",
"minimum": 0
},
"model": {
"type": [
"string",
"null"
],
"description": "New model ID, or `None` to keep the existing value. A blank/whitespace-only value clears\nthe model back to the agent's own default."
},
"prompt": {
"type": [
"string",
"null"
],
"description": "New prompt, or `None` to keep the existing value."
},
"repositories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/Repository"
},
"description": "New repositories list, or `None` to keep the existing value."
},
"schedule": {
"type": [
"string",
"null"
],
"description": "New cron expression, or `None` to keep the existing value. Evaluated in the\nhost's local system timezone (the OS crontab timezone), not UTC."
},
"tags": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "New tags list, or `None` to keep the existing value."
},
"title": {
"type": [
"string",
"null"
],
"description": "New title, or `None` to keep the existing value."
},
"ttl_secs": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "New workbench TTL (seconds), or `None` to keep the existing value. Must be\ngreater than zero when set; `0` is rejected (#233).",
"minimum": 0
}
}
}
}
}
}