@zocomputer/cli 0.0.0-stage → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +170 -2
- package/dist/argv.d.ts +15 -0
- package/dist/argv.js +83 -0
- package/dist/auth.d.ts +39 -0
- package/dist/auth.js +290 -0
- package/dist/catalog.d.ts +23 -0
- package/dist/catalog.js +193 -0
- package/dist/commands.d.ts +9 -0
- package/dist/commands.js +119 -0
- package/dist/context.d.ts +15 -0
- package/dist/context.js +30 -0
- package/dist/errors.d.ts +9 -0
- package/dist/errors.js +25 -0
- package/dist/flags.d.ts +27 -0
- package/dist/flags.js +211 -0
- package/dist/generated/commands.d.ts +23 -0
- package/dist/generated/commands.js +1751 -0
- package/dist/http.d.ts +11 -0
- package/dist/http.js +124 -0
- package/dist/login.d.ts +14 -0
- package/dist/login.js +102 -0
- package/dist/main.d.ts +15 -0
- package/dist/main.js +306 -0
- package/dist/output.d.ts +21 -0
- package/dist/output.js +221 -0
- package/dist/presentation.d.ts +9 -0
- package/dist/presentation.js +95 -0
- package/dist/profiles.d.ts +37 -0
- package/dist/profiles.js +123 -0
- package/dist/rpc.d.ts +26 -0
- package/dist/rpc.js +208 -0
- package/dist/session.d.ts +17 -0
- package/dist/session.js +48 -0
- package/dist/storage.d.ts +10 -0
- package/dist/storage.js +209 -0
- package/package.json +21 -4
|
@@ -0,0 +1,1751 @@
|
|
|
1
|
+
// Generated by scripts/generate-commands.mjs. Do not edit.
|
|
2
|
+
export const commandManifest = {
|
|
3
|
+
schemaDigest: "sha256:eaaf7ee560e0c39788aab1da5335e7717fc7244b9868589282dadfb6a9ea205d",
|
|
4
|
+
commands: [
|
|
5
|
+
{
|
|
6
|
+
action: "zo.activity.list",
|
|
7
|
+
path: ["activity", "list"],
|
|
8
|
+
versions: [
|
|
9
|
+
{
|
|
10
|
+
version: 1,
|
|
11
|
+
description: "List who did what in the workspace, newest first: task, connection, event, membership and other changes, each with its principal, subject, outcome and a one-line summary. You see a row when you did it, when its subject is visible to the workspace, or when you own its protected subject.",
|
|
12
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"ActivityListInput","type":"object"}',
|
|
13
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["occurred_at.desc"],"default":"occurred_at.desc"},"filter":{"additionalProperties":false,"properties":{"occurred_after":{"anyOf":[{"description":"An ISO 8601 timestamp with a time zone.","maxLength":40,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Only rows after this time.","title":"Occurred After"},"occurred_before":{"anyOf":[{"description":"An ISO 8601 timestamp with a time zone.","maxLength":40,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Only rows before this time.","title":"Occurred Before"},"principal":{"anyOf":[{"$ref":"#/$defs/EntityFilter"},{"type":"null"}],"default":null,"description":"Only what this principal did."},"principal_type":{"anyOf":[{"items":{"maxLength":64,"minLength":1,"pattern":"^[a-z][a-z0-9_]*$","type":"string"},"maxItems":8,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"Only rows done by any of these principal types, such as user, agent, function, workflow, service_account or workspace.","title":"Principal Type"},"subject":{"anyOf":[{"$ref":"#/$defs/EntityFilter"},{"type":"null"}],"default":null,"description":"Only what was done to this resource."},"action":{"anyOf":[{"items":{"maxLength":64,"minLength":1,"pattern":"^[a-z][a-z0-9_]*$","type":"string"},"maxItems":50,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"Only rows with any of these actions.","title":"Action"},"outcome":{"anyOf":[{"items":{"enum":["succeeded","failed","cancelled","unknown"],"type":"string"},"maxItems":4,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"Only rows with any of these outcomes.","title":"Outcome"},"search":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Only rows whose summary or principal\'s current name contains this text, ignoring case. Leading and trailing spaces are ignored.","title":"Search"}},"type":"object","required":[],"default":{}}},"required":[],"$defs":{"EntityFilter":{"additionalProperties":false,"properties":{"type":{"maxLength":64,"minLength":1,"pattern":"^[a-z][a-z0-9_]*$","title":"Type","type":"string"},"id":{"maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["type","id"],"title":"EntityFilter","type":"object"}}}',
|
|
14
|
+
resultKind: "inline",
|
|
15
|
+
},
|
|
16
|
+
],
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
action: "zo.agent.cancel",
|
|
20
|
+
path: ["agent", "cancel"],
|
|
21
|
+
versions: [
|
|
22
|
+
{
|
|
23
|
+
version: 1,
|
|
24
|
+
description: "Stop the work running in one session of an Agent and drop the messages waiting in it. The session stays usable.",
|
|
25
|
+
inputJson: '{"additionalProperties":false,"properties":{"agent_id":{"maxLength":200,"minLength":1,"title":"Agent Id","type":"string"},"session_id":{"maxLength":200,"minLength":1,"title":"Session Id","type":"string"}},"required":["agent_id","session_id"],"title":"AgentCancelInput","type":"object"}',
|
|
26
|
+
resultKind: "inline",
|
|
27
|
+
},
|
|
28
|
+
],
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
action: "zo.agent.create",
|
|
32
|
+
path: ["agent", "create"],
|
|
33
|
+
versions: [
|
|
34
|
+
{
|
|
35
|
+
version: 1,
|
|
36
|
+
description: "Create an Agent in a workspace. A zo.native Agent requires the workspace to be on Metronome billing.",
|
|
37
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"},"implementation":{"const":"zo.native","title":"Implementation","type":"string"},"configuration":{"$ref":"#/$defs/NativeConfiguration"}},"required":["workspace_id","display_name","implementation","configuration"],"title":"AgentCreateInput","type":"object","$defs":{"NativeConfiguration":{"additionalProperties":false,"description":"The ``zo.native`` configuration. Unknown fields are rejected.","properties":{"model":{"description":"Model identifier the runner calls.","maxLength":200,"minLength":1,"title":"Model","type":"string"},"system_prompt":{"anyOf":[{"maxLength":50000,"type":"string"},{"type":"null"}],"default":null,"description":"The Agent\'s instructions.","title":"System Prompt"},"instructions_file":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Knowledge file ID, such as an AGENTS.md, appended to the instructions each turn.","title":"Instructions File"},"skill_files":{"default":[],"description":"Knowledge file IDs of skills, each a Markdown file with Agent Skills frontmatter, indexed in the instructions.","items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":32,"title":"Skill Files","type":"array"}},"required":["model"],"title":"NativeConfiguration","type":"object"}}}',
|
|
38
|
+
resultKind: "inline",
|
|
39
|
+
},
|
|
40
|
+
],
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
action: "zo.agent.delete",
|
|
44
|
+
path: ["agent", "delete"],
|
|
45
|
+
versions: [
|
|
46
|
+
{
|
|
47
|
+
version: 1,
|
|
48
|
+
description: "Retire an Agent. It accepts no new work; its sessions and messages are kept.",
|
|
49
|
+
inputJson: '{"additionalProperties":false,"properties":{"agent_id":{"maxLength":200,"minLength":1,"title":"Agent Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["agent_id","expected_revision"],"title":"AgentDeleteInput","type":"object"}',
|
|
50
|
+
resultKind: "inline",
|
|
51
|
+
},
|
|
52
|
+
],
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
action: "zo.agent.get",
|
|
56
|
+
path: ["agent", "get"],
|
|
57
|
+
versions: [
|
|
58
|
+
{
|
|
59
|
+
version: 1,
|
|
60
|
+
description: "Read an Agent and its configuration.",
|
|
61
|
+
inputJson: '{"additionalProperties":false,"properties":{"agent_id":{"maxLength":200,"minLength":1,"title":"Agent Id","type":"string"}},"required":["agent_id"],"title":"AgentGetInput","type":"object"}',
|
|
62
|
+
resultKind: "inline",
|
|
63
|
+
},
|
|
64
|
+
],
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
action: "zo.agent.list",
|
|
68
|
+
path: ["agent", "list"],
|
|
69
|
+
versions: [
|
|
70
|
+
{
|
|
71
|
+
version: 1,
|
|
72
|
+
description: "List the Agents in a workspace that the caller can read.",
|
|
73
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"AgentListInput","type":"object"}',
|
|
74
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"}},"required":[]}',
|
|
75
|
+
resultKind: "inline",
|
|
76
|
+
},
|
|
77
|
+
],
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
action: "zo.agent.list_messages",
|
|
81
|
+
path: ["agent", "list-messages"],
|
|
82
|
+
versions: [
|
|
83
|
+
{
|
|
84
|
+
version: 1,
|
|
85
|
+
description: "List the messages an Agent sent or received, newest first, or those delivered to one of its sessions.",
|
|
86
|
+
inputJson: '{"additionalProperties":false,"properties":{"agent_id":{"maxLength":200,"minLength":1,"title":"Agent Id","type":"string"},"session_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages delivered to this session of the Agent; omit for all.","title":"Session Id"}},"required":["agent_id"],"title":"AgentListMessagesInput","type":"object"}',
|
|
87
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 100; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
88
|
+
resultKind: "inline",
|
|
89
|
+
},
|
|
90
|
+
],
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
action: "zo.agent.send",
|
|
94
|
+
path: ["agent", "send"],
|
|
95
|
+
versions: [
|
|
96
|
+
{
|
|
97
|
+
version: 1,
|
|
98
|
+
description: "Send an Agent a message, in a new session or one it already has. The result means the message is recorded, not that the Agent has read it; zo.message.get reports what happened to it.",
|
|
99
|
+
inputJson: '{"additionalProperties":false,"properties":{"agent_id":{"maxLength":200,"minLength":1,"title":"Agent Id","type":"string"},"content":{"items":{"discriminator":{"mapping":{"audio":"#/$defs/AudioBlock","image":"#/$defs/ImageBlock","resource":"#/$defs/ResourceBlock","resource_link":"#/$defs/ResourceLinkBlock","text":"#/$defs/TextBlock"},"propertyName":"type"},"oneOf":[{"$ref":"#/$defs/TextBlock"},{"$ref":"#/$defs/ImageBlock"},{"$ref":"#/$defs/AudioBlock"},{"$ref":"#/$defs/ResourceBlock"},{"$ref":"#/$defs/ResourceLinkBlock"}]},"maxItems":64,"minItems":1,"title":"Content","type":"array"},"session_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Continue this session; omit to start a new one.","title":"Session Id"},"priority":{"default":"queue","description":"How the message affects work already running in the session: wait behind it, join it, or stop it.","enum":["queue","steer","interrupt"],"title":"Priority","type":"string"}},"required":["agent_id","content"],"title":"AgentSendInput","type":"object","$defs":{"AudioBlock":{"additionalProperties":false,"properties":{"type":{"const":"audio","title":"Type","type":"string"},"data":{"maxLength":1048576,"minLength":1,"title":"Data","type":"string"},"mimeType":{"maxLength":255,"minLength":1,"title":"Mimetype","type":"string"}},"required":["type","data","mimeType"],"title":"AudioBlock","type":"object"},"EmbeddedResource":{"additionalProperties":false,"description":"ACP\'s text or blob resource contents: exactly one of ``text`` and ``blob``.","properties":{"uri":{"maxLength":2048,"minLength":1,"title":"Uri","type":"string"},"mimeType":{"anyOf":[{"maxLength":255,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Mimetype"},"text":{"anyOf":[{"maxLength":100000,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Text"},"blob":{"anyOf":[{"maxLength":1048576,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Blob"}},"required":["uri"],"title":"EmbeddedResource","type":"object"},"ImageBlock":{"additionalProperties":false,"properties":{"type":{"const":"image","title":"Type","type":"string"},"data":{"maxLength":1048576,"minLength":1,"title":"Data","type":"string"},"mimeType":{"maxLength":255,"minLength":1,"title":"Mimetype","type":"string"}},"required":["type","data","mimeType"],"title":"ImageBlock","type":"object"},"ResourceBlock":{"additionalProperties":false,"properties":{"type":{"const":"resource","title":"Type","type":"string"},"resource":{"$ref":"#/$defs/EmbeddedResource"}},"required":["type","resource"],"title":"ResourceBlock","type":"object"},"ResourceLinkBlock":{"additionalProperties":false,"description":"On input, ``uri`` names an upload (``zo-upload://``). On output, a presigned URL for stored media.","properties":{"type":{"const":"resource_link","title":"Type","type":"string"},"uri":{"maxLength":2048,"minLength":1,"title":"Uri","type":"string"},"name":{"maxLength":255,"minLength":1,"title":"Name","type":"string"},"mimeType":{"anyOf":[{"maxLength":255,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Mimetype"},"size":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"title":"Size"}},"required":["type","uri","name"],"title":"ResourceLinkBlock","type":"object"},"TextBlock":{"additionalProperties":false,"properties":{"type":{"const":"text","title":"Type","type":"string"},"text":{"maxLength":100000,"minLength":1,"title":"Text","type":"string"}},"required":["type","text"],"title":"TextBlock","type":"object"}}}',
|
|
100
|
+
resultKind: "inline",
|
|
101
|
+
},
|
|
102
|
+
],
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
action: "zo.agent.update",
|
|
106
|
+
path: ["agent", "update"],
|
|
107
|
+
versions: [
|
|
108
|
+
{
|
|
109
|
+
version: 1,
|
|
110
|
+
description: "Rename an Agent or replace its configuration. Changes apply from each session's next turn.",
|
|
111
|
+
inputJson: '{"additionalProperties":false,"description":"Omitted fields keep their value; ``configuration`` replaces the whole configuration.","properties":{"agent_id":{"maxLength":200,"minLength":1,"title":"Agent Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"anyOf":[{"maxLength":120,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Display Name"},"configuration":{"anyOf":[{"$ref":"#/$defs/NativeConfiguration"},{"type":"null"}],"default":null}},"required":["agent_id","expected_revision"],"title":"AgentUpdateInput","type":"object","$defs":{"NativeConfiguration":{"additionalProperties":false,"description":"The ``zo.native`` configuration. Unknown fields are rejected.","properties":{"model":{"description":"Model identifier the runner calls.","maxLength":200,"minLength":1,"title":"Model","type":"string"},"system_prompt":{"anyOf":[{"maxLength":50000,"type":"string"},{"type":"null"}],"default":null,"description":"The Agent\'s instructions.","title":"System Prompt"},"instructions_file":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Knowledge file ID, such as an AGENTS.md, appended to the instructions each turn.","title":"Instructions File"},"skill_files":{"default":[],"description":"Knowledge file IDs of skills, each a Markdown file with Agent Skills frontmatter, indexed in the instructions.","items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":32,"title":"Skill Files","type":"array"}},"required":["model"],"title":"NativeConfiguration","type":"object"}}}',
|
|
112
|
+
resultKind: "inline",
|
|
113
|
+
},
|
|
114
|
+
],
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
action: "zo.agent_session.get",
|
|
118
|
+
path: ["agent-session", "get"],
|
|
119
|
+
versions: [
|
|
120
|
+
{
|
|
121
|
+
version: 1,
|
|
122
|
+
description: "Read a session and the Agent it belongs to.",
|
|
123
|
+
inputJson: '{"additionalProperties":false,"properties":{"session_id":{"maxLength":200,"minLength":1,"title":"Session Id","type":"string"}},"required":["session_id"],"title":"AgentSessionGetInput","type":"object"}',
|
|
124
|
+
resultKind: "inline",
|
|
125
|
+
},
|
|
126
|
+
],
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
action: "zo.agent_session.history",
|
|
130
|
+
path: ["agent-session", "history"],
|
|
131
|
+
versions: [
|
|
132
|
+
{
|
|
133
|
+
version: 1,
|
|
134
|
+
description: "Read a session's history: its inputs, the Agent's responses and tool results, newest first, as ACP updates.",
|
|
135
|
+
inputJson: '{"additionalProperties":false,"properties":{"session_id":{"maxLength":200,"minLength":1,"title":"Session Id","type":"string"}},"required":["session_id"],"title":"AgentSessionHistoryInput","type":"object"}',
|
|
136
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 100; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
137
|
+
resultKind: "inline",
|
|
138
|
+
},
|
|
139
|
+
],
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
action: "zo.agent_session.list",
|
|
143
|
+
path: ["agent-session", "list"],
|
|
144
|
+
versions: [
|
|
145
|
+
{
|
|
146
|
+
version: 1,
|
|
147
|
+
description: "List an Agent's sessions that the caller can read.",
|
|
148
|
+
inputJson: '{"additionalProperties":false,"properties":{"agent_id":{"maxLength":200,"minLength":1,"title":"Agent Id","type":"string"}},"required":["agent_id"],"title":"AgentSessionListInput","type":"object"}',
|
|
149
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc","last_activity_at.desc"],"default":"id.asc"}},"required":[]}',
|
|
150
|
+
resultKind: "inline",
|
|
151
|
+
},
|
|
152
|
+
],
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
action: "zo.agent_session.list_workspace",
|
|
156
|
+
path: ["agent-session", "list-workspace"],
|
|
157
|
+
versions: [
|
|
158
|
+
{
|
|
159
|
+
version: 1,
|
|
160
|
+
description: "List the sessions in a workspace that the caller can read, across Agents.",
|
|
161
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"AgentSessionWorkspaceListInput","type":"object"}',
|
|
162
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc","last_activity_at.desc"],"default":"id.asc"},"filter":{"additionalProperties":false,"properties":{"agent_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Only this Agent\'s sessions.","title":"Agent Id"}},"type":"object","required":[],"default":{}}},"required":[]}',
|
|
163
|
+
resultKind: "inline",
|
|
164
|
+
},
|
|
165
|
+
],
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
action: "zo.connection.authorize",
|
|
169
|
+
path: ["connection", "authorize"],
|
|
170
|
+
versions: [
|
|
171
|
+
{
|
|
172
|
+
version: 1,
|
|
173
|
+
description: "Authorize a credential slot: an OAuth slot returns the provider consent URL; a key slot stores the key.",
|
|
174
|
+
inputJson: '{"additionalProperties":false,"properties":{"connection_id":{"maxLength":200,"minLength":1,"title":"Connection Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"slot":{"maxLength":200,"minLength":1,"title":"Slot","type":"string"},"credential":{"discriminator":{"mapping":{"key":"#/$defs/KeyCredential","oauth":"#/$defs/OAuthCredential"},"propertyName":"kind"},"oneOf":[{"$ref":"#/$defs/OAuthCredential"},{"$ref":"#/$defs/KeyCredential"}],"title":"Credential"}},"required":["connection_id","expected_revision","slot","credential"],"title":"ConnectionAuthorizeInput","type":"object","$defs":{"KeyCredential":{"additionalProperties":false,"properties":{"kind":{"const":"key","title":"Kind","type":"string"},"credentials":{"additionalProperties":{"x-zo-json-value":true},"description":"Secret: credential fields matching the slot\'s schema. Stored sealed and never returned.","title":"Credentials","type":"object"},"external_account_id":{"maxLength":200,"minLength":1,"title":"External Account Id","type":"string"},"display_metadata":{"additionalProperties":{"x-zo-json-value":true},"default":{},"title":"Display Metadata","type":"object"}},"required":["kind","credentials","external_account_id"],"title":"KeyCredential","type":"object"},"OAuthCredential":{"additionalProperties":false,"properties":{"kind":{"const":"oauth","title":"Kind","type":"string"},"oauth_app_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"The OAuth app to consent through. A connection to a public definition uses the app its publisher registered for the provider: omit this, or pass that app\'s id. A private definition\'s connection must name an app registered in the connection\'s workspace.","title":"Oauth App Id"},"redirect_uri":{"description":"Where the browser returns after consent.","maxLength":2048,"minLength":1,"title":"Redirect Uri","type":"string"}},"required":["kind","redirect_uri"],"title":"OAuthCredential","type":"object"}}}',
|
|
175
|
+
resultKind: "inline",
|
|
176
|
+
},
|
|
177
|
+
],
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
action: "zo.connection.create",
|
|
181
|
+
path: ["connection", "create"],
|
|
182
|
+
versions: [
|
|
183
|
+
{
|
|
184
|
+
version: 1,
|
|
185
|
+
description: "Create a connection from a published definition. A protected connection is reachable only by its owner and the principals they grant.",
|
|
186
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"definition_id":{"maxLength":200,"minLength":1,"title":"Definition Id","type":"string"},"definition_version":{"exclusiveMinimum":0,"maximum":2147483647,"title":"Definition Version","type":"integer"},"display_name":{"maxLength":256,"minLength":1,"title":"Display Name","type":"string"},"configuration":{"additionalProperties":{"x-zo-json-value":true},"title":"Configuration","type":"object"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","definition_id","definition_version","display_name","configuration"],"title":"ConnectionCreateInput","type":"object"}',
|
|
187
|
+
resultKind: "inline",
|
|
188
|
+
},
|
|
189
|
+
],
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
action: "zo.connection.delete",
|
|
193
|
+
path: ["connection", "delete"],
|
|
194
|
+
versions: [
|
|
195
|
+
{
|
|
196
|
+
version: 1,
|
|
197
|
+
description: "Delete a connection and its stored credentials.",
|
|
198
|
+
inputJson: '{"additionalProperties":false,"properties":{"connection_id":{"maxLength":200,"minLength":1,"title":"Connection Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["connection_id","expected_revision"],"title":"ConnectionTargetInput","type":"object"}',
|
|
199
|
+
resultKind: "inline",
|
|
200
|
+
},
|
|
201
|
+
],
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
action: "zo.connection.disconnect",
|
|
205
|
+
path: ["connection", "disconnect"],
|
|
206
|
+
versions: [
|
|
207
|
+
{
|
|
208
|
+
version: 1,
|
|
209
|
+
description: "Remove the connection's stored credentials; the provider grant is revoked afterwards.",
|
|
210
|
+
inputJson: '{"additionalProperties":false,"properties":{"connection_id":{"maxLength":200,"minLength":1,"title":"Connection Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["connection_id","expected_revision"],"title":"ConnectionTargetInput","type":"object"}',
|
|
211
|
+
resultKind: "inline",
|
|
212
|
+
},
|
|
213
|
+
],
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
action: "zo.connection.get",
|
|
217
|
+
path: ["connection", "get"],
|
|
218
|
+
versions: [
|
|
219
|
+
{
|
|
220
|
+
version: 1,
|
|
221
|
+
description: "Read a connection.",
|
|
222
|
+
inputJson: '{"additionalProperties":false,"properties":{"connection_id":{"maxLength":200,"minLength":1,"title":"Connection Id","type":"string"}},"required":["connection_id"],"title":"ConnectionGetInput","type":"object"}',
|
|
223
|
+
resultKind: "inline",
|
|
224
|
+
},
|
|
225
|
+
],
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
action: "zo.connection.list",
|
|
229
|
+
path: ["connection", "list"],
|
|
230
|
+
versions: [
|
|
231
|
+
{
|
|
232
|
+
version: 1,
|
|
233
|
+
description: "List the connections the caller can read in a workspace.",
|
|
234
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"ConnectionListInput","type":"object"}',
|
|
235
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 100; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"}},"required":[]}',
|
|
236
|
+
resultKind: "inline",
|
|
237
|
+
},
|
|
238
|
+
],
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
action: "zo.connection.register_resource",
|
|
242
|
+
path: ["connection", "register-resource"],
|
|
243
|
+
versions: [
|
|
244
|
+
{
|
|
245
|
+
version: 1,
|
|
246
|
+
description: "Register a provider object, such as a Slack channel, as a resource of the connection.",
|
|
247
|
+
inputJson: '{"additionalProperties":false,"properties":{"connection_id":{"maxLength":200,"minLength":1,"title":"Connection Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"type":{"maxLength":200,"minLength":1,"title":"Type","type":"string"},"type_version":{"exclusiveMinimum":0,"maximum":2147483647,"title":"Type Version","type":"integer"},"source_id":{"maxLength":200,"minLength":1,"title":"Source Id","type":"string"},"display_name":{"maxLength":256,"minLength":1,"title":"Display Name","type":"string"},"properties":{"type":"object","additionalProperties":{"x-zo-json-value":true},"title":"Properties"}},"required":["connection_id","expected_revision","type","type_version","source_id","display_name","properties"],"title":"RegisterResourceInput","type":"object"}',
|
|
248
|
+
resultKind: "inline",
|
|
249
|
+
},
|
|
250
|
+
],
|
|
251
|
+
},
|
|
252
|
+
{
|
|
253
|
+
action: "zo.connection.slack.complete_authorization",
|
|
254
|
+
path: ["connection", "slack", "complete-authorization"],
|
|
255
|
+
versions: [
|
|
256
|
+
{
|
|
257
|
+
version: 1,
|
|
258
|
+
description: "Exchange a Slack challenge code and store its service token. Attempts are single-use and expire after ten minutes.",
|
|
259
|
+
inputJson: '{"additionalProperties":false,"properties":{"connection_id":{"maxLength":200,"minLength":1,"title":"Connection Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"attempt_id":{"maxLength":200,"minLength":1,"title":"Attempt Id","type":"string"},"code":{"maxLength":256,"minLength":1,"title":"Code","type":"string"}},"required":["connection_id","expected_revision","attempt_id","code"],"title":"SlackAuthorizationCompleteInput","type":"object"}',
|
|
260
|
+
resultKind: "inline",
|
|
261
|
+
},
|
|
262
|
+
],
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
action: "zo.connection.slack.start_authorization",
|
|
266
|
+
path: ["connection", "slack", "start-authorization"],
|
|
267
|
+
versions: [
|
|
268
|
+
{
|
|
269
|
+
version: 1,
|
|
270
|
+
description: "Get a Slack service-token authorization command. Requires a workspace owner and a Slack service-token connection.",
|
|
271
|
+
inputJson: '{"additionalProperties":false,"properties":{"connection_id":{"maxLength":200,"minLength":1,"title":"Connection Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["connection_id","expected_revision"],"title":"ConnectionTargetInput","type":"object"}',
|
|
272
|
+
resultKind: "inline",
|
|
273
|
+
},
|
|
274
|
+
],
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
action: "zo.connection.update",
|
|
278
|
+
path: ["connection", "update"],
|
|
279
|
+
versions: [
|
|
280
|
+
{
|
|
281
|
+
version: 1,
|
|
282
|
+
description: "Replace a connection's configuration, rename it, or both; a field left out keeps its current value.",
|
|
283
|
+
inputJson: '{"additionalProperties":false,"properties":{"connection_id":{"maxLength":200,"minLength":1,"title":"Connection Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"configuration":{"anyOf":[{"additionalProperties":{"x-zo-json-value":true},"type":"object"},{"type":"null"}],"default":null,"description":"The configuration that replaces the stored one; omit it to keep the stored configuration, which reads never return.","title":"Configuration"},"display_name":{"anyOf":[{"maxLength":256,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"A new name for the connection; omit it to keep the current name.","title":"Display Name"}},"required":["connection_id","expected_revision"],"title":"ConnectionUpdateInput","type":"object"}',
|
|
284
|
+
resultKind: "inline",
|
|
285
|
+
},
|
|
286
|
+
],
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
action: "zo.connection_definition.list",
|
|
290
|
+
path: ["connection-definition", "list"],
|
|
291
|
+
versions: [
|
|
292
|
+
{
|
|
293
|
+
version: 1,
|
|
294
|
+
description: "List the connection definitions a workspace can create connections from: public ones and its own, at their latest version, or one definition at a given version.",
|
|
295
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"DefinitionListInput","type":"object"}',
|
|
296
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 100; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"filter":{"additionalProperties":false,"properties":{"definition_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Only this definition: one row, or none when the workspace can\'t use it.","title":"Definition Id"},"version":{"anyOf":[{"exclusiveMinimum":0,"maximum":2147483647,"type":"integer"},{"type":"null"}],"default":null,"description":"With `definition_id`, that published version instead of the latest: the one an existing connection is pinned to and authorizes against.","title":"Version"}},"type":"object","required":[],"default":{}}},"required":[]}',
|
|
297
|
+
resultKind: "inline",
|
|
298
|
+
},
|
|
299
|
+
],
|
|
300
|
+
},
|
|
301
|
+
{
|
|
302
|
+
action: "zo.connection_definition.publish",
|
|
303
|
+
path: ["connection-definition", "publish"],
|
|
304
|
+
versions: [
|
|
305
|
+
{
|
|
306
|
+
version: 1,
|
|
307
|
+
description: "Publish a connection definition package into the workspace's own namespace.",
|
|
308
|
+
inputJson: '{"additionalProperties":false,"description":"A definition package as data: the manifest plus the documents it names.","properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"manifest":{"maxLength":131072,"title":"Manifest","type":"string"},"documents":{"items":{"$ref":"#/$defs/DefinitionDocument"},"maxItems":64,"title":"Documents","type":"array"}},"required":["workspace_id","manifest","documents"],"title":"DefinitionPublishInput","type":"object","$defs":{"DefinitionDocument":{"additionalProperties":false,"properties":{"name":{"maxLength":256,"minLength":1,"title":"Name","type":"string"},"body":{"maxLength":131072,"title":"Body","type":"string"}},"required":["name","body"],"title":"DefinitionDocument","type":"object"}}}',
|
|
309
|
+
resultKind: "inline",
|
|
310
|
+
},
|
|
311
|
+
],
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
action: "zo.database.create",
|
|
315
|
+
path: ["database", "create"],
|
|
316
|
+
versions: [
|
|
317
|
+
{
|
|
318
|
+
version: 1,
|
|
319
|
+
description: "Create a managed Postgres database and return it, usually already `available`. The required `idempotency_key` is ignored until central deduplication lands: a retried create can make a second database, so after an uncertain response (lost or timed out), list the workspace's databases before creating again.",
|
|
320
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"idempotency_key":{"description":"Required but ignored: a retried create can make a second database.","maxLength":255,"minLength":1,"pattern":"^[!-~]{1,255}$","title":"Idempotency Key","type":"string"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"description":{"default":"","description":"What the database holds. Members and their agents choose a database from `zo.database.list` by it.","maxLength":2000,"title":"Description","type":"string"},"engine":{"const":"postgres","default":"postgres","title":"Engine","type":"string"},"postgres":{"additionalProperties":false,"default":{},"properties":{"major_version":{"default":18,"description":"One of the offered major versions. Fixed for the life of the database.","maximum":2147483647,"minimum":1,"title":"Major Version","type":"integer"},"compute":{"additionalProperties":false,"default":{},"properties":{"min_memory_mib":{"default":1024,"description":"The autoscaling floor while the compute is awake, one of the shapes `zo.database.list_configurations` offers. Equal to `max_memory_mib`, it fixes the size. Above 4,096, set `max_memory_mib` too.","maximum":2147483647,"minimum":1,"title":"Min Memory Mib","type":"integer"},"max_memory_mib":{"default":4096,"description":"The autoscaling ceiling, from the same shapes and at least `min_memory_mib`. CPU scales with memory.","maximum":2147483647,"minimum":1,"title":"Max Memory Mib","type":"integer"},"scale_to_zero":{"default":true,"description":"Whether the compute suspends when idle. `false` keeps it running at its minimum or above around the clock, and is billed for it, on plans whose offer includes `false`.","title":"Scale To Zero","type":"boolean"},"idle_timeout_seconds":{"default":300,"description":"Seconds without a call before the compute scales to zero, within the offered bounds. No effect while `scale_to_zero` is `false`.","maximum":2147483647,"minimum":1,"title":"Idle Timeout Seconds","type":"integer"}},"title":"DatabaseComputeInput","type":"object","required":[]}},"title":"DatabasePostgresInput","type":"object","required":[]},"region":{"default":"us","description":"One of the offered regions. Fixed at creation.","pattern":"^[a-z0-9][a-z0-9-]{0,31}$","title":"Region","type":"string"},"visibility":{"default":"workspace","description":"`workspace` (default): every member can see it and use it as their role allows. `protected`: only you, and whoever you share it with; workspace-wide grants don\'t reach it. Fixed at creation.","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","idempotency_key","display_name"],"title":"DatabaseCreateInput","type":"object"}',
|
|
321
|
+
resultKind: "inline",
|
|
322
|
+
},
|
|
323
|
+
],
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
action: "zo.database.delete",
|
|
327
|
+
path: ["database", "delete"],
|
|
328
|
+
versions: [
|
|
329
|
+
{
|
|
330
|
+
version: 1,
|
|
331
|
+
description: "Delete a database and all its data, and return it `deleting`. Final: there is no restore. Safe to repeat; once it is gone, the answer is `resource_not_found`.",
|
|
332
|
+
inputJson: '{"additionalProperties":false,"properties":{"database_id":{"maxLength":200,"minLength":1,"title":"Database Id","type":"string"},"expected_revision":{"description":"Checked on the first delete. A repeated delete of a database already `deleting` returns it whatever revision it sends.","exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["database_id","expected_revision"],"title":"DatabaseDeleteInput","type":"object"}',
|
|
333
|
+
resultKind: "inline",
|
|
334
|
+
},
|
|
335
|
+
],
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
action: "zo.database.describe",
|
|
339
|
+
path: ["database", "describe"],
|
|
340
|
+
versions: [
|
|
341
|
+
{
|
|
342
|
+
version: 1,
|
|
343
|
+
description: "Read a database's schemas, tables and views with their columns, keys, indexes and comments, and its installed extensions. Call it before writing SQL against a database you did not build.",
|
|
344
|
+
inputJson: '{"additionalProperties":false,"properties":{"database_id":{"maxLength":200,"minLength":1,"title":"Database Id","type":"string"},"schema":{"anyOf":[{"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Describe only this schema.","title":"Schema"},"table":{"anyOf":[{"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"Describe only tables and views with this name.","title":"Table"}},"required":["database_id"],"title":"DatabaseDescribeInput","type":"object"}',
|
|
345
|
+
resultKind: "inline",
|
|
346
|
+
},
|
|
347
|
+
],
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
action: "zo.database.execute",
|
|
351
|
+
path: ["database", "execute"],
|
|
352
|
+
versions: [
|
|
353
|
+
{
|
|
354
|
+
version: 1,
|
|
355
|
+
description: "Run 1 to 100 SQL statements that read and write rows, in one transaction, and return each one's result. A statement Postgres refuses still succeeds: check `error` before `results`.",
|
|
356
|
+
inputJson: '{"additionalProperties":false,"properties":{"database_id":{"maxLength":200,"minLength":1,"title":"Database Id","type":"string"},"statements":{"description":"Run in order, in one transaction: all commit or none do.","items":{"$ref":"#/$defs/DatabaseStatement"},"maxItems":100,"minItems":1,"title":"Statements","type":"array"},"max_rows":{"default":200,"description":"Rows to return per statement, at most 4,000. The result bounds (1 MiB and 10,000 JSON values) may stop sooner; `truncated` says when either did.","maximum":4000,"minimum":1,"title":"Max Rows","type":"integer"}},"required":["database_id","statements"],"title":"DatabaseExecuteInput","type":"object","$defs":{"DatabaseStatement":{"additionalProperties":false,"properties":{"sql":{"description":"Exactly one statement. A statement that starts or ends a transaction is refused.","minLength":1,"title":"Sql","type":"string"},"params":{"default":[],"description":"Values for `$1` to `$n`: strings, numbers, booleans, `null`, or arrays of them. Postgres infers each type from where it appears. Pass JSON as a string with `$1::jsonb` and binary as a `\\\\x` hex string with `$1::bytea`. Objects are refused.","items":{"x-zo-json-value":true},"title":"Params","type":"array"}},"required":["sql"],"title":"DatabaseStatement","type":"object"}}}',
|
|
357
|
+
resultKind: "inline",
|
|
358
|
+
},
|
|
359
|
+
],
|
|
360
|
+
},
|
|
361
|
+
{
|
|
362
|
+
action: "zo.database.get",
|
|
363
|
+
path: ["database", "get"],
|
|
364
|
+
versions: [
|
|
365
|
+
{
|
|
366
|
+
version: 1,
|
|
367
|
+
description: "Read a database: its Postgres settings, state and last measured storage.",
|
|
368
|
+
inputJson: '{"additionalProperties":false,"properties":{"database_id":{"maxLength":200,"minLength":1,"title":"Database Id","type":"string"}},"required":["database_id"],"title":"DatabaseGetInput","type":"object"}',
|
|
369
|
+
resultKind: "inline",
|
|
370
|
+
},
|
|
371
|
+
],
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
action: "zo.database.list",
|
|
375
|
+
path: ["database", "list"],
|
|
376
|
+
versions: [
|
|
377
|
+
{
|
|
378
|
+
version: 1,
|
|
379
|
+
description: "List the databases the caller can see in a workspace.",
|
|
380
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"DatabaseListInput","type":"object"}',
|
|
381
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"}},"required":[]}',
|
|
382
|
+
resultKind: "inline",
|
|
383
|
+
},
|
|
384
|
+
],
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
action: "zo.database.list_configurations",
|
|
388
|
+
path: ["database", "list-configurations"],
|
|
389
|
+
versions: [
|
|
390
|
+
{
|
|
391
|
+
version: 1,
|
|
392
|
+
description: "List the regions, Postgres versions, compute shapes and idle timeouts a workspace's databases may use.",
|
|
393
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"DatabaseListConfigurationsInput","type":"object"}',
|
|
394
|
+
resultKind: "inline",
|
|
395
|
+
},
|
|
396
|
+
],
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
action: "zo.database.migrate",
|
|
400
|
+
path: ["database", "migrate"],
|
|
401
|
+
versions: [
|
|
402
|
+
{
|
|
403
|
+
version: 1,
|
|
404
|
+
description: "Run 1 to 1,000 SQL statements that change a database's schema, in one transaction, and return each one's result. A statement Postgres refuses still succeeds: check `error` before `results`.",
|
|
405
|
+
inputJson: '{"additionalProperties":false,"properties":{"database_id":{"maxLength":200,"minLength":1,"title":"Database Id","type":"string"},"statements":{"description":"Run in order, in one transaction: all commit or none do.","items":{"$ref":"#/$defs/DatabaseStatement"},"maxItems":1000,"minItems":1,"title":"Statements","type":"array"},"transaction":{"default":true,"description":"`false` runs exactly one statement outside a transaction, for statements Postgres refuses inside one (`create index concurrently`). Its result has `command` and `rows_affected` only.","title":"Transaction","type":"boolean"},"max_rows":{"default":200,"description":"Rows to return per statement, at most 4,000. The result bounds (1 MiB and 10,000 JSON values) may stop sooner; `truncated` says when either did.","maximum":4000,"minimum":1,"title":"Max Rows","type":"integer"}},"required":["database_id","statements"],"title":"DatabaseMigrateInput","type":"object","$defs":{"DatabaseStatement":{"additionalProperties":false,"properties":{"sql":{"description":"Exactly one statement. A statement that starts or ends a transaction is refused.","minLength":1,"title":"Sql","type":"string"},"params":{"default":[],"description":"Values for `$1` to `$n`: strings, numbers, booleans, `null`, or arrays of them. Postgres infers each type from where it appears. Pass JSON as a string with `$1::jsonb` and binary as a `\\\\x` hex string with `$1::bytea`. Objects are refused.","items":{"x-zo-json-value":true},"title":"Params","type":"array"}},"required":["sql"],"title":"DatabaseStatement","type":"object"}}}',
|
|
406
|
+
resultKind: "inline",
|
|
407
|
+
},
|
|
408
|
+
],
|
|
409
|
+
},
|
|
410
|
+
{
|
|
411
|
+
action: "zo.database.query",
|
|
412
|
+
path: ["database", "query"],
|
|
413
|
+
versions: [
|
|
414
|
+
{
|
|
415
|
+
version: 1,
|
|
416
|
+
description: "Run one read-only SQL statement and return its rows. Call `zo.database.describe` first, and add `limit` rather than relying on truncation. A statement Postgres refuses still succeeds: check `error` before `results`.",
|
|
417
|
+
inputJson: '{"additionalProperties":false,"properties":{"database_id":{"maxLength":200,"minLength":1,"title":"Database Id","type":"string"},"sql":{"description":"Exactly one statement. A statement that starts or ends a transaction is refused. It runs in a read-only transaction.","minLength":1,"title":"Sql","type":"string"},"params":{"default":[],"description":"Values for `$1` to `$n`: strings, numbers, booleans, `null`, or arrays of them. Postgres infers each type from where it appears. Pass JSON as a string with `$1::jsonb` and binary as a `\\\\x` hex string with `$1::bytea`. Objects are refused.","items":{"x-zo-json-value":true},"title":"Params","type":"array"},"max_rows":{"default":200,"description":"Rows to return per statement, at most 4,000. The result bounds (1 MiB and 10,000 JSON values) may stop sooner; `truncated` says when either did.","maximum":4000,"minimum":1,"title":"Max Rows","type":"integer"}},"required":["database_id","sql"],"title":"DatabaseQueryInput","type":"object"}',
|
|
418
|
+
resultKind: "inline",
|
|
419
|
+
},
|
|
420
|
+
],
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
action: "zo.database.update",
|
|
424
|
+
path: ["database", "update"],
|
|
425
|
+
versions: [
|
|
426
|
+
{
|
|
427
|
+
version: 1,
|
|
428
|
+
description: "Change a database's name, description or compute settings against its current revision, and return it.",
|
|
429
|
+
inputJson: '{"additionalProperties":false,"properties":{"database_id":{"maxLength":200,"minLength":1,"title":"Database Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"anyOf":[{"maxLength":120,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Display Name"},"description":{"anyOf":[{"maxLength":2000,"type":"string"},{"type":"null"}],"default":null,"description":"`\\"\\"` clears the description.","title":"Description"},"postgres":{"anyOf":[{"$ref":"#/$defs/DatabasePostgresUpdate"},{"type":"null"}],"default":null,"description":"A new minimum or maximum memory reaches the database within a minute and restarts its compute if it is awake, failing the calls running then."}},"required":["database_id","expected_revision"],"title":"DatabaseUpdateInput","type":"object","$defs":{"DatabaseComputeUpdate":{"additionalProperties":false,"description":"The compute settings to change. A field left out stays as it is.","properties":{"min_memory_mib":{"anyOf":[{"maximum":2147483647,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"title":"Min Memory Mib"},"max_memory_mib":{"anyOf":[{"maximum":2147483647,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"title":"Max Memory Mib"},"scale_to_zero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Scale To Zero"},"idle_timeout_seconds":{"anyOf":[{"maximum":2147483647,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"title":"Idle Timeout Seconds"}},"title":"DatabaseComputeUpdate","type":"object","required":[]},"DatabasePostgresUpdate":{"additionalProperties":false,"properties":{"compute":{"anyOf":[{"$ref":"#/$defs/DatabaseComputeUpdate"},{"type":"null"}],"default":null}},"title":"DatabasePostgresUpdate","type":"object","required":[]}}}',
|
|
430
|
+
resultKind: "inline",
|
|
431
|
+
},
|
|
432
|
+
],
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
action: "zo.event.create",
|
|
436
|
+
path: ["event", "create"],
|
|
437
|
+
versions: [
|
|
438
|
+
{
|
|
439
|
+
version: 1,
|
|
440
|
+
description: "Create an event definition under a publisher namespace the workspace owns.",
|
|
441
|
+
inputJson: '{"additionalProperties":false,"description":"``filter_paths`` are payload-relative pointers a subscription may filter on;\\n``subject_type`` is the resource type an occurrence\'s ``subject`` names.","properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"publisher":{"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$","title":"Publisher","type":"string"},"name":{"maxLength":64,"minLength":1,"pattern":"^[a-z][a-z0-9_]*(?:\\\\.[a-z][a-z0-9_]*)*$","title":"Name","type":"string"},"version":{"exclusiveMinimum":0,"maximum":999999999,"title":"Version","type":"integer"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"description":{"maxLength":4096,"minLength":1,"title":"Description","type":"string"},"payload_schema":{"additionalProperties":{"x-zo-json-value":true},"title":"Payload Schema","type":"object"},"filter_paths":{"default":[],"items":{"maxLength":251,"minLength":1,"pattern":"^(?:/[^/]*)+$","type":"string"},"maxItems":32,"title":"Filter Paths","type":"array"},"subject_type":{"anyOf":[{"pattern":"^(?:[a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:\\\\.[a-z][a-z0-9_]*)+)$","type":"string"},{"type":"null"}],"default":null,"title":"Subject Type"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","publisher","name","version","display_name","description","payload_schema"],"title":"EventCreateInput","type":"object"}',
|
|
442
|
+
resultKind: "inline",
|
|
443
|
+
},
|
|
444
|
+
{
|
|
445
|
+
version: 2,
|
|
446
|
+
description: "Create an event definition under a publisher namespace the workspace owns.",
|
|
447
|
+
inputJson: '{"additionalProperties":false,"description":"``filter_paths`` are payload-relative pointers a subscription may filter on;\\n``subject_type`` is the resource type an occurrence\'s ``subject`` names;\\n``conversation_path`` is the payload-relative pointer to the string field\\n(``maxLength`` at most 512) that names the conversation an occurrence belongs\\nto, which ``per_conversation`` Agent subscriptions key sessions by.","properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"publisher":{"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$","title":"Publisher","type":"string"},"name":{"maxLength":64,"minLength":1,"pattern":"^[a-z][a-z0-9_]*(?:\\\\.[a-z][a-z0-9_]*)*$","title":"Name","type":"string"},"version":{"exclusiveMinimum":0,"maximum":999999999,"title":"Version","type":"integer"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"description":{"maxLength":4096,"minLength":1,"title":"Description","type":"string"},"payload_schema":{"additionalProperties":{"x-zo-json-value":true},"title":"Payload Schema","type":"object"},"filter_paths":{"default":[],"items":{"maxLength":251,"minLength":1,"pattern":"^(?:/[^/]*)+$","type":"string"},"maxItems":32,"title":"Filter Paths","type":"array"},"subject_type":{"anyOf":[{"pattern":"^(?:[a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:\\\\.[a-z][a-z0-9_]*)+)$","type":"string"},{"type":"null"}],"default":null,"title":"Subject Type"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"},"conversation_path":{"anyOf":[{"maxLength":251,"minLength":1,"pattern":"^(?:/[^/]*)+$","type":"string"},{"type":"null"}],"default":null,"title":"Conversation Path"}},"required":["workspace_id","publisher","name","version","display_name","description","payload_schema"],"title":"EventCreateInputV2","type":"object"}',
|
|
448
|
+
resultKind: "inline",
|
|
449
|
+
},
|
|
450
|
+
],
|
|
451
|
+
},
|
|
452
|
+
{
|
|
453
|
+
action: "zo.event.delete",
|
|
454
|
+
path: ["event", "delete"],
|
|
455
|
+
versions: [
|
|
456
|
+
{
|
|
457
|
+
version: 1,
|
|
458
|
+
description: "Retire an event definition at the expected revision; its name and version are never reused.",
|
|
459
|
+
inputJson: '{"additionalProperties":false,"properties":{"event_id":{"title":"Event Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["event_id","expected_revision"],"title":"EventDeleteInput","type":"object"}',
|
|
460
|
+
resultKind: "inline",
|
|
461
|
+
},
|
|
462
|
+
],
|
|
463
|
+
},
|
|
464
|
+
{
|
|
465
|
+
action: "zo.event.dispatch",
|
|
466
|
+
path: ["event", "dispatch"],
|
|
467
|
+
versions: [
|
|
468
|
+
{
|
|
469
|
+
version: 1,
|
|
470
|
+
description: "Validate a payload against an active event definition and publish the occurrence durably under a caller-scoped idempotency key.",
|
|
471
|
+
inputJson: '{"additionalProperties":false,"description":"The payload and its caller-scoped idempotency key (1 to 255 printable ASCII\\ncharacters). Every envelope attribute (``id``, ``source``, ``type``, ``time``,\\nthe workspace, the definition and the causal fields) is derived by the server\\nand rejected as input.","properties":{"event_id":{"title":"Event Id","type":"string"},"idempotency_key":{"maxLength":255,"minLength":1,"pattern":"^[!-~]{1,255}$","title":"Idempotency Key","type":"string"},"data":{"additionalProperties":{"x-zo-json-value":true},"title":"Data","type":"object"},"subject":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Subject"}},"required":["event_id","idempotency_key","data"],"title":"EventDispatchInput","type":"object"}',
|
|
472
|
+
resultKind: "inline",
|
|
473
|
+
},
|
|
474
|
+
],
|
|
475
|
+
},
|
|
476
|
+
{
|
|
477
|
+
action: "zo.event.get",
|
|
478
|
+
path: ["event", "get"],
|
|
479
|
+
versions: [
|
|
480
|
+
{
|
|
481
|
+
version: 1,
|
|
482
|
+
description: "Inspect an event definition, its payload schema and the handler input contract it pins.",
|
|
483
|
+
inputJson: '{"additionalProperties":false,"properties":{"event_id":{"title":"Event Id","type":"string"}},"required":["event_id"],"title":"EventGetInput","type":"object"}',
|
|
484
|
+
resultKind: "inline",
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
version: 2,
|
|
488
|
+
description: "Inspect an event definition, its payload schema, the handler input contract it pins and the payload field that names its conversation.",
|
|
489
|
+
inputJson: '{"additionalProperties":false,"properties":{"event_id":{"title":"Event Id","type":"string"}},"required":["event_id"],"title":"EventGetInput","type":"object"}',
|
|
490
|
+
resultKind: "inline",
|
|
491
|
+
},
|
|
492
|
+
],
|
|
493
|
+
},
|
|
494
|
+
{
|
|
495
|
+
action: "zo.event.list",
|
|
496
|
+
path: ["event", "list"],
|
|
497
|
+
versions: [
|
|
498
|
+
{
|
|
499
|
+
version: 1,
|
|
500
|
+
description: "List event definitions accessible to the caller in a workspace.",
|
|
501
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"EventListInput","type":"object"}',
|
|
502
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":33,"description":"Rows per page, at most 33; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
503
|
+
resultKind: "inline",
|
|
504
|
+
},
|
|
505
|
+
],
|
|
506
|
+
},
|
|
507
|
+
{
|
|
508
|
+
action: "zo.event.update",
|
|
509
|
+
path: ["event", "update"],
|
|
510
|
+
versions: [
|
|
511
|
+
{
|
|
512
|
+
version: 1,
|
|
513
|
+
description: "Replace an event definition's display name and description at the expected revision.",
|
|
514
|
+
inputJson: '{"additionalProperties":false,"description":"Full replacement of the mutable display name and description.\\nName, version and payload schema are immutable; ``zo.event.delete``\\nretires.","properties":{"event_id":{"title":"Event Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"description":{"maxLength":4096,"minLength":1,"title":"Description","type":"string"}},"required":["event_id","expected_revision","display_name","description"],"title":"EventUpdateInput","type":"object"}',
|
|
515
|
+
resultKind: "inline",
|
|
516
|
+
},
|
|
517
|
+
],
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
action: "zo.function.activate",
|
|
521
|
+
path: ["function", "activate"],
|
|
522
|
+
versions: [
|
|
523
|
+
{
|
|
524
|
+
version: 1,
|
|
525
|
+
description: "Activate a ready deployment of a function at the expected revision.",
|
|
526
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"},"deployment_id":{"title":"Deployment Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"acknowledge_bound_accounts":{"default":[],"items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":8,"title":"Acknowledge Bound Accounts","type":"array"}},"required":["function_id","deployment_id","expected_revision"],"title":"FunctionActivateWithBindingsInput","type":"object"}',
|
|
527
|
+
resultKind: "inline",
|
|
528
|
+
},
|
|
529
|
+
],
|
|
530
|
+
},
|
|
531
|
+
{
|
|
532
|
+
action: "zo.function.build",
|
|
533
|
+
path: ["function", "build"],
|
|
534
|
+
versions: [
|
|
535
|
+
{
|
|
536
|
+
version: 1,
|
|
537
|
+
description: "Queue a function build from a completed source.",
|
|
538
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"},"source_id":{"title":"Source Id","type":"string"},"requirements":{"$ref":"#/$defs/FunctionRequirements"},"build_config":{"additionalProperties":{"x-zo-json-value":true},"title":"Build Config","type":"object"}},"required":["function_id","source_id","requirements","build_config"],"title":"FunctionBuildInput","type":"object","$defs":{"FunctionRequirements":{"additionalProperties":false,"properties":{"runtime":{"$ref":"#/$defs/Runtime"},"cpu":{"exclusiveMinimum":0,"title":"Cpu","type":"number"},"memory_mb":{"exclusiveMinimum":0,"title":"Memory Mb","type":"integer"},"timeout_seconds":{"exclusiveMinimum":0,"title":"Timeout Seconds","type":"integer"},"min_instances":{"minimum":0,"title":"Min Instances","type":"integer"},"max_instances":{"exclusiveMinimum":0,"title":"Max Instances","type":"integer"},"concurrency":{"exclusiveMinimum":0,"title":"Concurrency","type":"integer"}},"required":["runtime","cpu","memory_mb","timeout_seconds","min_instances","max_instances","concurrency"],"title":"FunctionRequirements","type":"object"},"Runtime":{"enum":["python3.12","node22"],"type":"string"}}}',
|
|
539
|
+
resultKind: "run",
|
|
540
|
+
},
|
|
541
|
+
],
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
action: "zo.function.cancel_run",
|
|
545
|
+
path: ["function", "cancel-run"],
|
|
546
|
+
versions: [
|
|
547
|
+
{
|
|
548
|
+
version: 1,
|
|
549
|
+
description: "Request cancellation of a run owned by this function.",
|
|
550
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"},"run_id":{"title":"Run Id","type":"string"}},"required":["function_id","run_id"],"title":"FunctionCancelRunInput","type":"object"}',
|
|
551
|
+
resultKind: "inline",
|
|
552
|
+
},
|
|
553
|
+
],
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
action: "zo.function.create",
|
|
557
|
+
path: ["function", "create"],
|
|
558
|
+
versions: [
|
|
559
|
+
{
|
|
560
|
+
version: 1,
|
|
561
|
+
description: "Create a workspace-owned function.",
|
|
562
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","display_name"],"title":"FunctionCreateInput","type":"object"}',
|
|
563
|
+
resultKind: "inline",
|
|
564
|
+
},
|
|
565
|
+
],
|
|
566
|
+
},
|
|
567
|
+
{
|
|
568
|
+
action: "zo.function.delete",
|
|
569
|
+
path: ["function", "delete"],
|
|
570
|
+
versions: [
|
|
571
|
+
{
|
|
572
|
+
version: 1,
|
|
573
|
+
description: "Retire a function and stop new build and deployment work.",
|
|
574
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["function_id","expected_revision"],"title":"FunctionDeleteInput","type":"object"}',
|
|
575
|
+
resultKind: "inline",
|
|
576
|
+
},
|
|
577
|
+
],
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
action: "zo.function.deploy",
|
|
581
|
+
path: ["function", "deploy"],
|
|
582
|
+
versions: [
|
|
583
|
+
{
|
|
584
|
+
version: 1,
|
|
585
|
+
description: "Queue a deployment of a succeeded build under a published contract.",
|
|
586
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"},"build_id":{"title":"Build Id","type":"string"},"contract_version":{"exclusiveMinimum":0,"maximum":2147483647,"title":"Contract Version","type":"integer"},"requirements":{"$ref":"#/$defs/FunctionRequirements"},"entrypoints":{"additionalProperties":{"x-zo-json-value":true},"title":"Entrypoints","type":"object"},"invoke_enabled":{"default":false,"title":"Invoke Enabled","type":"boolean"},"http_enabled":{"default":false,"title":"Http Enabled","type":"boolean"},"credential_slots":{"default":[],"items":{"$ref":"#/$defs/FunctionBoundCredentialSlot"},"maxItems":8,"title":"Credential Slots","type":"array"},"acknowledge_bound_accounts":{"default":[],"items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":8,"title":"Acknowledge Bound Accounts","type":"array"}},"required":["function_id","build_id","contract_version","requirements","entrypoints"],"title":"FunctionDeployWithBindingsInput","type":"object","$defs":{"FunctionBoundCredentialSlot":{"additionalProperties":false,"properties":{"name":{"maxLength":200,"minLength":1,"title":"Name","type":"string"},"definition_id":{"maxLength":200,"minLength":1,"title":"Definition Id","type":"string"},"definition_slot":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Definition Slot"},"connection_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Connection Id"}},"required":["name","definition_id"],"title":"FunctionBoundCredentialSlot","type":"object"},"FunctionRequirements":{"additionalProperties":false,"properties":{"runtime":{"$ref":"#/$defs/Runtime"},"cpu":{"exclusiveMinimum":0,"title":"Cpu","type":"number"},"memory_mb":{"exclusiveMinimum":0,"title":"Memory Mb","type":"integer"},"timeout_seconds":{"exclusiveMinimum":0,"title":"Timeout Seconds","type":"integer"},"min_instances":{"minimum":0,"title":"Min Instances","type":"integer"},"max_instances":{"exclusiveMinimum":0,"title":"Max Instances","type":"integer"},"concurrency":{"exclusiveMinimum":0,"title":"Concurrency","type":"integer"}},"required":["runtime","cpu","memory_mb","timeout_seconds","min_instances","max_instances","concurrency"],"title":"FunctionRequirements","type":"object"},"Runtime":{"enum":["python3.12","node22"],"type":"string"}}}',
|
|
587
|
+
resultKind: "run",
|
|
588
|
+
},
|
|
589
|
+
],
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
action: "zo.function.get",
|
|
593
|
+
path: ["function", "get"],
|
|
594
|
+
versions: [
|
|
595
|
+
{
|
|
596
|
+
version: 1,
|
|
597
|
+
description: "Inspect a function and its newest builds and deployments.",
|
|
598
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"}},"required":["function_id"],"title":"FunctionGetInput","type":"object"}',
|
|
599
|
+
resultKind: "inline",
|
|
600
|
+
},
|
|
601
|
+
],
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
action: "zo.function.get_run",
|
|
605
|
+
path: ["function", "get-run"],
|
|
606
|
+
versions: [
|
|
607
|
+
{
|
|
608
|
+
version: 1,
|
|
609
|
+
description: "Read a run owned by this function, including an available result.",
|
|
610
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"},"run_id":{"title":"Run Id","type":"string"}},"required":["function_id","run_id"],"title":"FunctionGetRunInput","type":"object"}',
|
|
611
|
+
resultKind: "inline",
|
|
612
|
+
},
|
|
613
|
+
],
|
|
614
|
+
},
|
|
615
|
+
{
|
|
616
|
+
action: "zo.function.invoke",
|
|
617
|
+
path: ["function", "invoke"],
|
|
618
|
+
versions: [
|
|
619
|
+
{
|
|
620
|
+
version: 1,
|
|
621
|
+
description: "Run the function's active deployment against an input and return its outcome. Input is limited to 1 MiB. Background dispatch also requires the encoded Cloud Tasks envelope to fit its 1 MiB limit.",
|
|
622
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"},"contract_version":{"exclusiveMinimum":0,"maximum":2147483647,"title":"Contract Version","type":"integer"},"input":{"x-zo-json-value":true},"handler":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Handler"},"mode":{"anyOf":[{"enum":["direct","background"],"type":"string"},{"type":"null"}],"default":null,"title":"Mode"},"connections":{"additionalProperties":{"maxLength":200,"minLength":1,"type":"string"},"default":{},"maxProperties":8,"title":"Connections","type":"object"}},"required":["function_id","contract_version","input"],"title":"FunctionInvokeWithConnectionsInput","type":"object"}',
|
|
623
|
+
resultKind: "run",
|
|
624
|
+
},
|
|
625
|
+
],
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
action: "zo.function.list",
|
|
629
|
+
path: ["function", "list"],
|
|
630
|
+
versions: [
|
|
631
|
+
{
|
|
632
|
+
version: 1,
|
|
633
|
+
description: "List functions accessible to the caller in a workspace.",
|
|
634
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"FunctionListInput","type":"object"}',
|
|
635
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
636
|
+
resultKind: "inline",
|
|
637
|
+
},
|
|
638
|
+
],
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
action: "zo.function.list_runs",
|
|
642
|
+
path: ["function", "list-runs"],
|
|
643
|
+
versions: [
|
|
644
|
+
{
|
|
645
|
+
version: 1,
|
|
646
|
+
description: "List the function's runs, newest first.",
|
|
647
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"}},"required":["function_id"],"title":"FunctionListRunsInput","type":"object"}',
|
|
648
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
649
|
+
resultKind: "inline",
|
|
650
|
+
},
|
|
651
|
+
],
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
action: "zo.function.publish_contract",
|
|
655
|
+
path: ["function", "publish-contract"],
|
|
656
|
+
versions: [
|
|
657
|
+
{
|
|
658
|
+
version: 1,
|
|
659
|
+
description: "Publish an immutable version of a function's input and output contract.",
|
|
660
|
+
inputJson: '{"additionalProperties":false,"properties":{"function_id":{"title":"Function Id","type":"string"},"contract_version":{"exclusiveMinimum":0,"maximum":2147483647,"title":"Contract Version","type":"integer"},"input_schema":{"additionalProperties":{"x-zo-json-value":true},"title":"Input Schema","type":"object"},"output_schema":{"additionalProperties":{"x-zo-json-value":true},"title":"Output Schema","type":"object"}},"required":["function_id","contract_version","input_schema","output_schema"],"title":"PublishContractInput","type":"object"}',
|
|
661
|
+
resultKind: "inline",
|
|
662
|
+
},
|
|
663
|
+
],
|
|
664
|
+
},
|
|
665
|
+
{
|
|
666
|
+
action: "zo.machine.apply_patch",
|
|
667
|
+
path: ["machine", "apply-patch"],
|
|
668
|
+
versions: [
|
|
669
|
+
{
|
|
670
|
+
version: 1,
|
|
671
|
+
description: "Edit a UTF-8 file in place on a running managed machine with exact-string replacements, all or none. The edits carry at most 131072 bytes; the file may be up to 4194304 bytes.",
|
|
672
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"path":{"maxLength":4096,"minLength":1,"pattern":"^/","title":"Path","type":"string"},"edits":{"items":{"$ref":"#/$defs/PatchEdit"},"maxItems":100,"minItems":1,"title":"Edits","type":"array"},"expected_sha256":{"anyOf":[{"maxLength":64,"minLength":64,"pattern":"^[0-9a-f]{64}$","type":"string"},{"type":"null"}],"default":null,"title":"Expected Sha256"}},"required":["machine_id","path","edits"],"title":"ApplyPatchInput","type":"object","$defs":{"PatchEdit":{"additionalProperties":false,"description":"Replace ``old``, which must occur exactly once, with ``new``.","properties":{"old":{"minLength":1,"title":"Old","type":"string"},"new":{"title":"New","type":"string"}},"required":["old","new"],"title":"PatchEdit","type":"object"}}}',
|
|
673
|
+
resultKind: "inline",
|
|
674
|
+
},
|
|
675
|
+
],
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
action: "zo.machine.create",
|
|
679
|
+
path: ["machine", "create"],
|
|
680
|
+
versions: [
|
|
681
|
+
{
|
|
682
|
+
version: 1,
|
|
683
|
+
description: "Create a managed machine from a machine image and return its current view.",
|
|
684
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"idempotency_key":{"maxLength":255,"minLength":1,"pattern":"^[!-~]{1,255}$","title":"Idempotency Key","type":"string"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"source":{"$ref":"#/$defs/MachineSourceInput"},"resources":{"$ref":"#/$defs/MachineResourcesInput"},"lifecycle":{"$ref":"#/$defs/MachineLifecycleInput"},"region":{"default":"us","pattern":"^[a-z0-9][a-z0-9-]{0,31}$","title":"Region","type":"string"},"init":{"default":"none","description":"Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the init system inside the machine\'s image (systemd, OpenRC) becomes PID 1 and starts the services enabled on its disk. This does not choose the image; `source.machine_image_id` does. Debian and Ubuntu images need `systemd systemd-sysv` installed first. A unit restarts after a crash only when it sets `Restart=`.","enum":["none","image"],"title":"Init","type":"string"},"command":{"anyOf":[{"items":{"minLength":1,"type":"string"},"maxItems":64,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"Run these arguments as the main process on every boot, without a shell. Use [\\"sh\\", \\"-c\\", ...] for shell syntax. Find ENTRYPOINT and CMD on the image\'s registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, the command must wait for services it needs. The machine stops when it exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations` (3,600 s today); a longer job needs Zo exec or file calls, or HTTP through a tunnel or connect token. After exit, `get` may show `running` for a few minutes until the stop is recorded. Zo reports no exit reason or code. Write a job\'s result to disk. A resume runs the command again, so to read it, clear the command, resume, then use `zo.machine.read_bytes`. With `init: image` and a command, a missing `/sbin/init` ends the generation as an exit stop, without `incompatible_image`.","title":"Command"},"visibility":{"default":"workspace","description":"`workspace` (default): every member can see and use it. `protected`: only you, and whoever you share it with; workspace-wide grants don\'t reach it. Fixed at creation.","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","idempotency_key","display_name","source","resources","lifecycle"],"title":"MachineCreateInput","type":"object","$defs":{"MachineLifecycleInput":{"additionalProperties":false,"properties":{"idle_timeout_seconds":{"default":900,"maximum":86400,"minimum":1,"title":"Idle Timeout Seconds","type":"integer"},"max_run_seconds":{"maximum":86400,"minimum":1,"title":"Max Run Seconds","type":"integer"}},"required":["max_run_seconds"],"title":"MachineLifecycleInput","type":"object"},"MachineResourcesInput":{"additionalProperties":false,"properties":{"vcpus":{"description":"Whole vCPUs of CPU capacity; each is half a Modal physical core. A quarter is reserved; the full allocation can burst when capacity allows. Guest logical CPU count is separate.","maximum":2147483647,"minimum":1,"title":"Vcpus","type":"integer"},"memory_mib":{"maximum":2147483647,"minimum":1,"title":"Memory Mib","type":"integer"}},"required":["vcpus","memory_mib"],"title":"MachineResourcesInput","type":"object"},"MachineSourceInput":{"additionalProperties":false,"properties":{"machine_image_id":{"description":"The machine image to boot (from `zo.machine_image.import`). Separate from `init`, which only chooses what runs first at boot.","minLength":1,"title":"Machine Image Id","type":"string"}},"required":["machine_image_id"],"title":"MachineSourceInput","type":"object"}}}',
|
|
685
|
+
resultKind: "inline",
|
|
686
|
+
},
|
|
687
|
+
],
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
action: "zo.machine.destroy",
|
|
691
|
+
path: ["machine", "destroy"],
|
|
692
|
+
versions: [
|
|
693
|
+
{
|
|
694
|
+
version: 1,
|
|
695
|
+
description: "Destroy a managed machine and return its current view.",
|
|
696
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"idempotency_key":{"maxLength":255,"minLength":1,"pattern":"^[!-~]{1,255}$","title":"Idempotency Key","type":"string"}},"required":["machine_id","expected_revision","idempotency_key"],"title":"MachineLifecycleActionInput","type":"object"}',
|
|
697
|
+
resultKind: "inline",
|
|
698
|
+
},
|
|
699
|
+
],
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
action: "zo.machine.exec",
|
|
703
|
+
path: ["machine", "exec"],
|
|
704
|
+
versions: [
|
|
705
|
+
{
|
|
706
|
+
version: 1,
|
|
707
|
+
description: "Run a bounded shell command on a running managed machine.",
|
|
708
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"command":{"minLength":1,"title":"Command","type":"string"},"workdir":{"anyOf":[{"maxLength":4096,"minLength":1,"pattern":"^/","type":"string"},{"type":"null"}],"default":null,"title":"Workdir"},"timeout_sec":{"default":30,"maximum":60,"minimum":1,"title":"Timeout Sec","type":"integer"}},"required":["machine_id","command"],"title":"ManagedExecInput","type":"object"}',
|
|
709
|
+
resultKind: "inline",
|
|
710
|
+
},
|
|
711
|
+
],
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
action: "zo.machine.get",
|
|
715
|
+
path: ["machine", "get"],
|
|
716
|
+
versions: [
|
|
717
|
+
{
|
|
718
|
+
version: 1,
|
|
719
|
+
description: "Inspect a managed machine: its image, shape, region, timers and lifecycle state.",
|
|
720
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"}},"required":["machine_id"],"title":"MachineGetInput","type":"object"}',
|
|
721
|
+
resultKind: "inline",
|
|
722
|
+
},
|
|
723
|
+
],
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
action: "zo.machine.list",
|
|
727
|
+
path: ["machine", "list"],
|
|
728
|
+
versions: [
|
|
729
|
+
{
|
|
730
|
+
version: 1,
|
|
731
|
+
description: "List the managed machines the caller can see in a workspace.",
|
|
732
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"MachineListInput","type":"object"}',
|
|
733
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"}},"required":[]}',
|
|
734
|
+
resultKind: "inline",
|
|
735
|
+
},
|
|
736
|
+
],
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
action: "zo.machine.list_configurations",
|
|
740
|
+
path: ["machine", "list-configurations"],
|
|
741
|
+
versions: [
|
|
742
|
+
{
|
|
743
|
+
version: 1,
|
|
744
|
+
description: "List independent whole-vCPU and whole-MiB ranges, regions, timeout bounds and per-second unit prices.",
|
|
745
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"MachineListConfigurationsInput","type":"object"}',
|
|
746
|
+
resultKind: "inline",
|
|
747
|
+
},
|
|
748
|
+
],
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
action: "zo.machine.list_files",
|
|
752
|
+
path: ["machine", "list-files"],
|
|
753
|
+
versions: [
|
|
754
|
+
{
|
|
755
|
+
version: 1,
|
|
756
|
+
description: "List one level of a directory on a running managed machine, or describe one file or symlink. Never recursive; symlinks are reported, not followed.",
|
|
757
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"path":{"maxLength":4096,"minLength":1,"pattern":"^/","title":"Path","type":"string"}},"required":["machine_id","path"],"title":"ListFilesInput","type":"object"}',
|
|
758
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":200,"description":"Rows per page, at most 500; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
759
|
+
resultKind: "inline",
|
|
760
|
+
},
|
|
761
|
+
],
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
action: "zo.machine.read_bytes",
|
|
765
|
+
path: ["machine", "read-bytes"],
|
|
766
|
+
versions: [
|
|
767
|
+
{
|
|
768
|
+
version: 1,
|
|
769
|
+
description: "Read a whole file of at most 131072 bytes from a running managed machine, as UTF-8 text or base64.",
|
|
770
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"path":{"maxLength":4096,"minLength":1,"pattern":"^/","title":"Path","type":"string"},"encoding":{"default":"utf8","enum":["utf8","base64"],"title":"Encoding","type":"string"}},"required":["machine_id","path"],"title":"ReadBytesInput","type":"object"}',
|
|
771
|
+
resultKind: "inline",
|
|
772
|
+
},
|
|
773
|
+
],
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
action: "zo.machine.resume",
|
|
777
|
+
path: ["machine", "resume"],
|
|
778
|
+
versions: [
|
|
779
|
+
{
|
|
780
|
+
version: 1,
|
|
781
|
+
description: "Start a stopped managed machine again and return its current view.",
|
|
782
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"idempotency_key":{"maxLength":255,"minLength":1,"pattern":"^[!-~]{1,255}$","title":"Idempotency Key","type":"string"},"accept_recovery":{"default":false,"title":"Accept Recovery","type":"boolean"}},"required":["machine_id","expected_revision","idempotency_key"],"title":"MachineResumeInput","type":"object"}',
|
|
783
|
+
resultKind: "inline",
|
|
784
|
+
},
|
|
785
|
+
],
|
|
786
|
+
},
|
|
787
|
+
{
|
|
788
|
+
action: "zo.machine.snapshot",
|
|
789
|
+
path: ["machine", "snapshot"],
|
|
790
|
+
versions: [
|
|
791
|
+
{
|
|
792
|
+
version: 1,
|
|
793
|
+
description: "Save a running managed machine's filesystem as a ready image. Destination options live under image. Image visibility defaults to the source; choose workspace or protected explicitly to override it. Finish filesystem writes first. Processes and credentials are not rebound from the source. User-written secrets remain in captured files. Never automatically retry an uncertain result.",
|
|
794
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"image":{"$ref":"#/$defs/MachineImageCreateOptions"},"timeout_seconds":{"default":60,"description":"Maximum seconds for filesystem capture, including provider lookup. The remaining request deadline can shorten this budget.","maximum":180,"minimum":1,"title":"Timeout Seconds","type":"integer"}},"required":["machine_id","expected_revision","image"],"title":"MachineSnapshotInput","type":"object","$defs":{"MachineImageCreateOptions":{"additionalProperties":false,"properties":{"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"visibility":{"anyOf":[{"enum":["workspace","protected"],"type":"string"},{"type":"null"}],"default":null,"description":"Image visibility. Omit or pass null to use the creating operation\'s default. Protected images use ordinary verified-human creator ownership.","title":"Visibility"}},"required":["display_name"],"title":"MachineImageCreateOptions","type":"object"}}}',
|
|
795
|
+
resultKind: "inline",
|
|
796
|
+
},
|
|
797
|
+
],
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
action: "zo.machine.stop",
|
|
801
|
+
path: ["machine", "stop"],
|
|
802
|
+
versions: [
|
|
803
|
+
{
|
|
804
|
+
version: 1,
|
|
805
|
+
description: "Stop a managed machine, keeping its files, and return its current view.",
|
|
806
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"idempotency_key":{"maxLength":255,"minLength":1,"pattern":"^[!-~]{1,255}$","title":"Idempotency Key","type":"string"}},"required":["machine_id","expected_revision","idempotency_key"],"title":"MachineLifecycleActionInput","type":"object"}',
|
|
807
|
+
resultKind: "inline",
|
|
808
|
+
},
|
|
809
|
+
],
|
|
810
|
+
},
|
|
811
|
+
{
|
|
812
|
+
action: "zo.machine.system_info",
|
|
813
|
+
path: ["machine", "system-info"],
|
|
814
|
+
versions: [
|
|
815
|
+
{
|
|
816
|
+
version: 1,
|
|
817
|
+
description: "Read a managed machine's recorded system information and capabilities without waking it.",
|
|
818
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"}},"required":["machine_id"],"title":"MachineGetInput","type":"object"}',
|
|
819
|
+
resultKind: "inline",
|
|
820
|
+
},
|
|
821
|
+
],
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
action: "zo.machine.update",
|
|
825
|
+
path: ["machine", "update"],
|
|
826
|
+
versions: [
|
|
827
|
+
{
|
|
828
|
+
version: 1,
|
|
829
|
+
description: "Change a managed machine's name, timers or next-boot settings against its current revision.",
|
|
830
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"anyOf":[{"maxLength":120,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Display Name"},"lifecycle":{"anyOf":[{"$ref":"#/$defs/MachineLifecycleUpdate"},{"type":"null"}],"default":null},"init":{"anyOf":[{"enum":["none","image"],"type":"string"},{"type":"null"}],"default":null,"description":"Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the image\'s init system (systemd, OpenRC) becomes PID 1 and starts enabled services. `source.machine_image_id` chooses the image. Debian and Ubuntu need `systemd systemd-sysv`. Setting `image` needs exec permission; approval-gated exec is denied. Write access to boot files can run code as root at next boot.","title":"Init"},"command":{"anyOf":[{"items":{"minLength":1,"type":"string"},"maxItems":64,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"Set the main process for the next resume. Arguments run without a shell; use [\\"sh\\", \\"-c\\", ...] for shell syntax. Find ENTRYPOINT and CMD on the image\'s registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, wait for needed services. The machine stops when the command exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations` (3,600 s today); a longer job needs Zo exec or file calls, or HTTP through a tunnel or connect token. After exit, `get` may show `running` for a few minutes. Zo reports no exit reason or code. Write a job\'s result to disk. A resume runs the command again, so to read it, clear the command, resume, then use `zo.machine.read_bytes`. With `init: image` and a command, a missing `/sbin/init` ends the generation as an exit stop, without `incompatible_image`. Changing the command needs exec permission; approval-gated exec is denied. Write access to its script can run code as root at next boot.","title":"Command"},"clear_command":{"default":false,"description":"Remove the main process on the next resume. Requires manage permission only.","title":"Clear Command","type":"boolean"}},"required":["machine_id","expected_revision"],"title":"MachineUpdateInput","type":"object","$defs":{"MachineLifecycleUpdate":{"additionalProperties":false,"description":"The timers a caller may change after create. Modal fixes them at\\nsandbox create, so a change takes effect at the next resume.","properties":{"idle_timeout_seconds":{"anyOf":[{"maximum":86400,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"title":"Idle Timeout Seconds"},"max_run_seconds":{"anyOf":[{"maximum":86400,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"title":"Max Run Seconds"}},"title":"MachineLifecycleUpdate","type":"object","required":[]}}}',
|
|
831
|
+
resultKind: "inline",
|
|
832
|
+
},
|
|
833
|
+
],
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
action: "zo.machine.write_bytes",
|
|
837
|
+
path: ["machine", "write-bytes"],
|
|
838
|
+
versions: [
|
|
839
|
+
{
|
|
840
|
+
version: 1,
|
|
841
|
+
description: "Replace a whole file of at most 131072 bytes on a running managed machine, creating it only when absent or overwriting only the expected contents.",
|
|
842
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_id":{"title":"Machine Id","type":"string"},"path":{"maxLength":4096,"minLength":1,"pattern":"^/","title":"Path","type":"string"},"content":{"title":"Content","type":"string"},"encoding":{"default":"utf8","enum":["utf8","base64"],"title":"Encoding","type":"string"},"create_parents":{"default":false,"title":"Create Parents","type":"boolean"},"expected_sha256":{"anyOf":[{"maxLength":64,"minLength":64,"pattern":"^[0-9a-f]{64}$","type":"string"},{"type":"null"}],"default":null,"title":"Expected Sha256"}},"required":["machine_id","path","content"],"title":"WriteBytesInput","type":"object"}',
|
|
843
|
+
resultKind: "inline",
|
|
844
|
+
},
|
|
845
|
+
],
|
|
846
|
+
},
|
|
847
|
+
{
|
|
848
|
+
action: "zo.machine_image.delete",
|
|
849
|
+
path: ["machine-image", "delete"],
|
|
850
|
+
versions: [
|
|
851
|
+
{
|
|
852
|
+
version: 1,
|
|
853
|
+
description: "Delete a machine image no machine uses and return the image view.",
|
|
854
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_image_id":{"title":"Machine Image Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"idempotency_key":{"maxLength":255,"minLength":1,"pattern":"^[!-~]{1,255}$","title":"Idempotency Key","type":"string"}},"required":["machine_image_id","expected_revision","idempotency_key"],"title":"MachineImageDeleteInput","type":"object"}',
|
|
855
|
+
resultKind: "inline",
|
|
856
|
+
},
|
|
857
|
+
],
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
action: "zo.machine_image.get",
|
|
861
|
+
path: ["machine-image", "get"],
|
|
862
|
+
versions: [
|
|
863
|
+
{
|
|
864
|
+
version: 1,
|
|
865
|
+
description: "Inspect a machine image: its source, pinned digest and status.",
|
|
866
|
+
inputJson: '{"additionalProperties":false,"properties":{"machine_image_id":{"title":"Machine Image Id","type":"string"}},"required":["machine_image_id"],"title":"MachineImageGetInput","type":"object"}',
|
|
867
|
+
resultKind: "inline",
|
|
868
|
+
},
|
|
869
|
+
],
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
action: "zo.machine_image.import",
|
|
873
|
+
path: ["machine-image", "import"],
|
|
874
|
+
versions: [
|
|
875
|
+
{
|
|
876
|
+
version: 1,
|
|
877
|
+
description: "Import a registry image, pinned to its manifest digest, and return the image view.",
|
|
878
|
+
inputJson: '{"additionalProperties":false,"properties":{"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"visibility":{"default":"workspace","description":"`workspace` (default): every member can see and use it. `protected`: only you, and whoever you share it with; workspace-wide grants don\'t reach it. Fixed at creation.","enum":["workspace","protected"],"title":"Visibility","type":"string"},"workspace_id":{"title":"Workspace Id","type":"string"},"idempotency_key":{"maxLength":255,"minLength":1,"pattern":"^[!-~]{1,255}$","title":"Idempotency Key","type":"string"},"source":{"$ref":"#/$defs/RegistrySourceInput"}},"required":["display_name","workspace_id","idempotency_key","source"],"title":"MachineImageImportInput","type":"object","$defs":{"RegistrySourceInput":{"additionalProperties":false,"properties":{"kind":{"const":"registry","title":"Kind","type":"string"},"ref":{"maxLength":1024,"minLength":1,"pattern":"^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*(?::[0-9]{1,5})?/)?[a-z0-9]+(?:(?:[._]|__|-+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]|__|-+)[a-z0-9]+)*)*(?::[A-Za-z0-9_][A-Za-z0-9_.-]{0,127})?(?:@sha256:[0-9a-f]{64})?$","title":"Ref","type":"string"},"platform":{"const":"linux/amd64","default":"linux/amd64","title":"Platform","type":"string"}},"required":["kind","ref"],"title":"RegistrySourceInput","type":"object"}}}',
|
|
879
|
+
resultKind: "inline",
|
|
880
|
+
},
|
|
881
|
+
],
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
action: "zo.machine_image.list",
|
|
885
|
+
path: ["machine-image", "list"],
|
|
886
|
+
versions: [
|
|
887
|
+
{
|
|
888
|
+
version: 1,
|
|
889
|
+
description: "List the machine images the caller can see in a workspace, except deleted ones.",
|
|
890
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"MachineImageListInput","type":"object"}',
|
|
891
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"}},"required":[]}',
|
|
892
|
+
resultKind: "inline",
|
|
893
|
+
},
|
|
894
|
+
],
|
|
895
|
+
},
|
|
896
|
+
{
|
|
897
|
+
action: "zo.message.get",
|
|
898
|
+
path: ["message", "get"],
|
|
899
|
+
versions: [
|
|
900
|
+
{
|
|
901
|
+
version: 1,
|
|
902
|
+
description: "Read a message an Agent sent or received, and what happened to it.",
|
|
903
|
+
inputJson: '{"additionalProperties":false,"properties":{"agent_id":{"description":"The Agent that sent or received the message.","maxLength":200,"minLength":1,"title":"Agent Id","type":"string"},"message_id":{"maxLength":200,"minLength":1,"title":"Message Id","type":"string"}},"required":["agent_id","message_id"],"title":"MessageGetInput","type":"object"}',
|
|
904
|
+
resultKind: "inline",
|
|
905
|
+
},
|
|
906
|
+
],
|
|
907
|
+
},
|
|
908
|
+
{
|
|
909
|
+
action: "zo.oauth_app.create",
|
|
910
|
+
path: ["oauth-app", "create"],
|
|
911
|
+
versions: [
|
|
912
|
+
{
|
|
913
|
+
version: 1,
|
|
914
|
+
description: "Register an OAuth app a workspace's connections authorize through.",
|
|
915
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"provider":{"maxLength":200,"minLength":1,"title":"Provider","type":"string"},"client_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Client Id"},"manager_ref":{"additionalProperties":{"x-zo-json-value":true},"default":{},"title":"Manager Ref","type":"object"},"visibility":{"enum":["private","public"],"title":"Visibility","type":"string"},"requested_scopes":{"items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":100,"title":"Requested Scopes","type":"array"},"connection_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Connection Id"},"client_secret":{"anyOf":[{"maxLength":4096,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"The app\'s client secret. Zo seals it in the workspace vault and stores only its `manager_ref.client_secret_id`; it is never returned.","title":"Client Secret"}},"required":["workspace_id","provider","visibility","requested_scopes"],"title":"OAuthAppCreateWithSecretInput","type":"object"}',
|
|
916
|
+
resultKind: "inline",
|
|
917
|
+
},
|
|
918
|
+
],
|
|
919
|
+
},
|
|
920
|
+
{
|
|
921
|
+
action: "zo.oauth_app.delete",
|
|
922
|
+
path: ["oauth-app", "delete"],
|
|
923
|
+
versions: [
|
|
924
|
+
{
|
|
925
|
+
version: 1,
|
|
926
|
+
description: "Delete an OAuth app registration.",
|
|
927
|
+
inputJson: '{"additionalProperties":false,"properties":{"owner":{"$ref":"#/$defs/OAuthAppOwner"},"oauth_app_id":{"maxLength":200,"minLength":1,"title":"Oauth App Id","type":"string"},"expected_state":{"pattern":"^[0-9a-f]{64}$","title":"Expected State","type":"string"}},"required":["owner","oauth_app_id","expected_state"],"title":"OAuthAppTargetInput","type":"object","$defs":{"OAuthAppOwner":{"additionalProperties":false,"properties":{"type":{"description":"The workspace, or the connection the app is bound to.","enum":["workspace","connection"],"title":"Type","type":"string"},"id":{"maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["type","id"],"title":"OAuthAppOwner","type":"object"}}}',
|
|
928
|
+
resultKind: "inline",
|
|
929
|
+
},
|
|
930
|
+
],
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
action: "zo.oauth_app.get",
|
|
934
|
+
path: ["oauth-app", "get"],
|
|
935
|
+
versions: [
|
|
936
|
+
{
|
|
937
|
+
version: 1,
|
|
938
|
+
description: "Read an OAuth app registration.",
|
|
939
|
+
inputJson: '{"additionalProperties":false,"properties":{"owner":{"$ref":"#/$defs/OAuthAppOwner"},"oauth_app_id":{"maxLength":200,"minLength":1,"title":"Oauth App Id","type":"string"}},"required":["owner","oauth_app_id"],"title":"OAuthAppGetInput","type":"object","$defs":{"OAuthAppOwner":{"additionalProperties":false,"properties":{"type":{"description":"The workspace, or the connection the app is bound to.","enum":["workspace","connection"],"title":"Type","type":"string"},"id":{"maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["type","id"],"title":"OAuthAppOwner","type":"object"}}}',
|
|
940
|
+
resultKind: "inline",
|
|
941
|
+
},
|
|
942
|
+
],
|
|
943
|
+
},
|
|
944
|
+
{
|
|
945
|
+
action: "zo.oauth_app.list",
|
|
946
|
+
path: ["oauth-app", "list"],
|
|
947
|
+
versions: [
|
|
948
|
+
{
|
|
949
|
+
version: 1,
|
|
950
|
+
description: "List a workspace's OAuth app registrations.",
|
|
951
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"OAuthAppListInput","type":"object"}',
|
|
952
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 100; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
953
|
+
resultKind: "inline",
|
|
954
|
+
},
|
|
955
|
+
],
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
action: "zo.oauth_app.update",
|
|
959
|
+
path: ["oauth-app", "update"],
|
|
960
|
+
versions: [
|
|
961
|
+
{
|
|
962
|
+
version: 1,
|
|
963
|
+
description: "Replace an OAuth app's client, secret and visibility.",
|
|
964
|
+
inputJson: '{"additionalProperties":false,"properties":{"owner":{"$ref":"#/$defs/OAuthAppOwner"},"oauth_app_id":{"maxLength":200,"minLength":1,"title":"Oauth App Id","type":"string"},"expected_state":{"pattern":"^[0-9a-f]{64}$","title":"Expected State","type":"string"},"client_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Client Id"},"manager_ref":{"anyOf":[{"additionalProperties":{"x-zo-json-value":true},"type":"object"},{"type":"null"}],"default":null,"description":"Omitted: keep the app\'s current `manager_ref` (with a new `client_secret`, only its secret id changes).","title":"Manager Ref"},"visibility":{"enum":["private","public"],"title":"Visibility","type":"string"},"client_secret":{"anyOf":[{"maxLength":4096,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"The app\'s client secret. Zo seals it in the workspace vault and stores only its `manager_ref.client_secret_id`; it is never returned.","title":"Client Secret"}},"required":["owner","oauth_app_id","expected_state","visibility"],"title":"OAuthAppUpdateWithSecretInput","type":"object","$defs":{"OAuthAppOwner":{"additionalProperties":false,"properties":{"type":{"description":"The workspace, or the connection the app is bound to.","enum":["workspace","connection"],"title":"Type","type":"string"},"id":{"maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["type","id"],"title":"OAuthAppOwner","type":"object"}}}',
|
|
965
|
+
resultKind: "inline",
|
|
966
|
+
},
|
|
967
|
+
],
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
action: "zo.schedule.create",
|
|
971
|
+
path: ["schedule", "create"],
|
|
972
|
+
versions: [
|
|
973
|
+
{
|
|
974
|
+
version: 1,
|
|
975
|
+
description: "Create a schedule.",
|
|
976
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"rrule":{"maxLength":1000,"minLength":1,"title":"Rrule","type":"string"},"start_at":{"title":"Start At","type":"string"},"timezone":{"title":"Timezone","type":"string"},"data":{"additionalProperties":{"x-zo-json-value":true},"default":{},"title":"Data","type":"object"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","display_name","rrule","start_at","timezone"],"title":"ScheduleCreateInput","type":"object"}',
|
|
977
|
+
resultKind: "inline",
|
|
978
|
+
},
|
|
979
|
+
],
|
|
980
|
+
},
|
|
981
|
+
{
|
|
982
|
+
action: "zo.schedule.delete",
|
|
983
|
+
path: ["schedule", "delete"],
|
|
984
|
+
versions: [
|
|
985
|
+
{
|
|
986
|
+
version: 1,
|
|
987
|
+
description: "Delete a schedule.",
|
|
988
|
+
inputJson: '{"additionalProperties":false,"properties":{"schedule_id":{"maxLength":200,"minLength":1,"title":"Schedule Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["schedule_id","expected_revision"],"title":"ScheduleDeleteInput","type":"object"}',
|
|
989
|
+
resultKind: "inline",
|
|
990
|
+
},
|
|
991
|
+
],
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
action: "zo.schedule.get",
|
|
995
|
+
path: ["schedule", "get"],
|
|
996
|
+
versions: [
|
|
997
|
+
{
|
|
998
|
+
version: 1,
|
|
999
|
+
description: "Get a schedule.",
|
|
1000
|
+
inputJson: '{"additionalProperties":false,"properties":{"schedule_id":{"maxLength":200,"minLength":1,"title":"Schedule Id","type":"string"}},"required":["schedule_id"],"title":"ScheduleGetInput","type":"object"}',
|
|
1001
|
+
resultKind: "inline",
|
|
1002
|
+
},
|
|
1003
|
+
],
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
action: "zo.schedule.list",
|
|
1007
|
+
path: ["schedule", "list"],
|
|
1008
|
+
versions: [
|
|
1009
|
+
{
|
|
1010
|
+
version: 1,
|
|
1011
|
+
description: "List a schedule.",
|
|
1012
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"ScheduleListInput","type":"object"}',
|
|
1013
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 50; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"}},"required":[]}',
|
|
1014
|
+
resultKind: "inline",
|
|
1015
|
+
},
|
|
1016
|
+
],
|
|
1017
|
+
},
|
|
1018
|
+
{
|
|
1019
|
+
action: "zo.schedule.update",
|
|
1020
|
+
path: ["schedule", "update"],
|
|
1021
|
+
versions: [
|
|
1022
|
+
{
|
|
1023
|
+
version: 1,
|
|
1024
|
+
description: "Update a schedule.",
|
|
1025
|
+
inputJson: '{"additionalProperties":false,"properties":{"schedule_id":{"maxLength":200,"minLength":1,"title":"Schedule Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"rrule":{"maxLength":1000,"minLength":1,"title":"Rrule","type":"string"},"start_at":{"title":"Start At","type":"string"},"timezone":{"title":"Timezone","type":"string"},"data":{"additionalProperties":{"x-zo-json-value":true},"title":"Data","type":"object"},"lifecycle":{"enum":["active","paused"],"title":"Lifecycle","type":"string"}},"required":["schedule_id","expected_revision","display_name","rrule","start_at","timezone","data","lifecycle"],"title":"ScheduleUpdateInput","type":"object"}',
|
|
1026
|
+
resultKind: "inline",
|
|
1027
|
+
},
|
|
1028
|
+
],
|
|
1029
|
+
},
|
|
1030
|
+
{
|
|
1031
|
+
action: "zo.source.complete",
|
|
1032
|
+
path: ["source", "complete"],
|
|
1033
|
+
versions: [
|
|
1034
|
+
{
|
|
1035
|
+
version: 1,
|
|
1036
|
+
description: "Complete a source upload with its verified digest and size.",
|
|
1037
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"source_id":{"title":"Source Id","type":"string"},"digest":{"pattern":"^[0-9a-f]{64}$","title":"Digest","type":"string"},"size_bytes":{"maximum":104857600,"minimum":0,"title":"Size Bytes","type":"integer"}},"required":["workspace_id","source_id","digest","size_bytes"],"title":"SourceCompleteInput","type":"object"}',
|
|
1038
|
+
resultKind: "inline",
|
|
1039
|
+
},
|
|
1040
|
+
],
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
action: "zo.source.create",
|
|
1044
|
+
path: ["source", "create"],
|
|
1045
|
+
versions: [
|
|
1046
|
+
{
|
|
1047
|
+
version: 1,
|
|
1048
|
+
description: "Create a source upload record in a workspace.",
|
|
1049
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id"],"title":"SourceCreateInput","type":"object"}',
|
|
1050
|
+
resultKind: "inline",
|
|
1051
|
+
},
|
|
1052
|
+
],
|
|
1053
|
+
},
|
|
1054
|
+
{
|
|
1055
|
+
action: "zo.source.get",
|
|
1056
|
+
path: ["source", "get"],
|
|
1057
|
+
versions: [
|
|
1058
|
+
{
|
|
1059
|
+
version: 1,
|
|
1060
|
+
description: "Get the status of a source upload.",
|
|
1061
|
+
inputJson: '{"additionalProperties":false,"properties":{"source_id":{"title":"Source Id","type":"string"}},"required":["source_id"],"title":"SourceGetInput","type":"object"}',
|
|
1062
|
+
resultKind: "inline",
|
|
1063
|
+
},
|
|
1064
|
+
],
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
action: "zo.subscription.create",
|
|
1068
|
+
path: ["subscription", "create"],
|
|
1069
|
+
versions: [
|
|
1070
|
+
{
|
|
1071
|
+
version: 1,
|
|
1072
|
+
description: "Bind an event definition to a function entrypoint run as a non-human execution principal.",
|
|
1073
|
+
inputJson: '{"additionalProperties":false,"description":"Bind an event definition to a handler: ``handler_resource_type`` and\\n``handler_resource_id`` name the target, ``handler_entrypoint`` one of its\\ndeployed entrypoints, ``input_contract_version`` and ``input_contract_kind``\\nthe input contract it declares, and ``execution_principal_id`` the service\\naccount the handler runs as. Omit ``filter`` to receive every occurrence.","properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"event_id":{"title":"Event Id","type":"string"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"filter":{"anyOf":[{"discriminator":{"mapping":{"all":"#/$defs/All1","any":"#/$defs/Any1","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All1"},{"$ref":"#/$defs/Any1"}]},{"type":"null"}],"default":null,"title":"Filter"},"handler_resource_type":{"const":"function","title":"Handler Resource Type","type":"string"},"handler_resource_id":{"title":"Handler Resource Id","type":"string"},"handler_entrypoint":{"maxLength":200,"minLength":1,"title":"Handler Entrypoint","type":"string"},"input_contract_version":{"exclusiveMinimum":0,"maximum":2147483647,"title":"Input Contract Version","type":"integer"},"input_contract_kind":{"$ref":"#/$defs/InputContractKind"},"execution_principal_id":{"title":"Execution Principal Id","type":"string"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","event_id","display_name","handler_resource_type","handler_resource_id","handler_entrypoint","input_contract_version","input_contract_kind","execution_principal_id"],"title":"SubscriptionCreateInput","type":"object","$defs":{"All1":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All2","any":"#/$defs/Any2","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All2"},{"$ref":"#/$defs/Any2"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All1","type":"object"},"All2":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All3","any":"#/$defs/Any3","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All3"},{"$ref":"#/$defs/Any3"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All2","type":"object"},"All3":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All3","type":"object"},"Any1":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All2","any":"#/$defs/Any2","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All2"},{"$ref":"#/$defs/Any2"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any1","type":"object"},"Any2":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All3","any":"#/$defs/Any3","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All3"},{"$ref":"#/$defs/Any3"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any2","type":"object"},"Any3":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any3","type":"object"},"EqFilter":{"additionalProperties":false,"properties":{"op":{"const":"eq","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"},"value":{"x-zo-json-value":true}},"required":["op","path","value"],"title":"EqFilter","type":"object"},"ExistsFilter":{"additionalProperties":false,"properties":{"op":{"const":"exists","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"}},"required":["op","path"],"title":"ExistsFilter","type":"object"},"InFilter":{"additionalProperties":false,"properties":{"op":{"const":"in","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"},"values":{"items":{"x-zo-json-value":true},"maxItems":32,"minItems":1,"title":"Values","type":"array"}},"required":["op","path","values"],"title":"InFilter","type":"object"},"InputContractKind":{"enum":["exact_event","generic_envelope"],"type":"string"}}}',
|
|
1074
|
+
resultKind: "inline",
|
|
1075
|
+
},
|
|
1076
|
+
{
|
|
1077
|
+
version: 2,
|
|
1078
|
+
description: "Bind an event definition to a function entrypoint or a workflow's start run as a non-human execution principal, or to an Agent whose sessions receive each occurrence.",
|
|
1079
|
+
inputJson: '{"additionalProperties":false,"description":"Bind an event definition to a handler. ``handler_resource_type`` is\\n``function``, ``workflow`` or ``agent``. A Function target names\\n``handler_resource_id``, ``handler_entrypoint``, ``input_contract_version``,\\n``input_contract_kind`` and the ``execution_principal_id`` service account it\\nruns as. A workflow target names ``workflow_id`` and the same fields but\\n``handler_resource_id``: ``handler_entrypoint`` is ``start``, which begins a\\nnew run per occurrence with the envelope as its ``event`` input, and\\n``input_contract_version`` is 1, the contract of that input. An Agent\\ntarget names ``agent_id``, the ``agent_priority`` an occurrence enters a turn\\nwith (``queue``, ``steer`` or ``interrupt``), the ``agent_session_policy``\\nthat picks its session (``new``; ``fixed``, with ``agent_session_id``; or\\n``per_conversation``, for an event with a ``conversation_path``, keyed in\\n``agent_session_scope``, the event\'s ``<publisher>/<name>`` when omitted)\\nand optional ``agent_instructions`` shown with every occurrence. Fields of\\nthe other handler type are refused. Omit ``filter`` to receive every\\noccurrence.","properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"event_id":{"title":"Event Id","type":"string"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"filter":{"anyOf":[{"discriminator":{"mapping":{"all":"#/$defs/All1","any":"#/$defs/Any1","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All1"},{"$ref":"#/$defs/Any1"}]},{"type":"null"}],"default":null,"title":"Filter"},"handler_resource_type":{"enum":["function","workflow","agent"],"title":"Handler Resource Type","type":"string"},"handler_resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Handler Resource Id"},"workflow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Workflow Id"},"handler_entrypoint":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Handler Entrypoint"},"input_contract_version":{"anyOf":[{"exclusiveMinimum":0,"maximum":2147483647,"type":"integer"},{"type":"null"}],"default":null,"title":"Input Contract Version"},"input_contract_kind":{"anyOf":[{"$ref":"#/$defs/InputContractKind"},{"type":"null"}],"default":null},"execution_principal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Execution Principal Id"},"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Agent Id"},"agent_priority":{"default":"queue","enum":["queue","steer","interrupt"],"title":"Agent Priority","type":"string"},"agent_session_policy":{"default":"new","enum":["new","fixed","per_conversation"],"title":"Agent Session Policy","type":"string"},"agent_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Agent Session Id"},"agent_session_scope":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Agent Session Scope"},"agent_instructions":{"anyOf":[{"maxLength":4096,"type":"string"},{"type":"null"}],"default":null,"title":"Agent Instructions"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","event_id","display_name","handler_resource_type"],"title":"SubscriptionCreateInputV2","type":"object","$defs":{"All1":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All2","any":"#/$defs/Any2","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All2"},{"$ref":"#/$defs/Any2"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All1","type":"object"},"All2":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All3","any":"#/$defs/Any3","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All3"},{"$ref":"#/$defs/Any3"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All2","type":"object"},"All3":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All3","type":"object"},"Any1":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All2","any":"#/$defs/Any2","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All2"},{"$ref":"#/$defs/Any2"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any1","type":"object"},"Any2":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All3","any":"#/$defs/Any3","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All3"},{"$ref":"#/$defs/Any3"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any2","type":"object"},"Any3":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any3","type":"object"},"EqFilter":{"additionalProperties":false,"properties":{"op":{"const":"eq","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"},"value":{"x-zo-json-value":true}},"required":["op","path","value"],"title":"EqFilter","type":"object"},"ExistsFilter":{"additionalProperties":false,"properties":{"op":{"const":"exists","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"}},"required":["op","path"],"title":"ExistsFilter","type":"object"},"InFilter":{"additionalProperties":false,"properties":{"op":{"const":"in","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"},"values":{"items":{"x-zo-json-value":true},"maxItems":32,"minItems":1,"title":"Values","type":"array"}},"required":["op","path","values"],"title":"InFilter","type":"object"},"InputContractKind":{"enum":["exact_event","generic_envelope"],"type":"string"}}}',
|
|
1080
|
+
resultKind: "inline",
|
|
1081
|
+
},
|
|
1082
|
+
],
|
|
1083
|
+
},
|
|
1084
|
+
{
|
|
1085
|
+
action: "zo.subscription.delete",
|
|
1086
|
+
path: ["subscription", "delete"],
|
|
1087
|
+
versions: [
|
|
1088
|
+
{
|
|
1089
|
+
version: 1,
|
|
1090
|
+
description: "Retire a subscription at the expected revision.",
|
|
1091
|
+
inputJson: '{"additionalProperties":false,"properties":{"subscription_id":{"title":"Subscription Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["subscription_id","expected_revision"],"title":"SubscriptionDeleteInput","type":"object"}',
|
|
1092
|
+
resultKind: "inline",
|
|
1093
|
+
},
|
|
1094
|
+
],
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
action: "zo.subscription.get",
|
|
1098
|
+
path: ["subscription", "get"],
|
|
1099
|
+
versions: [
|
|
1100
|
+
{
|
|
1101
|
+
version: 1,
|
|
1102
|
+
description: "Inspect a subscription, its disposition counts and its most recent dispositions.",
|
|
1103
|
+
inputJson: '{"additionalProperties":false,"properties":{"subscription_id":{"title":"Subscription Id","type":"string"}},"required":["subscription_id"],"title":"SubscriptionGetInput","type":"object"}',
|
|
1104
|
+
resultKind: "inline",
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
version: 2,
|
|
1108
|
+
description: "Inspect a subscription, its disposition counts and its most recent dispositions.",
|
|
1109
|
+
inputJson: '{"additionalProperties":false,"properties":{"subscription_id":{"title":"Subscription Id","type":"string"}},"required":["subscription_id"],"title":"SubscriptionGetInput","type":"object"}',
|
|
1110
|
+
resultKind: "inline",
|
|
1111
|
+
},
|
|
1112
|
+
],
|
|
1113
|
+
},
|
|
1114
|
+
{
|
|
1115
|
+
action: "zo.subscription.list",
|
|
1116
|
+
path: ["subscription", "list"],
|
|
1117
|
+
versions: [
|
|
1118
|
+
{
|
|
1119
|
+
version: 1,
|
|
1120
|
+
description: "List subscriptions accessible to the caller in a workspace, optionally for one event definition.",
|
|
1121
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"SubscriptionListInput","type":"object"}',
|
|
1122
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":7,"description":"Rows per page, at most 7; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"filter":{"additionalProperties":false,"properties":{"event_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Only subscriptions to this event definition.","title":"Event Id"},"handler":{"anyOf":[{"$ref":"#/$defs/SubscriptionHandlerRef"},{"type":"null"}],"default":null,"description":"Only subscriptions whose handler is this resource: its handler_resource_type and handler_resource_id, such as an Agent."}},"type":"object","required":[],"default":{}}},"required":[],"$defs":{"SubscriptionHandlerRef":{"additionalProperties":false,"properties":{"type":{"enum":["function","workflow","agent"],"title":"Type","type":"string"},"id":{"maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["type","id"],"title":"SubscriptionHandlerRef","type":"object"}}}',
|
|
1123
|
+
resultKind: "inline",
|
|
1124
|
+
},
|
|
1125
|
+
{
|
|
1126
|
+
version: 2,
|
|
1127
|
+
description: "List subscriptions accessible to the caller in a workspace, optionally for one event definition.",
|
|
1128
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"SubscriptionListInput","type":"object"}',
|
|
1129
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":7,"description":"Rows per page, at most 7; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"filter":{"additionalProperties":false,"properties":{"event_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Only subscriptions to this event definition.","title":"Event Id"},"handler":{"anyOf":[{"$ref":"#/$defs/SubscriptionHandlerRef"},{"type":"null"}],"default":null,"description":"Only subscriptions whose handler is this resource: its handler_resource_type and handler_resource_id, such as an Agent."}},"type":"object","required":[],"default":{}}},"required":[],"$defs":{"SubscriptionHandlerRef":{"additionalProperties":false,"properties":{"type":{"enum":["function","workflow","agent"],"title":"Type","type":"string"},"id":{"maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["type","id"],"title":"SubscriptionHandlerRef","type":"object"}}}',
|
|
1130
|
+
resultKind: "inline",
|
|
1131
|
+
},
|
|
1132
|
+
],
|
|
1133
|
+
},
|
|
1134
|
+
{
|
|
1135
|
+
action: "zo.subscription.update",
|
|
1136
|
+
path: ["subscription", "update"],
|
|
1137
|
+
versions: [
|
|
1138
|
+
{
|
|
1139
|
+
version: 1,
|
|
1140
|
+
description: "Replace a subscription's configuration and lifecycle at the expected revision.",
|
|
1141
|
+
inputJson: '{"additionalProperties":false,"description":"Full replacement of every create field but the workspace and the event (a new\\ndefinition or version is a new subscription), plus ``lifecycle``: ``active``\\nresumes a paused or suspended subscription, ``paused`` pauses it;\\n``zo.subscription.delete`` retires.","properties":{"subscription_id":{"title":"Subscription Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"filter":{"anyOf":[{"discriminator":{"mapping":{"all":"#/$defs/All1","any":"#/$defs/Any1","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All1"},{"$ref":"#/$defs/Any1"}]},{"type":"null"}],"default":null,"title":"Filter"},"handler_resource_type":{"const":"function","title":"Handler Resource Type","type":"string"},"handler_resource_id":{"title":"Handler Resource Id","type":"string"},"handler_entrypoint":{"maxLength":200,"minLength":1,"title":"Handler Entrypoint","type":"string"},"input_contract_version":{"exclusiveMinimum":0,"maximum":2147483647,"title":"Input Contract Version","type":"integer"},"input_contract_kind":{"$ref":"#/$defs/InputContractKind"},"execution_principal_id":{"title":"Execution Principal Id","type":"string"},"lifecycle":{"enum":["active","paused"],"title":"Lifecycle","type":"string"}},"required":["subscription_id","expected_revision","display_name","handler_resource_type","handler_resource_id","handler_entrypoint","input_contract_version","input_contract_kind","execution_principal_id","lifecycle"],"title":"SubscriptionUpdateInput","type":"object","$defs":{"All1":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All2","any":"#/$defs/Any2","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All2"},{"$ref":"#/$defs/Any2"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All1","type":"object"},"All2":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All3","any":"#/$defs/Any3","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All3"},{"$ref":"#/$defs/Any3"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All2","type":"object"},"All3":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All3","type":"object"},"Any1":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All2","any":"#/$defs/Any2","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All2"},{"$ref":"#/$defs/Any2"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any1","type":"object"},"Any2":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All3","any":"#/$defs/Any3","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All3"},{"$ref":"#/$defs/Any3"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any2","type":"object"},"Any3":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any3","type":"object"},"EqFilter":{"additionalProperties":false,"properties":{"op":{"const":"eq","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"},"value":{"x-zo-json-value":true}},"required":["op","path","value"],"title":"EqFilter","type":"object"},"ExistsFilter":{"additionalProperties":false,"properties":{"op":{"const":"exists","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"}},"required":["op","path"],"title":"ExistsFilter","type":"object"},"InFilter":{"additionalProperties":false,"properties":{"op":{"const":"in","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"},"values":{"items":{"x-zo-json-value":true},"maxItems":32,"minItems":1,"title":"Values","type":"array"}},"required":["op","path","values"],"title":"InFilter","type":"object"},"InputContractKind":{"enum":["exact_event","generic_envelope"],"type":"string"}}}',
|
|
1142
|
+
resultKind: "inline",
|
|
1143
|
+
},
|
|
1144
|
+
{
|
|
1145
|
+
version: 2,
|
|
1146
|
+
description: "Replace a subscription's configuration and lifecycle at the expected revision.",
|
|
1147
|
+
inputJson: '{"additionalProperties":false,"description":"Full replacement of every create field but the workspace and the event (a new\\ndefinition or version is a new subscription), plus ``lifecycle``: ``active``\\nresumes a paused or suspended subscription, ``paused`` pauses it;\\n``zo.subscription.delete`` retires. ``handler_resource_type`` must be the\\nsubscription\'s own: a different handler type is a new subscription.","properties":{"subscription_id":{"title":"Subscription Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"filter":{"anyOf":[{"discriminator":{"mapping":{"all":"#/$defs/All1","any":"#/$defs/Any1","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All1"},{"$ref":"#/$defs/Any1"}]},{"type":"null"}],"default":null,"title":"Filter"},"handler_resource_type":{"enum":["function","workflow","agent"],"title":"Handler Resource Type","type":"string"},"handler_resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Handler Resource Id"},"workflow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Workflow Id"},"handler_entrypoint":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Handler Entrypoint"},"input_contract_version":{"anyOf":[{"exclusiveMinimum":0,"maximum":2147483647,"type":"integer"},{"type":"null"}],"default":null,"title":"Input Contract Version"},"input_contract_kind":{"anyOf":[{"$ref":"#/$defs/InputContractKind"},{"type":"null"}],"default":null},"execution_principal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Execution Principal Id"},"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Agent Id"},"agent_priority":{"default":"queue","enum":["queue","steer","interrupt"],"title":"Agent Priority","type":"string"},"agent_session_policy":{"default":"new","enum":["new","fixed","per_conversation"],"title":"Agent Session Policy","type":"string"},"agent_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Agent Session Id"},"agent_session_scope":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Agent Session Scope"},"agent_instructions":{"anyOf":[{"maxLength":4096,"type":"string"},{"type":"null"}],"default":null,"title":"Agent Instructions"},"lifecycle":{"enum":["active","paused"],"title":"Lifecycle","type":"string"}},"required":["subscription_id","expected_revision","display_name","handler_resource_type","lifecycle"],"title":"SubscriptionUpdateInputV2","type":"object","$defs":{"All1":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All2","any":"#/$defs/Any2","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All2"},{"$ref":"#/$defs/Any2"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All1","type":"object"},"All2":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All3","any":"#/$defs/Any3","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All3"},{"$ref":"#/$defs/Any3"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All2","type":"object"},"All3":{"additionalProperties":false,"properties":{"op":{"const":"all","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"All3","type":"object"},"Any1":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All2","any":"#/$defs/Any2","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All2"},{"$ref":"#/$defs/Any2"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any1","type":"object"},"Any2":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"all":"#/$defs/All3","any":"#/$defs/Any3","eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"},{"$ref":"#/$defs/All3"},{"$ref":"#/$defs/Any3"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any2","type":"object"},"Any3":{"additionalProperties":false,"properties":{"op":{"const":"any","title":"Op","type":"string"},"filters":{"items":{"discriminator":{"mapping":{"eq":"#/$defs/EqFilter","exists":"#/$defs/ExistsFilter","in":"#/$defs/InFilter"},"propertyName":"op"},"oneOf":[{"$ref":"#/$defs/EqFilter"},{"$ref":"#/$defs/InFilter"},{"$ref":"#/$defs/ExistsFilter"}]},"maxItems":32,"minItems":1,"title":"Filters","type":"array"}},"required":["op","filters"],"title":"Any3","type":"object"},"EqFilter":{"additionalProperties":false,"properties":{"op":{"const":"eq","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"},"value":{"x-zo-json-value":true}},"required":["op","path","value"],"title":"EqFilter","type":"object"},"ExistsFilter":{"additionalProperties":false,"properties":{"op":{"const":"exists","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"}},"required":["op","path"],"title":"ExistsFilter","type":"object"},"InFilter":{"additionalProperties":false,"properties":{"op":{"const":"in","title":"Op","type":"string"},"path":{"maxLength":256,"minLength":1,"pattern":"^(?:/[^/]*)+$","title":"Path","type":"string"},"values":{"items":{"x-zo-json-value":true},"maxItems":32,"minItems":1,"title":"Values","type":"array"}},"required":["op","path","values"],"title":"InFilter","type":"object"},"InputContractKind":{"enum":["exact_event","generic_envelope"],"type":"string"}}}',
|
|
1148
|
+
resultKind: "inline",
|
|
1149
|
+
},
|
|
1150
|
+
],
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
action: "zo.tag.assign",
|
|
1154
|
+
path: ["tag", "assign"],
|
|
1155
|
+
versions: [
|
|
1156
|
+
{
|
|
1157
|
+
version: 1,
|
|
1158
|
+
description: "Add tags to one object: task, agent, schedule, website, connection, event, event_subscription, machine, database or file (target.kind). A tag that does not exist yet is created; one the object already carries is kept. You need permission to change the object. Returns the object's current tags.",
|
|
1159
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"target":{"$ref":"#/$defs/TargetRef"},"tags":{"description":"Tags by ID or name.","items":{"description":"A tag\'s tag_ ID or its name; a name matches ignoring case and surrounding whitespace.","maxLength":256,"minLength":1,"type":"string"},"maxItems":100,"minItems":1,"title":"Tags","type":"array"}},"required":["workspace_id","target","tags"],"title":"TagAssignInput","type":"object","$defs":{"TargetRef":{"additionalProperties":false,"properties":{"kind":{"description":"The object\'s kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.","maxLength":64,"minLength":1,"title":"Kind","type":"string"},"id":{"description":"The object\'s ID as its own actions name it: a task\'s number (\\"42\\" or \\"#42\\") or tsk_ ID, a file\'s kb_fil_ ID, or the resource ID.","maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["kind","id"],"title":"TargetRef","type":"object"}}}',
|
|
1160
|
+
resultKind: "inline",
|
|
1161
|
+
},
|
|
1162
|
+
],
|
|
1163
|
+
},
|
|
1164
|
+
{
|
|
1165
|
+
action: "zo.tag.delete",
|
|
1166
|
+
path: ["tag", "delete"],
|
|
1167
|
+
versions: [
|
|
1168
|
+
{
|
|
1169
|
+
version: 1,
|
|
1170
|
+
description: "Delete a tag and remove it from every object that carries it.",
|
|
1171
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"tag":{"description":"A tag\'s tag_ ID or its name; a name matches ignoring case and surrounding whitespace.","maxLength":256,"minLength":1,"title":"Tag","type":"string"}},"required":["workspace_id","tag"],"title":"TagDeleteInput","type":"object"}',
|
|
1172
|
+
resultKind: "inline",
|
|
1173
|
+
},
|
|
1174
|
+
],
|
|
1175
|
+
},
|
|
1176
|
+
{
|
|
1177
|
+
action: "zo.tag.items",
|
|
1178
|
+
path: ["tag", "items"],
|
|
1179
|
+
versions: [
|
|
1180
|
+
{
|
|
1181
|
+
version: 1,
|
|
1182
|
+
description: "List the objects carrying a tag, newest assignment first, across every supported kind or only the kinds named in options.query.filter. Shows only objects you may read; a page may be short and still have a next_cursor.",
|
|
1183
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"tag":{"description":"A tag\'s tag_ ID or its name; a name matches ignoring case and surrounding whitespace.","maxLength":256,"minLength":1,"title":"Tag","type":"string"}},"required":["workspace_id","tag"],"title":"TagItemsInput","type":"object"}',
|
|
1184
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"filter":{"additionalProperties":false,"properties":{"kinds":{"anyOf":[{"items":{"maxLength":64,"minLength":1,"type":"string"},"maxItems":16,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"Only objects of these kinds (task, agent, schedule, website, connection, event, event_subscription, machine, database or file).","title":"Kinds"}},"type":"object","required":[],"default":{}}},"required":[]}',
|
|
1185
|
+
resultKind: "inline",
|
|
1186
|
+
},
|
|
1187
|
+
],
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
action: "zo.tag.list",
|
|
1191
|
+
path: ["tag", "list"],
|
|
1192
|
+
versions: [
|
|
1193
|
+
{
|
|
1194
|
+
version: 1,
|
|
1195
|
+
description: "List the workspace's tags alphabetically. Tags are words shared across the workspace, created the first time someone assigns them. Pass search in options.query to find tags by prefix; bug finds Bug.",
|
|
1196
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"TagListInput","type":"object"}',
|
|
1197
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"search":{"type":"string","minLength":1,"maxLength":200,"description":"Case-insensitive text matched against normalized_name."}},"required":[]}',
|
|
1198
|
+
resultKind: "inline",
|
|
1199
|
+
},
|
|
1200
|
+
],
|
|
1201
|
+
},
|
|
1202
|
+
{
|
|
1203
|
+
action: "zo.tag.of",
|
|
1204
|
+
path: ["tag", "of"],
|
|
1205
|
+
versions: [
|
|
1206
|
+
{
|
|
1207
|
+
version: 1,
|
|
1208
|
+
description: "Read the tags of up to 200 objects in one call, of any kinds together: task, agent, schedule, website, connection, event, event_subscription, machine, database or file. Answers in request order for the objects you may read; an object that does not exist or that you cannot read is left out.",
|
|
1209
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"targets":{"description":"Up to 200 objects of any supported kinds; a repeated object counts once.","items":{"$ref":"#/$defs/TargetRef"},"maxItems":200,"minItems":1,"title":"Targets","type":"array"}},"required":["workspace_id","targets"],"title":"TagOfInput","type":"object","$defs":{"TargetRef":{"additionalProperties":false,"properties":{"kind":{"description":"The object\'s kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.","maxLength":64,"minLength":1,"title":"Kind","type":"string"},"id":{"description":"The object\'s ID as its own actions name it: a task\'s number (\\"42\\" or \\"#42\\") or tsk_ ID, a file\'s kb_fil_ ID, or the resource ID.","maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["kind","id"],"title":"TargetRef","type":"object"}}}',
|
|
1210
|
+
resultKind: "inline",
|
|
1211
|
+
},
|
|
1212
|
+
],
|
|
1213
|
+
},
|
|
1214
|
+
{
|
|
1215
|
+
action: "zo.tag.rename",
|
|
1216
|
+
path: ["tag", "rename"],
|
|
1217
|
+
versions: [
|
|
1218
|
+
{
|
|
1219
|
+
version: 1,
|
|
1220
|
+
description: "Change a tag's name everywhere it is used. Refused with conflict (tag_exists) when another tag already has that name, ignoring case.",
|
|
1221
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"tag":{"description":"A tag\'s tag_ ID or its name; a name matches ignoring case and surrounding whitespace.","maxLength":256,"minLength":1,"title":"Tag","type":"string"},"name":{"description":"The tag\'s name: 1 to 64 characters.","maxLength":256,"minLength":1,"title":"Name","type":"string"}},"required":["workspace_id","tag","name"],"title":"TagRenameInput","type":"object"}',
|
|
1222
|
+
resultKind: "inline",
|
|
1223
|
+
},
|
|
1224
|
+
],
|
|
1225
|
+
},
|
|
1226
|
+
{
|
|
1227
|
+
action: "zo.tag.unassign",
|
|
1228
|
+
path: ["tag", "unassign"],
|
|
1229
|
+
versions: [
|
|
1230
|
+
{
|
|
1231
|
+
version: 1,
|
|
1232
|
+
description: "Remove tags from one object. A tag the object does not carry, or that does not exist, changes nothing. You need permission to change the object. Returns the object's current tags.",
|
|
1233
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"target":{"$ref":"#/$defs/TargetRef"},"tags":{"description":"Tags by ID or name.","items":{"description":"A tag\'s tag_ ID or its name; a name matches ignoring case and surrounding whitespace.","maxLength":256,"minLength":1,"type":"string"},"maxItems":100,"minItems":1,"title":"Tags","type":"array"}},"required":["workspace_id","target","tags"],"title":"TagUnassignInput","type":"object","$defs":{"TargetRef":{"additionalProperties":false,"properties":{"kind":{"description":"The object\'s kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.","maxLength":64,"minLength":1,"title":"Kind","type":"string"},"id":{"description":"The object\'s ID as its own actions name it: a task\'s number (\\"42\\" or \\"#42\\") or tsk_ ID, a file\'s kb_fil_ ID, or the resource ID.","maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["kind","id"],"title":"TargetRef","type":"object"}}}',
|
|
1234
|
+
resultKind: "inline",
|
|
1235
|
+
},
|
|
1236
|
+
],
|
|
1237
|
+
},
|
|
1238
|
+
{
|
|
1239
|
+
action: "zo.task.blocker.add",
|
|
1240
|
+
path: ["task", "blocker", "add"],
|
|
1241
|
+
versions: [
|
|
1242
|
+
{
|
|
1243
|
+
version: 1,
|
|
1244
|
+
description: "Mark a task as waiting on another task. A task stays blocked until every blocker is done or cancelled.",
|
|
1245
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"},"blocked_by":{"description":"The task this one waits on.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Blocked By","type":"string"}},"required":["workspace_id","task","blocked_by"],"title":"TaskBlockerInput","type":"object"}',
|
|
1246
|
+
resultKind: "inline",
|
|
1247
|
+
},
|
|
1248
|
+
],
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
action: "zo.task.blocker.remove",
|
|
1252
|
+
path: ["task", "blocker", "remove"],
|
|
1253
|
+
versions: [
|
|
1254
|
+
{
|
|
1255
|
+
version: 1,
|
|
1256
|
+
description: "Stop a task waiting on another task.",
|
|
1257
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"},"blocked_by":{"description":"The task this one waits on.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Blocked By","type":"string"}},"required":["workspace_id","task","blocked_by"],"title":"TaskBlockerInput","type":"object"}',
|
|
1258
|
+
resultKind: "inline",
|
|
1259
|
+
},
|
|
1260
|
+
],
|
|
1261
|
+
},
|
|
1262
|
+
{
|
|
1263
|
+
action: "zo.task.comment.create",
|
|
1264
|
+
path: ["task", "comment", "create"],
|
|
1265
|
+
versions: [
|
|
1266
|
+
{
|
|
1267
|
+
version: 1,
|
|
1268
|
+
description: "Comment on a task in markdown.",
|
|
1269
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"},"body":{"maxLength":16384,"minLength":1,"title":"Body","type":"string"}},"required":["workspace_id","task","body"],"title":"TaskCommentCreateInput","type":"object"}',
|
|
1270
|
+
resultKind: "inline",
|
|
1271
|
+
},
|
|
1272
|
+
],
|
|
1273
|
+
},
|
|
1274
|
+
{
|
|
1275
|
+
action: "zo.task.comment.delete",
|
|
1276
|
+
path: ["task", "comment", "delete"],
|
|
1277
|
+
versions: [
|
|
1278
|
+
{
|
|
1279
|
+
version: 1,
|
|
1280
|
+
description: "Delete a comment from a task.",
|
|
1281
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"},"comment_id":{"pattern":"^tcm_[0-9A-Za-z]{16}$","title":"Comment Id","type":"string"}},"required":["workspace_id","task","comment_id"],"title":"TaskCommentDeleteInput","type":"object"}',
|
|
1282
|
+
resultKind: "inline",
|
|
1283
|
+
},
|
|
1284
|
+
],
|
|
1285
|
+
},
|
|
1286
|
+
{
|
|
1287
|
+
action: "zo.task.comment.list",
|
|
1288
|
+
path: ["task", "comment", "list"],
|
|
1289
|
+
versions: [
|
|
1290
|
+
{
|
|
1291
|
+
version: 1,
|
|
1292
|
+
description: "Page through a task's comments, newest first. Start from zo.task.get's comments_cursor.",
|
|
1293
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"}},"required":["workspace_id","task"],"title":"TaskCommentListInput","type":"object"}',
|
|
1294
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":20,"description":"Rows per page, at most 50; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
1295
|
+
resultKind: "inline",
|
|
1296
|
+
},
|
|
1297
|
+
],
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
action: "zo.task.comment.update",
|
|
1301
|
+
path: ["task", "comment", "update"],
|
|
1302
|
+
versions: [
|
|
1303
|
+
{
|
|
1304
|
+
version: 1,
|
|
1305
|
+
description: "Replace a comment's text. Records who edited it and when. Pass the comment's revision as expected_revision to refuse a change made since you read it. Comments Zo wrote can't be edited.",
|
|
1306
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"},"comment_id":{"pattern":"^tcm_[0-9A-Za-z]{16}$","title":"Comment Id","type":"string"},"body":{"maxLength":16384,"minLength":1,"title":"Body","type":"string"},"expected_revision":{"anyOf":[{"exclusiveMinimum":0,"maximum":9007199254740991,"type":"integer"},{"type":"null"}],"default":null,"description":"Refuse with conflict unless the comment is still at this revision.","title":"Expected Revision"}},"required":["workspace_id","task","comment_id","body"],"title":"TaskCommentUpdateInput","type":"object"}',
|
|
1307
|
+
resultKind: "inline",
|
|
1308
|
+
},
|
|
1309
|
+
],
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
action: "zo.task.create",
|
|
1313
|
+
path: ["task", "create"],
|
|
1314
|
+
versions: [
|
|
1315
|
+
{
|
|
1316
|
+
version: 1,
|
|
1317
|
+
description: "Create a task in the workspace, visible to everyone in it.",
|
|
1318
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"title":{"maxLength":200,"minLength":1,"title":"Title","type":"string"},"body":{"default":"","maxLength":65536,"title":"Body","type":"string"},"status":{"default":"backlog","enum":["backlog","ready","in_progress","failed","done","cancelled"],"title":"Status","type":"string"},"assignee":{"anyOf":[{"$ref":"#/$defs/PrincipalInput"},{"type":"null"}],"default":null},"parent":{"anyOf":[{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","type":"string"},{"type":"null"}],"default":null,"description":"Make it a subtask of a top-level task; subtasks can\'t have subtasks.","title":"Parent"}},"required":["workspace_id","title"],"title":"TaskCreateInput","type":"object","$defs":{"PrincipalInput":{"additionalProperties":false,"properties":{"type":{"enum":["user","agent","service_account"],"title":"Type","type":"string"},"id":{"maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["type","id"],"title":"PrincipalInput","type":"object"}}}',
|
|
1319
|
+
resultKind: "inline",
|
|
1320
|
+
},
|
|
1321
|
+
],
|
|
1322
|
+
},
|
|
1323
|
+
{
|
|
1324
|
+
action: "zo.task.delete",
|
|
1325
|
+
path: ["task", "delete"],
|
|
1326
|
+
versions: [
|
|
1327
|
+
{
|
|
1328
|
+
version: 1,
|
|
1329
|
+
description: "Delete a task with its comments and blocker links. Its subtasks become top-level tasks.",
|
|
1330
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"}},"required":["workspace_id","task"],"title":"TaskDeleteInput","type":"object"}',
|
|
1331
|
+
resultKind: "inline",
|
|
1332
|
+
},
|
|
1333
|
+
],
|
|
1334
|
+
},
|
|
1335
|
+
{
|
|
1336
|
+
action: "zo.task.get",
|
|
1337
|
+
path: ["task", "get"],
|
|
1338
|
+
versions: [
|
|
1339
|
+
{
|
|
1340
|
+
version: 1,
|
|
1341
|
+
description: 'Read a task by number ("42" or "#42") or ID: its body, assignee, parent, subtasks, blockers, what it blocks and its latest 20 comments.',
|
|
1342
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"}},"required":["workspace_id","task"],"title":"TaskGetInput","type":"object"}',
|
|
1343
|
+
resultKind: "inline",
|
|
1344
|
+
},
|
|
1345
|
+
],
|
|
1346
|
+
},
|
|
1347
|
+
{
|
|
1348
|
+
action: "zo.task.list",
|
|
1349
|
+
path: ["task", "list"],
|
|
1350
|
+
versions: [
|
|
1351
|
+
{
|
|
1352
|
+
version: 1,
|
|
1353
|
+
description: 'List the workspace\'s tasks, most recently updated first. Filter by status, assignee (principals or "unassigned"), parent and blocked state. Summaries carry no body or comments.',
|
|
1354
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"parent":{"anyOf":[{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","type":"string"},{"type":"null"}],"default":null,"description":"Only this task\'s subtasks.","title":"Parent"}},"required":["workspace_id"],"title":"TaskListInput","type":"object"}',
|
|
1355
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["updated_at.desc","number.asc"],"default":"updated_at.desc"},"filter":{"additionalProperties":false,"properties":{"status":{"anyOf":[{"items":{"enum":["backlog","ready","in_progress","failed","done","cancelled"],"type":"string"},"maxItems":6,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"Tasks in any of these statuses.","title":"Status"},"assignee":{"anyOf":[{"items":{"$ref":"#/$defs/AssigneeFilter"},"maxItems":32,"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"Tasks assigned to any of these; {\\"type\\": \\"unassigned\\"} matches tasks with no assignee.","title":"Assignee"},"is_blocked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Only blocked tasks, or only unblocked ones.","title":"Is Blocked"}},"type":"object","required":[],"default":{}}},"required":[],"$defs":{"AssigneeFilter":{"additionalProperties":false,"description":"A principal, or ``{\\"type\\": \\"unassigned\\"}`` for tasks with no assignee.","properties":{"type":{"enum":["user","agent","service_account","unassigned"],"title":"Type","type":"string"},"id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"The principal\'s ID; omitted for \\"unassigned\\".","title":"Id"}},"required":["type"],"title":"AssigneeFilter","type":"object"}}}',
|
|
1356
|
+
resultKind: "inline",
|
|
1357
|
+
},
|
|
1358
|
+
],
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
action: "zo.task.update",
|
|
1362
|
+
path: ["task", "update"],
|
|
1363
|
+
versions: [
|
|
1364
|
+
{
|
|
1365
|
+
version: 1,
|
|
1366
|
+
description: "Change a task's title, body, status, assignee or parent. Pass expected_revision to refuse a change made since you read it.",
|
|
1367
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"task":{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","title":"Task","type":"string"},"title":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"body":{"anyOf":[{"maxLength":65536,"type":"string"},{"type":"null"}],"default":null,"title":"Body"},"status":{"anyOf":[{"enum":["backlog","ready","in_progress","failed","done","cancelled"],"type":"string"},{"type":"null"}],"default":null,"title":"Status"},"assignee":{"anyOf":[{"$ref":"#/$defs/PrincipalInput"},{"type":"null"}],"description":"The new assignee; null unassigns. Omit to leave it."},"parent":{"anyOf":[{"description":"The task\'s number (\\"42\\" or \\"#42\\") or its tsk_ ID.","pattern":"^(#?[1-9][0-9]{0,15}|tsk_[0-9A-Za-z]{16})$","type":"string"},{"type":"null"}],"description":"The new parent; null makes the task a root. Omit to leave it.","title":"Parent"},"expected_revision":{"anyOf":[{"exclusiveMinimum":0,"maximum":9007199254740991,"type":"integer"},{"type":"null"}],"default":null,"description":"Refuse with conflict unless the task is still at this revision.","title":"Expected Revision"}},"required":["workspace_id","task"],"title":"TaskUpdateInput","type":"object","$defs":{"PrincipalInput":{"additionalProperties":false,"properties":{"type":{"enum":["user","agent","service_account"],"title":"Type","type":"string"},"id":{"maxLength":200,"minLength":1,"title":"Id","type":"string"}},"required":["type","id"],"title":"PrincipalInput","type":"object"}}}',
|
|
1368
|
+
resultKind: "inline",
|
|
1369
|
+
},
|
|
1370
|
+
],
|
|
1371
|
+
},
|
|
1372
|
+
{
|
|
1373
|
+
action: "zo.vault.create",
|
|
1374
|
+
path: ["vault", "create"],
|
|
1375
|
+
versions: [
|
|
1376
|
+
{
|
|
1377
|
+
version: 1,
|
|
1378
|
+
description: "Store a pasted credential, such as an API key, with the hosts it may be sent to. The value is never returned.",
|
|
1379
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"display_name":{"maxLength":256,"minLength":1,"title":"Display Name","type":"string"},"description":{"default":"","maxLength":2000,"title":"Description","type":"string"},"value":{"description":"Secret: the credential. Stored sealed and never returned.","maxLength":16384,"minLength":1,"title":"Value","type":"string"},"environment_variable":{"anyOf":[{"pattern":"^[A-Z_][A-Z0-9_]{0,127}$","type":"string"},{"type":"null"}],"default":null,"description":"The environment variable name a machine gets the value under, such as `OPENAI_API_KEY`.","title":"Environment Variable"},"injections":{"default":[],"items":{"$ref":"#/$defs/VaultInjection"},"maxItems":10,"title":"Injections","type":"array"},"visibility":{"default":"workspace","description":"`workspace` (default): every member can use it. `protected`: only you, and whoever you share it with; workspace-wide grants don\'t reach it. Fixed at creation.","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","display_name","value"],"title":"VaultCreateInput","type":"object","$defs":{"BasicFormat":{"additionalProperties":false,"properties":{"type":{"const":"basic","description":"`Basic` with base64 of `<username>:<value>`.","title":"Type","type":"string"},"username":{"pattern":"^[^:]{1,256}$","title":"Username","type":"string"}},"required":["type","username"],"title":"BasicFormat","type":"object"},"BearerFormat":{"additionalProperties":false,"properties":{"type":{"const":"bearer","description":"`Bearer <value>`.","title":"Type","type":"string"}},"required":["type"],"title":"BearerFormat","type":"object"},"HeaderLocation":{"additionalProperties":false,"properties":{"type":{"const":"header","title":"Type","type":"string"},"name":{"description":"The header to set, such as `Authorization` or `X-API-Key`.","pattern":"^[A-Za-z0-9!#$%&\'*+.^_`|~-]{1,128}$","title":"Name","type":"string"}},"required":["type","name"],"title":"HeaderLocation","type":"object"},"RawFormat":{"additionalProperties":false,"properties":{"type":{"const":"raw","description":"The value as it is.","title":"Type","type":"string"}},"required":["type"],"title":"RawFormat","type":"object"},"VaultInjection":{"additionalProperties":false,"description":"Where and how the value is sent on requests to ``hosts``. A host appears\\nin at most one entry of a vault\'s list.","properties":{"hosts":{"items":{"description":"An exact lowercase DNS name, such as `api.openai.com`: no wildcard, port or path.","maxLength":253,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$","type":"string"},"maxItems":20,"minItems":1,"title":"Hosts","type":"array"},"location":{"$ref":"#/$defs/HeaderLocation"},"format":{"discriminator":{"mapping":{"basic":"#/$defs/BasicFormat","bearer":"#/$defs/BearerFormat","raw":"#/$defs/RawFormat"},"propertyName":"type"},"oneOf":[{"$ref":"#/$defs/BearerFormat"},{"$ref":"#/$defs/BasicFormat"},{"$ref":"#/$defs/RawFormat"}],"title":"Format"}},"required":["hosts","location","format"],"title":"VaultInjection","type":"object"}}}',
|
|
1380
|
+
resultKind: "inline",
|
|
1381
|
+
},
|
|
1382
|
+
],
|
|
1383
|
+
},
|
|
1384
|
+
{
|
|
1385
|
+
action: "zo.vault.delete",
|
|
1386
|
+
path: ["vault", "delete"],
|
|
1387
|
+
versions: [
|
|
1388
|
+
{
|
|
1389
|
+
version: 1,
|
|
1390
|
+
description: "Delete a vault: its value is destroyed and every grant on it is revoked.",
|
|
1391
|
+
inputJson: '{"additionalProperties":false,"properties":{"vault_id":{"maxLength":200,"minLength":1,"title":"Vault Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["vault_id","expected_revision"],"title":"VaultTargetInput","type":"object"}',
|
|
1392
|
+
resultKind: "inline",
|
|
1393
|
+
},
|
|
1394
|
+
],
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
action: "zo.vault.get",
|
|
1398
|
+
path: ["vault", "get"],
|
|
1399
|
+
versions: [
|
|
1400
|
+
{
|
|
1401
|
+
version: 1,
|
|
1402
|
+
description: "Read a vault's settings. The value is never returned.",
|
|
1403
|
+
inputJson: '{"additionalProperties":false,"properties":{"vault_id":{"maxLength":200,"minLength":1,"title":"Vault Id","type":"string"}},"required":["vault_id"],"title":"VaultGetInput","type":"object"}',
|
|
1404
|
+
resultKind: "inline",
|
|
1405
|
+
},
|
|
1406
|
+
],
|
|
1407
|
+
},
|
|
1408
|
+
{
|
|
1409
|
+
action: "zo.vault.list",
|
|
1410
|
+
path: ["vault", "list"],
|
|
1411
|
+
versions: [
|
|
1412
|
+
{
|
|
1413
|
+
version: 1,
|
|
1414
|
+
description: "List the vaults the caller can read in a workspace.",
|
|
1415
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"VaultListInput","type":"object"}',
|
|
1416
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 100; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"}},"required":[]}',
|
|
1417
|
+
resultKind: "inline",
|
|
1418
|
+
},
|
|
1419
|
+
],
|
|
1420
|
+
},
|
|
1421
|
+
{
|
|
1422
|
+
action: "zo.vault.rotate",
|
|
1423
|
+
path: ["vault", "rotate"],
|
|
1424
|
+
versions: [
|
|
1425
|
+
{
|
|
1426
|
+
version: 1,
|
|
1427
|
+
description: "Replace a vault's value. The previous value is destroyed.",
|
|
1428
|
+
inputJson: '{"additionalProperties":false,"properties":{"vault_id":{"maxLength":200,"minLength":1,"title":"Vault Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"value":{"description":"Secret: the credential. Stored sealed and never returned.","maxLength":16384,"minLength":1,"title":"Value","type":"string"}},"required":["vault_id","expected_revision","value"],"title":"VaultRotateInput","type":"object"}',
|
|
1429
|
+
resultKind: "inline",
|
|
1430
|
+
},
|
|
1431
|
+
],
|
|
1432
|
+
},
|
|
1433
|
+
{
|
|
1434
|
+
action: "zo.vault.update",
|
|
1435
|
+
path: ["vault", "update"],
|
|
1436
|
+
versions: [
|
|
1437
|
+
{
|
|
1438
|
+
version: 1,
|
|
1439
|
+
description: "Change a vault's name, description, environment variable or injections against its current revision.",
|
|
1440
|
+
inputJson: '{"additionalProperties":false,"description":"Omitted fields keep their value; ``injections`` replaces the whole list.","properties":{"vault_id":{"maxLength":200,"minLength":1,"title":"Vault Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"anyOf":[{"maxLength":256,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Display Name"},"description":{"anyOf":[{"maxLength":2000,"type":"string"},{"type":"null"}],"default":null,"description":"`\\"\\"` clears the description.","title":"Description"},"environment_variable":{"anyOf":[{"pattern":"^([A-Z_][A-Z0-9_]{0,127})?$","type":"string"},{"type":"null"}],"default":null,"description":"`\\"\\"` clears the variable.","title":"Environment Variable"},"injections":{"anyOf":[{"items":{"$ref":"#/$defs/VaultInjection"},"maxItems":10,"type":"array"},{"type":"null"}],"default":null,"title":"Injections"}},"required":["vault_id","expected_revision"],"title":"VaultUpdateInput","type":"object","$defs":{"BasicFormat":{"additionalProperties":false,"properties":{"type":{"const":"basic","description":"`Basic` with base64 of `<username>:<value>`.","title":"Type","type":"string"},"username":{"pattern":"^[^:]{1,256}$","title":"Username","type":"string"}},"required":["type","username"],"title":"BasicFormat","type":"object"},"BearerFormat":{"additionalProperties":false,"properties":{"type":{"const":"bearer","description":"`Bearer <value>`.","title":"Type","type":"string"}},"required":["type"],"title":"BearerFormat","type":"object"},"HeaderLocation":{"additionalProperties":false,"properties":{"type":{"const":"header","title":"Type","type":"string"},"name":{"description":"The header to set, such as `Authorization` or `X-API-Key`.","pattern":"^[A-Za-z0-9!#$%&\'*+.^_`|~-]{1,128}$","title":"Name","type":"string"}},"required":["type","name"],"title":"HeaderLocation","type":"object"},"RawFormat":{"additionalProperties":false,"properties":{"type":{"const":"raw","description":"The value as it is.","title":"Type","type":"string"}},"required":["type"],"title":"RawFormat","type":"object"},"VaultInjection":{"additionalProperties":false,"description":"Where and how the value is sent on requests to ``hosts``. A host appears\\nin at most one entry of a vault\'s list.","properties":{"hosts":{"items":{"description":"An exact lowercase DNS name, such as `api.openai.com`: no wildcard, port or path.","maxLength":253,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$","type":"string"},"maxItems":20,"minItems":1,"title":"Hosts","type":"array"},"location":{"$ref":"#/$defs/HeaderLocation"},"format":{"discriminator":{"mapping":{"basic":"#/$defs/BasicFormat","bearer":"#/$defs/BearerFormat","raw":"#/$defs/RawFormat"},"propertyName":"type"},"oneOf":[{"$ref":"#/$defs/BearerFormat"},{"$ref":"#/$defs/BasicFormat"},{"$ref":"#/$defs/RawFormat"}],"title":"Format"}},"required":["hosts","location","format"],"title":"VaultInjection","type":"object"}}}',
|
|
1441
|
+
resultKind: "inline",
|
|
1442
|
+
},
|
|
1443
|
+
],
|
|
1444
|
+
},
|
|
1445
|
+
{
|
|
1446
|
+
action: "zo.website.create",
|
|
1447
|
+
path: ["website", "create"],
|
|
1448
|
+
versions: [
|
|
1449
|
+
{
|
|
1450
|
+
version: 1,
|
|
1451
|
+
description: "Create a Website address in a workspace.",
|
|
1452
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"},"slug":{"pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$","title":"Slug","type":"string"},"display_name":{"maxLength":200,"minLength":1,"title":"Display Name","type":"string"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","slug","display_name"],"title":"WebsiteCreateInput","type":"object"}',
|
|
1453
|
+
resultKind: "inline",
|
|
1454
|
+
},
|
|
1455
|
+
],
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
action: "zo.website.delete",
|
|
1459
|
+
path: ["website", "delete"],
|
|
1460
|
+
versions: [
|
|
1461
|
+
{
|
|
1462
|
+
version: 1,
|
|
1463
|
+
description: "Delete a Website and retire its routes.",
|
|
1464
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["website_id","expected_revision"],"title":"WebsiteRevisionInput","type":"object"}',
|
|
1465
|
+
resultKind: "inline",
|
|
1466
|
+
},
|
|
1467
|
+
],
|
|
1468
|
+
},
|
|
1469
|
+
{
|
|
1470
|
+
action: "zo.website.get",
|
|
1471
|
+
path: ["website", "get"],
|
|
1472
|
+
versions: [
|
|
1473
|
+
{
|
|
1474
|
+
version: 1,
|
|
1475
|
+
description: "Read a Website and its hostname.",
|
|
1476
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"}},"required":["website_id"],"title":"WebsiteGetInput","type":"object"}',
|
|
1477
|
+
resultKind: "inline",
|
|
1478
|
+
},
|
|
1479
|
+
],
|
|
1480
|
+
},
|
|
1481
|
+
{
|
|
1482
|
+
action: "zo.website.list",
|
|
1483
|
+
path: ["website", "list"],
|
|
1484
|
+
versions: [
|
|
1485
|
+
{
|
|
1486
|
+
version: 1,
|
|
1487
|
+
description: "List Websites the caller can read.",
|
|
1488
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"maxLength":200,"minLength":1,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"WebsiteListInput","type":"object"}',
|
|
1489
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"}},"required":[]}',
|
|
1490
|
+
resultKind: "inline",
|
|
1491
|
+
},
|
|
1492
|
+
],
|
|
1493
|
+
},
|
|
1494
|
+
{
|
|
1495
|
+
action: "zo.website.update",
|
|
1496
|
+
path: ["website", "update"],
|
|
1497
|
+
versions: [
|
|
1498
|
+
{
|
|
1499
|
+
version: 1,
|
|
1500
|
+
description: "Update a Website display name or custom hostname.",
|
|
1501
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"display_name":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Display Name"},"custom_hostname":{"anyOf":[{"$ref":"#/$defs/CustomHostnameChange"},{"type":"null"}],"default":null}},"required":["website_id","expected_revision"],"title":"WebsiteUpdateInput","type":"object","$defs":{"CustomHostnameChange":{"additionalProperties":false,"properties":{"hostname":{"anyOf":[{"maxLength":253,"minLength":4,"type":"string"},{"type":"null"}],"title":"Hostname"}},"required":["hostname"],"title":"CustomHostnameChange","type":"object"}}}',
|
|
1502
|
+
resultKind: "inline",
|
|
1503
|
+
},
|
|
1504
|
+
],
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
action: "zo.website_route.create",
|
|
1508
|
+
path: ["website-route", "create"],
|
|
1509
|
+
versions: [
|
|
1510
|
+
{
|
|
1511
|
+
version: 1,
|
|
1512
|
+
description: "Create an unpublished Website route.",
|
|
1513
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"path":{"maxLength":1024,"minLength":1,"title":"Path","type":"string"},"target":{"discriminator":{"mapping":{"function":"#/$defs/FunctionRouteConfigInput","kb":"#/$defs/KbRouteConfigInput","machine":"#/$defs/MachineRouteConfigInput"},"propertyName":"kind"},"oneOf":[{"$ref":"#/$defs/FunctionRouteConfigInput"},{"$ref":"#/$defs/MachineRouteConfigInput"},{"$ref":"#/$defs/KbRouteConfigInput"}],"title":"Target"},"acknowledge_bound_accounts":{"default":[],"items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":8,"title":"Acknowledge Bound Accounts","type":"array"}},"required":["website_id","expected_revision","path","target"],"title":"RouteCreateInput","type":"object","$defs":{"FunctionInputMapping":{"additionalProperties":false,"properties":{"handler":{"default":"http","maxLength":200,"minLength":1,"title":"Handler","type":"string"},"strip_prefix":{"default":false,"title":"Strip Prefix","type":"boolean"}},"title":"FunctionInputMapping","type":"object","required":[]},"FunctionRouteConfigInput":{"additionalProperties":false,"properties":{"kind":{"const":"function","title":"Kind","type":"string"},"function_id":{"maxLength":200,"minLength":1,"title":"Function Id","type":"string"},"deployment_id":{"maxLength":200,"minLength":1,"title":"Deployment Id","type":"string"},"input_mapping":{"$ref":"#/$defs/FunctionInputMapping"}},"required":["kind","function_id","deployment_id"],"title":"FunctionRouteConfigInput","type":"object"},"KbRouteConfigInput":{"additionalProperties":false,"properties":{"kind":{"const":"kb","title":"Kind","type":"string"},"kb_path":{"maxLength":4096,"minLength":1,"title":"Kb Path","type":"string"},"spa_fallback":{"default":false,"title":"Spa Fallback","type":"boolean"},"published_as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Published As Of"}},"required":["kind","kb_path"],"title":"KbRouteConfigInput","type":"object"},"MachineRouteConfigInput":{"additionalProperties":false,"properties":{"kind":{"const":"machine","title":"Kind","type":"string"},"machine_id":{"maxLength":200,"minLength":1,"title":"Machine Id","type":"string"},"port":{"maximum":65535,"minimum":1,"title":"Port","type":"integer"},"strip_prefix":{"default":false,"title":"Strip Prefix","type":"boolean"}},"required":["kind","machine_id","port"],"title":"MachineRouteConfigInput","type":"object"}}}',
|
|
1514
|
+
resultKind: "inline",
|
|
1515
|
+
},
|
|
1516
|
+
],
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
action: "zo.website_route.delete",
|
|
1520
|
+
path: ["website-route", "delete"],
|
|
1521
|
+
versions: [
|
|
1522
|
+
{
|
|
1523
|
+
version: 1,
|
|
1524
|
+
description: "Delete a Website route.",
|
|
1525
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"},"route_id":{"maxLength":200,"minLength":1,"title":"Route Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"acknowledge_bound_accounts":{"default":[],"items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":8,"title":"Acknowledge Bound Accounts","type":"array"}},"required":["website_id","route_id","expected_revision"],"title":"RouteRevisionInput","type":"object"}',
|
|
1526
|
+
resultKind: "inline",
|
|
1527
|
+
},
|
|
1528
|
+
],
|
|
1529
|
+
},
|
|
1530
|
+
{
|
|
1531
|
+
action: "zo.website_route.get",
|
|
1532
|
+
path: ["website-route", "get"],
|
|
1533
|
+
versions: [
|
|
1534
|
+
{
|
|
1535
|
+
version: 1,
|
|
1536
|
+
description: "Read a Website route.",
|
|
1537
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"},"route_id":{"maxLength":200,"minLength":1,"title":"Route Id","type":"string"}},"required":["website_id","route_id"],"title":"RouteGetInput","type":"object"}',
|
|
1538
|
+
resultKind: "inline",
|
|
1539
|
+
},
|
|
1540
|
+
],
|
|
1541
|
+
},
|
|
1542
|
+
{
|
|
1543
|
+
action: "zo.website_route.list",
|
|
1544
|
+
path: ["website-route", "list"],
|
|
1545
|
+
versions: [
|
|
1546
|
+
{
|
|
1547
|
+
version: 1,
|
|
1548
|
+
description: "List routes on a Website, ordered by path.",
|
|
1549
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"}},"required":["website_id"],"title":"RouteListInput","type":"object"}',
|
|
1550
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
1551
|
+
resultKind: "inline",
|
|
1552
|
+
},
|
|
1553
|
+
],
|
|
1554
|
+
},
|
|
1555
|
+
{
|
|
1556
|
+
action: "zo.website_route.publish",
|
|
1557
|
+
path: ["website-route", "publish"],
|
|
1558
|
+
versions: [
|
|
1559
|
+
{
|
|
1560
|
+
version: 1,
|
|
1561
|
+
description: "Publish a Website route after checking its source.",
|
|
1562
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"},"route_id":{"maxLength":200,"minLength":1,"title":"Route Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"acknowledge_bound_accounts":{"default":[],"items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":8,"title":"Acknowledge Bound Accounts","type":"array"}},"required":["website_id","route_id","expected_revision"],"title":"RouteRevisionInput","type":"object"}',
|
|
1563
|
+
resultKind: "inline",
|
|
1564
|
+
},
|
|
1565
|
+
],
|
|
1566
|
+
},
|
|
1567
|
+
{
|
|
1568
|
+
action: "zo.website_route.unpublish",
|
|
1569
|
+
path: ["website-route", "unpublish"],
|
|
1570
|
+
versions: [
|
|
1571
|
+
{
|
|
1572
|
+
version: 1,
|
|
1573
|
+
description: "Unpublish a Website route.",
|
|
1574
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"},"route_id":{"maxLength":200,"minLength":1,"title":"Route Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"acknowledge_bound_accounts":{"default":[],"items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":8,"title":"Acknowledge Bound Accounts","type":"array"}},"required":["website_id","route_id","expected_revision"],"title":"RouteRevisionInput","type":"object"}',
|
|
1575
|
+
resultKind: "inline",
|
|
1576
|
+
},
|
|
1577
|
+
],
|
|
1578
|
+
},
|
|
1579
|
+
{
|
|
1580
|
+
action: "zo.website_route.update",
|
|
1581
|
+
path: ["website-route", "update"],
|
|
1582
|
+
versions: [
|
|
1583
|
+
{
|
|
1584
|
+
version: 1,
|
|
1585
|
+
description: "Update a Website route and recheck its published source.",
|
|
1586
|
+
inputJson: '{"additionalProperties":false,"properties":{"website_id":{"maxLength":200,"minLength":1,"title":"Website Id","type":"string"},"route_id":{"maxLength":200,"minLength":1,"title":"Route Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"path":{"anyOf":[{"maxLength":1024,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Path"},"target":{"anyOf":[{"discriminator":{"mapping":{"function":"#/$defs/FunctionRouteConfigInput","kb":"#/$defs/KbRouteConfigInput","machine":"#/$defs/MachineRouteConfigInput"},"propertyName":"kind"},"oneOf":[{"$ref":"#/$defs/FunctionRouteConfigInput"},{"$ref":"#/$defs/MachineRouteConfigInput"},{"$ref":"#/$defs/KbRouteConfigInput"}]},{"type":"null"}],"default":null,"title":"Target"},"acknowledge_bound_accounts":{"default":[],"items":{"maxLength":200,"minLength":1,"type":"string"},"maxItems":8,"title":"Acknowledge Bound Accounts","type":"array"}},"required":["website_id","route_id","expected_revision"],"title":"RouteUpdateInput","type":"object","$defs":{"FunctionInputMapping":{"additionalProperties":false,"properties":{"handler":{"default":"http","maxLength":200,"minLength":1,"title":"Handler","type":"string"},"strip_prefix":{"default":false,"title":"Strip Prefix","type":"boolean"}},"title":"FunctionInputMapping","type":"object","required":[]},"FunctionRouteConfigInput":{"additionalProperties":false,"properties":{"kind":{"const":"function","title":"Kind","type":"string"},"function_id":{"maxLength":200,"minLength":1,"title":"Function Id","type":"string"},"deployment_id":{"maxLength":200,"minLength":1,"title":"Deployment Id","type":"string"},"input_mapping":{"$ref":"#/$defs/FunctionInputMapping"}},"required":["kind","function_id","deployment_id"],"title":"FunctionRouteConfigInput","type":"object"},"KbRouteConfigInput":{"additionalProperties":false,"properties":{"kind":{"const":"kb","title":"Kind","type":"string"},"kb_path":{"maxLength":4096,"minLength":1,"title":"Kb Path","type":"string"},"spa_fallback":{"default":false,"title":"Spa Fallback","type":"boolean"},"published_as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Published As Of"}},"required":["kind","kb_path"],"title":"KbRouteConfigInput","type":"object"},"MachineRouteConfigInput":{"additionalProperties":false,"properties":{"kind":{"const":"machine","title":"Kind","type":"string"},"machine_id":{"maxLength":200,"minLength":1,"title":"Machine Id","type":"string"},"port":{"maximum":65535,"minimum":1,"title":"Port","type":"integer"},"strip_prefix":{"default":false,"title":"Strip Prefix","type":"boolean"}},"required":["kind","machine_id","port"],"title":"MachineRouteConfigInput","type":"object"}}}',
|
|
1587
|
+
resultKind: "inline",
|
|
1588
|
+
},
|
|
1589
|
+
],
|
|
1590
|
+
},
|
|
1591
|
+
{
|
|
1592
|
+
action: "zo.workflow.activate",
|
|
1593
|
+
path: ["workflow", "activate"],
|
|
1594
|
+
versions: [
|
|
1595
|
+
{
|
|
1596
|
+
version: 1,
|
|
1597
|
+
description: "Activate a ready revision of the workflow so new runs use it.",
|
|
1598
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"},"revision_id":{"title":"Revision Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["workflow_id","revision_id","expected_revision"],"title":"WorkflowActivateInput","type":"object"}',
|
|
1599
|
+
resultKind: "inline",
|
|
1600
|
+
},
|
|
1601
|
+
],
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
action: "zo.workflow.cancel_run",
|
|
1605
|
+
path: ["workflow", "cancel-run"],
|
|
1606
|
+
versions: [
|
|
1607
|
+
{
|
|
1608
|
+
version: 1,
|
|
1609
|
+
description: "Request cancellation of a run owned by this workflow.",
|
|
1610
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"},"run_id":{"title":"Run Id","type":"string"}},"required":["workflow_id","run_id"],"title":"WorkflowCancelRunInput","type":"object"}',
|
|
1611
|
+
resultKind: "inline",
|
|
1612
|
+
},
|
|
1613
|
+
],
|
|
1614
|
+
},
|
|
1615
|
+
{
|
|
1616
|
+
action: "zo.workflow.create",
|
|
1617
|
+
path: ["workflow", "create"],
|
|
1618
|
+
versions: [
|
|
1619
|
+
{
|
|
1620
|
+
version: 1,
|
|
1621
|
+
description: "Create a workflow in a workspace.",
|
|
1622
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"},"display_name":{"maxLength":120,"minLength":1,"title":"Display Name","type":"string"},"visibility":{"default":"workspace","enum":["workspace","protected"],"title":"Visibility","type":"string"}},"required":["workspace_id","display_name"],"title":"WorkflowCreateInput","type":"object"}',
|
|
1623
|
+
resultKind: "inline",
|
|
1624
|
+
},
|
|
1625
|
+
],
|
|
1626
|
+
},
|
|
1627
|
+
{
|
|
1628
|
+
action: "zo.workflow.delete",
|
|
1629
|
+
path: ["workflow", "delete"],
|
|
1630
|
+
versions: [
|
|
1631
|
+
{
|
|
1632
|
+
version: 1,
|
|
1633
|
+
description: "Delete a workflow: it accepts no new revisions or runs, and its deployed revisions are removed.",
|
|
1634
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"}},"required":["workflow_id","expected_revision"],"title":"WorkflowDeleteInput","type":"object"}',
|
|
1635
|
+
resultKind: "inline",
|
|
1636
|
+
},
|
|
1637
|
+
],
|
|
1638
|
+
},
|
|
1639
|
+
{
|
|
1640
|
+
action: "zo.workflow.get",
|
|
1641
|
+
path: ["workflow", "get"],
|
|
1642
|
+
versions: [
|
|
1643
|
+
{
|
|
1644
|
+
version: 1,
|
|
1645
|
+
description: "Read a workflow and its active revision.",
|
|
1646
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"}},"required":["workflow_id"],"title":"WorkflowGetInput","type":"object"}',
|
|
1647
|
+
resultKind: "inline",
|
|
1648
|
+
},
|
|
1649
|
+
],
|
|
1650
|
+
},
|
|
1651
|
+
{
|
|
1652
|
+
action: "zo.workflow.get_run",
|
|
1653
|
+
path: ["workflow", "get-run"],
|
|
1654
|
+
versions: [
|
|
1655
|
+
{
|
|
1656
|
+
version: 1,
|
|
1657
|
+
description: "Read a run owned by this workflow, including its steps and an available result.",
|
|
1658
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"},"run_id":{"title":"Run Id","type":"string"}},"required":["workflow_id","run_id"],"title":"WorkflowGetRunInput","type":"object"}',
|
|
1659
|
+
resultKind: "inline",
|
|
1660
|
+
},
|
|
1661
|
+
],
|
|
1662
|
+
},
|
|
1663
|
+
{
|
|
1664
|
+
action: "zo.workflow.invoke",
|
|
1665
|
+
path: ["workflow", "invoke"],
|
|
1666
|
+
versions: [
|
|
1667
|
+
{
|
|
1668
|
+
version: 1,
|
|
1669
|
+
description: "Start the active workflow revision in the background and return its run.",
|
|
1670
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"},"input":{"x-zo-json-value":true}},"required":["workflow_id","input"],"title":"WorkflowInvokeInput","type":"object"}',
|
|
1671
|
+
resultKind: "run",
|
|
1672
|
+
},
|
|
1673
|
+
],
|
|
1674
|
+
},
|
|
1675
|
+
{
|
|
1676
|
+
action: "zo.workflow.list",
|
|
1677
|
+
path: ["workflow", "list"],
|
|
1678
|
+
versions: [
|
|
1679
|
+
{
|
|
1680
|
+
version: 1,
|
|
1681
|
+
description: "List workflows accessible to the caller in a workspace.",
|
|
1682
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"WorkflowListInput","type":"object"}',
|
|
1683
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
1684
|
+
resultKind: "inline",
|
|
1685
|
+
},
|
|
1686
|
+
],
|
|
1687
|
+
},
|
|
1688
|
+
{
|
|
1689
|
+
action: "zo.workflow.list_runs",
|
|
1690
|
+
path: ["workflow", "list-runs"],
|
|
1691
|
+
versions: [
|
|
1692
|
+
{
|
|
1693
|
+
version: 1,
|
|
1694
|
+
description: "List the workflow's runs, newest first.",
|
|
1695
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"}},"required":["workflow_id"],"title":"WorkflowListRunsInput","type":"object"}',
|
|
1696
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."}},"required":[]}',
|
|
1697
|
+
resultKind: "inline",
|
|
1698
|
+
},
|
|
1699
|
+
],
|
|
1700
|
+
},
|
|
1701
|
+
{
|
|
1702
|
+
action: "zo.workflow.publish",
|
|
1703
|
+
path: ["workflow", "publish"],
|
|
1704
|
+
versions: [
|
|
1705
|
+
{
|
|
1706
|
+
version: 1,
|
|
1707
|
+
description: "Validate a definition and queue an immutable workflow revision for deployment.",
|
|
1708
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"},"expected_revision":{"exclusiveMinimum":0,"maximum":9007199254740991,"title":"Expected Revision","type":"integer"},"definition":{"additionalProperties":{"x-zo-json-value":true},"title":"Definition","type":"object"}},"required":["workflow_id","expected_revision","definition"],"title":"WorkflowPublishInput","type":"object"}',
|
|
1709
|
+
resultKind: "inline",
|
|
1710
|
+
},
|
|
1711
|
+
],
|
|
1712
|
+
},
|
|
1713
|
+
{
|
|
1714
|
+
action: "zo.workflow.revision.get",
|
|
1715
|
+
path: ["workflow", "revision", "get"],
|
|
1716
|
+
versions: [
|
|
1717
|
+
{
|
|
1718
|
+
version: 1,
|
|
1719
|
+
description: "Read a workflow revision and its deployment status.",
|
|
1720
|
+
inputJson: '{"additionalProperties":false,"properties":{"workflow_id":{"title":"Workflow Id","type":"string"},"revision_id":{"title":"Revision Id","type":"string"}},"required":["workflow_id","revision_id"],"title":"WorkflowRevisionGetInput","type":"object"}',
|
|
1721
|
+
resultKind: "inline",
|
|
1722
|
+
},
|
|
1723
|
+
],
|
|
1724
|
+
},
|
|
1725
|
+
{
|
|
1726
|
+
action: "zo.workspace.get",
|
|
1727
|
+
path: ["workspace", "get"],
|
|
1728
|
+
versions: [
|
|
1729
|
+
{
|
|
1730
|
+
version: 1,
|
|
1731
|
+
description: "Inspect a workspace's identity and display metadata.",
|
|
1732
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"WorkspaceGetInput","type":"object"}',
|
|
1733
|
+
resultKind: "inline",
|
|
1734
|
+
},
|
|
1735
|
+
],
|
|
1736
|
+
},
|
|
1737
|
+
{
|
|
1738
|
+
action: "zo.workspace.list_resources",
|
|
1739
|
+
path: ["workspace", "list-resources"],
|
|
1740
|
+
versions: [
|
|
1741
|
+
{
|
|
1742
|
+
version: 1,
|
|
1743
|
+
description: "Discover resource instances visible to the caller within a workspace.",
|
|
1744
|
+
inputJson: '{"additionalProperties":false,"properties":{"workspace_id":{"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"WorkspaceListResourcesInput","type":"object"}',
|
|
1745
|
+
queryJson: '{"type":"object","additionalProperties":false,"properties":{"limit":{"type":"integer","minimum":1,"default":50,"description":"Rows per page, at most 200; a larger value is reduced to it."},"cursor":{"type":"string","minLength":1,"maxLength":5504,"description":"The previous page\'s next_cursor, sent with the same sort, filter and search."},"sort":{"type":"string","enum":["id.asc","created_at.desc","created_at.asc","display_name.asc"],"default":"id.asc"},"filter":{"additionalProperties":false,"properties":{"type":{"anyOf":[{"pattern":"^(?:[a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:\\\\.[a-z][a-z0-9_]*)+)$","type":"string"},{"type":"null"}],"default":null,"description":"Only resources of this type, such as \\"machine\\" or a publisher-qualified type.","title":"Type"}},"type":"object","required":[],"default":{}}},"required":[]}',
|
|
1746
|
+
resultKind: "inline",
|
|
1747
|
+
},
|
|
1748
|
+
],
|
|
1749
|
+
},
|
|
1750
|
+
],
|
|
1751
|
+
};
|