aboutsummaryrefslogtreecommitdiff
path: root/docs/next/api
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-07-13 03:26:03 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-07-13 03:30:13 +0300
commit5cfe5e5e730246948b0c9428ad876b6938590aad (patch)
tree53d4bbe1aff6887f63f279eed1b5e4e11e7331b7 /docs/next/api
parent7f3364a468f7dcfd8c9c84e5737fe5699f0e3a93 (diff)
feat: add configurable sidebar metadata tokens
Diffstat (limited to 'docs/next/api')
-rw-r--r--docs/next/api/herdr-api.schema.json308
1 files changed, 255 insertions, 53 deletions
diff --git a/docs/next/api/herdr-api.schema.json b/docs/next/api/herdr-api.schema.json
index ef6a6fdb..a769d050 100644
--- a/docs/next/api/herdr-api.schema.json
+++ b/docs/next/api/herdr-api.schema.json
@@ -116,6 +116,22 @@
{
"properties": {
"type": {
+ "const": "workspace_metadata_updated",
+ "type": "string"
+ },
+ "workspace": {
+ "$ref": "#/schemas/event/$defs/WorkspaceInfo"
+ }
+ },
+ "required": [
+ "type",
+ "workspace"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "type": {
"const": "workspace_closed",
"type": "string"
},
@@ -433,6 +449,22 @@
},
{
"properties": {
+ "pane": {
+ "$ref": "#/schemas/event/$defs/PaneInfo"
+ },
+ "type": {
+ "const": "pane_updated",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "pane"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
"pane_id": {
"type": "string"
},
@@ -594,12 +626,6 @@
"agent_status": {
"$ref": "#/schemas/event/$defs/AgentStatus"
},
- "custom_status": {
- "type": [
- "string",
- "null"
- ]
- },
"display_agent": {
"type": [
"string",
@@ -659,6 +685,7 @@
"enum": [
"workspace_created",
"workspace_updated",
+ "workspace_metadata_updated",
"workspace_closed",
"workspace_renamed",
"workspace_moved",
@@ -673,6 +700,7 @@
"tab_focused",
"pane_created",
"pane_closed",
+ "pane_updated",
"pane_focused",
"pane_moved",
"pane_output_changed",
@@ -704,12 +732,6 @@
"agent_status": {
"$ref": "#/schemas/event/$defs/AgentStatus"
},
- "custom_status": {
- "type": [
- "string",
- "null"
- ]
- },
"cwd": {
"type": [
"string",
@@ -767,12 +789,34 @@
"terminal_id": {
"type": "string"
},
+ "terminal_title": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "terminal_title_stripped": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
"title": {
"type": [
"string",
"null"
]
},
+ "tokens": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "maxProperties": 32,
+ "propertyNames": {
+ "pattern": "^[A-Za-z0-9_-]{1,32}$"
+ },
+ "type": "object"
+ },
"workspace_id": {
"type": "string"
}
@@ -1007,6 +1051,16 @@
"minimum": 0,
"type": "integer"
},
+ "tokens": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "maxProperties": 32,
+ "propertyNames": {
+ "pattern": "^[A-Za-z0-9_-]{1,32}$"
+ },
+ "type": "object"
+ },
"workspace_id": {
"type": "string"
},
@@ -2267,12 +2321,6 @@
"null"
]
},
- "custom_status": {
- "type": [
- "string",
- "null"
- ]
- },
"message": {
"type": [
"string",
@@ -2364,10 +2412,6 @@
"null"
]
},
- "clear_custom_status": {
- "default": false,
- "type": "boolean"
- },
"clear_display_agent": {
"default": false,
"type": "boolean"
@@ -2380,12 +2424,6 @@
"default": false,
"type": "boolean"
},
- "custom_status": {
- "type": [
- "string",
- "null"
- ]
- },
"display_agent": {
"type": [
"string",
@@ -2418,9 +2456,23 @@
"null"
]
},
+ "tokens": {
+ "additionalProperties": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "maxProperties": 16,
+ "propertyNames": {
+ "pattern": "^[A-Za-z0-9_-]{1,32}$"
+ },
+ "type": "object"
+ },
"ttl_ms": {
"format": "uint64",
- "minimum": 0,
+ "maximum": 86400000,
+ "minimum": 1,
"type": [
"integer",
"null"
@@ -3114,6 +3166,18 @@
{
"properties": {
"type": {
+ "const": "workspace.metadata_updated",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "type": {
"const": "workspace.renamed",
"type": "string"
}
@@ -3282,6 +3346,18 @@
{
"properties": {
"type": {
+ "const": "pane.updated",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "type": {
"const": "pane.focused",
"type": "string"
}
@@ -3574,6 +3650,52 @@
],
"type": "object"
},
+ "WorkspaceReportMetadataParams": {
+ "properties": {
+ "seq": {
+ "format": "uint64",
+ "minimum": 0,
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "source": {
+ "type": "string"
+ },
+ "tokens": {
+ "additionalProperties": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "maxProperties": 16,
+ "propertyNames": {
+ "pattern": "^[A-Za-z0-9_-]{1,32}$"
+ },
+ "type": "object"
+ },
+ "ttl_ms": {
+ "format": "uint64",
+ "maximum": 86400000,
+ "minimum": 1,
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "workspace_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "workspace_id",
+ "source",
+ "tokens"
+ ],
+ "type": "object"
+ },
"WorkspaceTarget": {
"properties": {
"workspace_id": {
@@ -3990,6 +4112,22 @@
{
"properties": {
"method": {
+ "const": "workspace.report_metadata",
+ "type": "string"
+ },
+ "params": {
+ "$ref": "#/schemas/request/$defs/WorkspaceReportMetadataParams"
+ }
+ },
+ "required": [
+ "method",
+ "params"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "method": {
"const": "workspace.close",
"type": "string"
},
@@ -5046,12 +5184,6 @@
"agent_status": {
"$ref": "#/schemas/subscription_event/$defs/AgentStatus"
},
- "custom_status": {
- "type": [
- "string",
- "null"
- ]
- },
"display_agent": {
"type": [
"string",
@@ -5265,12 +5397,6 @@
"agent_status": {
"$ref": "#/schemas/success_response/$defs/AgentStatus"
},
- "custom_status": {
- "type": [
- "string",
- "null"
- ]
- },
"cwd": {
"type": [
"string",
@@ -5321,12 +5447,34 @@
"terminal_id": {
"type": "string"
},
+ "terminal_title": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "terminal_title_stripped": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
"title": {
"type": [
"string",
"null"
]
},
+ "tokens": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "maxProperties": 32,
+ "propertyNames": {
+ "pattern": "^[A-Za-z0-9_-]{1,32}$"
+ },
+ "type": "object"
+ },
"workspace_id": {
"type": "string"
}
@@ -5496,6 +5644,22 @@
{
"properties": {
"type": {
+ "const": "workspace_metadata_updated",
+ "type": "string"
+ },
+ "workspace": {
+ "$ref": "#/schemas/success_response/$defs/WorkspaceInfo"
+ }
+ },
+ "required": [
+ "type",
+ "workspace"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
+ "type": {
"const": "workspace_closed",
"type": "string"
},
@@ -5813,6 +5977,22 @@
},
{
"properties": {
+ "pane": {
+ "$ref": "#/schemas/success_response/$defs/PaneInfo"
+ },
+ "type": {
+ "const": "pane_updated",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "pane"
+ ],
+ "type": "object"
+ },
+ {
+ "properties": {
"pane_id": {
"type": "string"
},
@@ -5974,12 +6154,6 @@
"agent_status": {
"$ref": "#/schemas/success_response/$defs/AgentStatus"
},
- "custom_status": {
- "type": [
- "string",
- "null"
- ]
- },
"display_agent": {
"type": [
"string",
@@ -6054,6 +6228,7 @@
"enum": [
"workspace_created",
"workspace_updated",
+ "workspace_metadata_updated",
"workspace_closed",
"workspace_renamed",
"workspace_moved",
@@ -6068,6 +6243,7 @@
"tab_focused",
"pane_created",
"pane_closed",
+ "pane_updated",
"pane_focused",
"pane_moved",
"pane_output_changed",
@@ -6435,12 +6611,6 @@
"agent_status": {
"$ref": "#/schemas/success_response/$defs/AgentStatus"
},
- "custom_status": {
- "type": [
- "string",
- "null"
- ]
- },
"cwd": {
"type": [
"string",
@@ -6498,12 +6668,34 @@
"terminal_id": {
"type": "string"
},
+ "terminal_title": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "terminal_title_stripped": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
"title": {
"type": [
"string",
"null"
]
},
+ "tokens": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "maxProperties": 32,
+ "propertyNames": {
+ "pattern": "^[A-Za-z0-9_-]{1,32}$"
+ },
+ "type": "object"
+ },
"workspace_id": {
"type": "string"
}
@@ -8758,6 +8950,16 @@
"minimum": 0,
"type": "integer"
},
+ "tokens": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "maxProperties": 32,
+ "propertyNames": {
+ "pattern": "^[A-Za-z0-9_-]{1,32}$"
+ },
+ "type": "object"
+ },
"workspace_id": {
"type": "string"
},