aboutsummaryrefslogtreecommitdiff
path: root/docs/next/api/herdr-api.schema.json
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-07-20 00:54:05 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-07-20 00:55:36 +0300
commitd30ab1b54f6b6be95a0cb47ddc38da1d5e088700 (patch)
treeeb2002b408c856d9fcd7a573afe73b917f22cd97 /docs/next/api/herdr-api.schema.json
parent3f80947678a9723434aa7fddfe23750b5393e24c (diff)
feat: add plugin-driven agent views and startup hooks
Diffstat (limited to 'docs/next/api/herdr-api.schema.json')
-rw-r--r--docs/next/api/herdr-api.schema.json366
1 files changed, 366 insertions, 0 deletions
diff --git a/docs/next/api/herdr-api.schema.json b/docs/next/api/herdr-api.schema.json
index b066574f..dab07fb2 100644
--- a/docs/next/api/herdr-api.schema.json
+++ b/docs/next/api/herdr-api.schema.json
@@ -1354,6 +1354,283 @@
],
"type": "object"
},
+ "AgentViewBuiltinField": {
+ "enum": [
+ "status",
+ "workspace_id",
+ "tab_id",
+ "pane_id",
+ "agent",
+ "seen",
+ "state_change_seq"
+ ],
+ "type": "string"
+ },
+ "AgentViewBuiltinSortField": {
+ "enum": [
+ "workspace_order",
+ "tab_order",
+ "pane_order",
+ "attention",
+ "status",
+ "agent",
+ "seen",
+ "state_change_seq"
+ ],
+ "type": "string"
+ },
+ "AgentViewClearParams": {
+ "properties": {
+ "source": {
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "AgentViewContext": {
+ "enum": [
+ "current_workspace_id",
+ "current_tab_id"
+ ],
+ "type": "string"
+ },
+ "AgentViewField": {
+ "anyOf": [
+ {
+ "$ref": "#/schemas/request/$defs/AgentViewBuiltinField"
+ },
+ {
+ "properties": {
+ "token": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "token"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "AgentViewFilter": {
+ "oneOf": [
+ {
+ "properties": {
+ "filters": {
+ "items": {
+ "$ref": "#/schemas/request/$defs/AgentViewFilter"
+ },
+ "type": "array"
+ },
+ "op": {
+ "const": "all",
+ "type": "string"
+ }
+ },
+ "required": [
+ "op",
+ "filters"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "filters": {
+ "items": {
+ "$ref": "#/schemas/request/$defs/AgentViewFilter"
+ },
+ "type": "array"
+ },
+ "op": {
+ "const": "any",
+ "type": "string"
+ }
+ },
+ "required": [
+ "op",
+ "filters"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "filter": {
+ "$ref": "#/schemas/request/$defs/AgentViewFilter"
+ },
+ "op": {
+ "const": "not",
+ "type": "string"
+ }
+ },
+ "required": [
+ "op",
+ "filter"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "field": {
+ "$ref": "#/schemas/request/$defs/AgentViewField"
+ },
+ "op": {
+ "const": "eq",
+ "type": "string"
+ },
+ "value": {
+ "$ref": "#/schemas/request/$defs/AgentViewValue"
+ }
+ },
+ "required": [
+ "op",
+ "field",
+ "value"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "field": {
+ "$ref": "#/schemas/request/$defs/AgentViewField"
+ },
+ "op": {
+ "const": "in",
+ "type": "string"
+ },
+ "values": {
+ "items": {
+ "$ref": "#/schemas/request/$defs/AgentViewValue"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "op",
+ "field",
+ "values"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "field": {
+ "$ref": "#/schemas/request/$defs/AgentViewField"
+ },
+ "op": {
+ "const": "exists",
+ "type": "string"
+ }
+ },
+ "required": [
+ "op",
+ "field"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "AgentViewSetParams": {
+ "properties": {
+ "filter": {
+ "anyOf": [
+ {
+ "$ref": "#/schemas/request/$defs/AgentViewFilter"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "label": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort": {
+ "items": {
+ "$ref": "#/schemas/request/$defs/AgentViewSort"
+ },
+ "type": "array"
+ },
+ "source": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "source"
+ ],
+ "type": "object"
+ },
+ "AgentViewSort": {
+ "properties": {
+ "field": {
+ "$ref": "#/schemas/request/$defs/AgentViewSortField"
+ },
+ "order": {
+ "$ref": "#/schemas/request/$defs/AgentViewSortOrder",
+ "default": "asc"
+ }
+ },
+ "required": [
+ "field"
+ ],
+ "type": "object"
+ },
+ "AgentViewSortField": {
+ "anyOf": [
+ {
+ "$ref": "#/schemas/request/$defs/AgentViewBuiltinSortField"
+ },
+ {
+ "properties": {
+ "token": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "token"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "AgentViewSortOrder": {
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "type": "string"
+ },
+ "AgentViewValue": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "format": "uint64",
+ "minimum": 0,
+ "type": "integer"
+ },
+ {
+ "properties": {
+ "context": {
+ "$ref": "#/schemas/request/$defs/AgentViewContext"
+ }
+ },
+ "required": [
+ "context"
+ ],
+ "type": "object"
+ }
+ ]
+ },
"AgentWaitParams": {
"properties": {
"target": {
@@ -4601,6 +4878,38 @@
{
"properties": {
"method": {
+ "const": "agent.view.set",
+ "type": "string"
+ },
+ "params": {
+ "$ref": "#/schemas/request/$defs/AgentViewSetParams"
+ }
+ },
+ "required": [
+ "method",
+ "params"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "method": {
+ "const": "agent.view.clear",
+ "type": "string"
+ },
+ "params": {
+ "$ref": "#/schemas/request/$defs/AgentViewClearParams"
+ }
+ },
+ "required": [
+ "method",
+ "params"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "method": {
"const": "agent.focus",
"type": "string"
},
@@ -6632,6 +6941,12 @@
"kind": "local"
}
},
+ "startup": {
+ "items": {
+ "$ref": "#/schemas/success_response/$defs/PluginManifestStartup"
+ },
+ "type": "array"
+ },
"version": {
"type": "string"
},
@@ -7975,6 +8290,29 @@
],
"type": "object"
},
+ "PluginManifestStartup": {
+ "properties": {
+ "command": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "platforms": {
+ "items": {
+ "$ref": "#/schemas/success_response/$defs/PluginPlatform"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "command"
+ ],
+ "type": "object"
+ },
"PluginPaneInfo": {
"properties": {
"entrypoint": {
@@ -8451,6 +8789,34 @@
},
{
"properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "label": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "source": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "type": {
+ "const": "agent_view",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "active"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
"pane": {
"$ref": "#/schemas/success_response/$defs/PaneInfo"
},