@deepraxis/sdk 0.1.0-dev.8ad8e89 → 0.1.0-dev.8c50d77
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/METHODS.md +171 -1
- package/dist/core/client.d.ts +9 -1
- package/dist/core/client.js +6 -0
- package/dist/core/transport.d.ts +5 -0
- package/dist/core/transport.js +6 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +389 -33
- package/dist/generated/sdk.gen.js +1221 -107
- package/dist/generated/types.gen.d.ts +17117 -11289
- package/dist/helpers/database-count.d.ts +17 -0
- package/dist/helpers/database-count.js +11 -0
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +1779 -139
- package/dist/operations.generated.js +2220 -172
- package/dist/resources.generated.d.ts +747 -21
- package/dist/resources.generated.js +111 -0
- package/package.json +1 -1
|
@@ -4,7 +4,7 @@ export const operations = [
|
|
|
4
4
|
"resource": "agent.agents",
|
|
5
5
|
"method": "list",
|
|
6
6
|
"summary": "List agents",
|
|
7
|
-
"description": "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=
|
|
7
|
+
"description": "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=service for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
8
8
|
"http": "GET",
|
|
9
9
|
"path": "/agent/v1/agents",
|
|
10
10
|
"streaming": "no",
|
|
@@ -50,7 +50,7 @@ export const operations = [
|
|
|
50
50
|
"type": "string",
|
|
51
51
|
"enum": [
|
|
52
52
|
"personal",
|
|
53
|
-
"
|
|
53
|
+
"service"
|
|
54
54
|
],
|
|
55
55
|
"required": false,
|
|
56
56
|
"description": "Filter agents by their immutable kind, including agents created before kind was recorded."
|
|
@@ -61,7 +61,7 @@ export const operations = [
|
|
|
61
61
|
"resource": "agent.agents",
|
|
62
62
|
"method": "create",
|
|
63
63
|
"summary": "Create agent",
|
|
64
|
-
"description": "Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; the native skill tool is separate from the skills field. Use tools: [{type: \"agent_toolset_20260401\"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: \"agent_toolset_20260401\", default_config: {enabled: false}, configs: [{name: \"codemode\", enabled: true}, {name: \"bash\", enabled: true, permission_policy: {type: \"always_ask\"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. Example: {\"name\":\"helper\",\"model\":{\"id\":\"deepseek-flash\"},\"tools\":[{\"type\":\"agent_toolset_20260401\"}]}.",
|
|
64
|
+
"description": "Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; the native skill tool is separate from the skills field. Use tools: [{type: \"agent_toolset_20260401\"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: \"agent_toolset_20260401\", default_config: {enabled: false}, configs: [{name: \"codemode\", enabled: true}, {name: \"bash\", enabled: true, permission_policy: {type: \"always_ask\"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. model and every models.allowed entry must be a catalog model that can run an agent: an unknown id returns 400 \"model <id> is not in the model catalog\" and an embedding, image or speech model returns 400 \"model <id> cannot run an agent\". name is trimmed and may not be blank or contain NUL or line breaks. avatar is trimmed, must not contain spaces or point at a loopback, private or internal host, and its scheme is stored in lowercase. script and workflow binding ids are stored in lowercase, the form automation matches; bindings together with environment_id null return 400 because bindings need a machine. Example: {\"name\":\"helper\",\"model\":{\"id\":\"deepseek-flash\"},\"tools\":[{\"type\":\"agent_toolset_20260401\"}]}.",
|
|
65
65
|
"http": "POST",
|
|
66
66
|
"path": "/agent/v1/agents",
|
|
67
67
|
"streaming": "no",
|
|
@@ -75,7 +75,7 @@ export const operations = [
|
|
|
75
75
|
"name": "model",
|
|
76
76
|
"type": "object",
|
|
77
77
|
"required": true,
|
|
78
|
-
"description": "
|
|
78
|
+
"description": "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected."
|
|
79
79
|
},
|
|
80
80
|
{
|
|
81
81
|
"name": "name",
|
|
@@ -128,15 +128,22 @@ export const operations = [
|
|
|
128
128
|
"required": false,
|
|
129
129
|
"description": "Tool configurations available to the agent. Maximum of 128 tools\nacross all toolsets allowed."
|
|
130
130
|
},
|
|
131
|
+
{
|
|
132
|
+
"name": "bindings",
|
|
133
|
+
"type": "array",
|
|
134
|
+
"itemType": "object",
|
|
135
|
+
"required": false,
|
|
136
|
+
"description": "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings."
|
|
137
|
+
},
|
|
131
138
|
{
|
|
132
139
|
"name": "kind",
|
|
133
140
|
"type": "string",
|
|
134
141
|
"enum": [
|
|
135
142
|
"personal",
|
|
136
|
-
"
|
|
143
|
+
"service"
|
|
137
144
|
],
|
|
138
145
|
"required": false,
|
|
139
|
-
"description": "Immutable agent kind. personal requires computer_id;
|
|
146
|
+
"description": "Immutable agent kind. personal requires computer_id; service cannot bind a computer. Omit on create to infer from computer_id. On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error."
|
|
140
147
|
},
|
|
141
148
|
{
|
|
142
149
|
"name": "computer_id",
|
|
@@ -176,6 +183,25 @@ export const operations = [
|
|
|
176
183
|
"required": false,
|
|
177
184
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
178
185
|
},
|
|
186
|
+
{
|
|
187
|
+
"name": "avatar",
|
|
188
|
+
"type": "string",
|
|
189
|
+
"required": false,
|
|
190
|
+
"description": "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"name": "environment_id",
|
|
194
|
+
"type": "string",
|
|
195
|
+
"required": false,
|
|
196
|
+
"description": "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "vault_ids",
|
|
200
|
+
"type": "array",
|
|
201
|
+
"itemType": "string",
|
|
202
|
+
"required": false,
|
|
203
|
+
"description": "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
204
|
+
},
|
|
179
205
|
{
|
|
180
206
|
"name": "preset",
|
|
181
207
|
"type": "string",
|
|
@@ -218,7 +244,7 @@ export const operations = [
|
|
|
218
244
|
"resource": "agent.agents",
|
|
219
245
|
"method": "update",
|
|
220
246
|
"summary": "Update agent",
|
|
221
|
-
"description": "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version
|
|
247
|
+
"description": "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version. apply defaults to true and moves active_version to the new version, or to the latest when configuration is unchanged; apply false saves without applying. version_note optionally records up to 280 characters on a newly created version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; use the native skill tool for available runtime skills.",
|
|
222
248
|
"http": "POST",
|
|
223
249
|
"path": "/agent/v1/agents/{agent_id}",
|
|
224
250
|
"streaming": "no",
|
|
@@ -256,7 +282,7 @@ export const operations = [
|
|
|
256
282
|
"name": "model",
|
|
257
283
|
"type": "object",
|
|
258
284
|
"required": false,
|
|
259
|
-
"description": "
|
|
285
|
+
"description": "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected."
|
|
260
286
|
},
|
|
261
287
|
{
|
|
262
288
|
"name": "multiagent",
|
|
@@ -296,15 +322,34 @@ export const operations = [
|
|
|
296
322
|
"required": false,
|
|
297
323
|
"description": "The agent's current version, used to prevent concurrent overwrites.\nObtain this value from a create or retrieve response. Must be at least 1 if\nspecified. When supplied, the request fails if it does not match the server's\ncurrent version; omit to apply the update unconditionally."
|
|
298
324
|
},
|
|
325
|
+
{
|
|
326
|
+
"name": "apply",
|
|
327
|
+
"type": "boolean",
|
|
328
|
+
"required": false,
|
|
329
|
+
"description": "Defaults to true: apply the newly saved version, or the latest version when configuration is unchanged. Set false to save without changing active_version. Unlike Managed Agents, saving and applying can be separate."
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "version_note",
|
|
333
|
+
"type": "string",
|
|
334
|
+
"required": false,
|
|
335
|
+
"description": "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission stores null. A note alone does not create a version or rewrite an existing note."
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
"name": "bindings",
|
|
339
|
+
"type": "array",
|
|
340
|
+
"itemType": "object",
|
|
341
|
+
"required": false,
|
|
342
|
+
"description": "Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; once this version is applied, disabling, removing or downgrading a binding revokes it immediately in running sessions on older versions, while apply=false changes no access. Only service agents accept a nonempty list."
|
|
343
|
+
},
|
|
299
344
|
{
|
|
300
345
|
"name": "kind",
|
|
301
346
|
"type": "string",
|
|
302
347
|
"enum": [
|
|
303
348
|
"personal",
|
|
304
|
-
"
|
|
349
|
+
"service"
|
|
305
350
|
],
|
|
306
351
|
"required": false,
|
|
307
|
-
"description": "Immutable agent kind. personal requires computer_id;
|
|
352
|
+
"description": "Immutable agent kind. personal requires computer_id; service cannot bind a computer. Omit on create to infer from computer_id. On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error."
|
|
308
353
|
},
|
|
309
354
|
{
|
|
310
355
|
"name": "computer_id",
|
|
@@ -344,6 +389,25 @@ export const operations = [
|
|
|
344
389
|
"required": false,
|
|
345
390
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
346
391
|
},
|
|
392
|
+
{
|
|
393
|
+
"name": "avatar",
|
|
394
|
+
"type": "string",
|
|
395
|
+
"required": false,
|
|
396
|
+
"description": "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "environment_id",
|
|
400
|
+
"type": "string",
|
|
401
|
+
"required": false,
|
|
402
|
+
"description": "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"name": "vault_ids",
|
|
406
|
+
"type": "array",
|
|
407
|
+
"itemType": "string",
|
|
408
|
+
"required": false,
|
|
409
|
+
"description": "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
410
|
+
},
|
|
347
411
|
{
|
|
348
412
|
"name": "preset",
|
|
349
413
|
"type": "string",
|
|
@@ -375,11 +439,149 @@ export const operations = [
|
|
|
375
439
|
],
|
|
376
440
|
"query": []
|
|
377
441
|
},
|
|
442
|
+
{
|
|
443
|
+
"resource": "agent.agents.customers.auth.accessTokens",
|
|
444
|
+
"method": "create",
|
|
445
|
+
"summary": "Create customer access token",
|
|
446
|
+
"description": "Exchange a grant code, or the agent's publishable key for an anonymous visitor, for a customer access token that authorizes the agent's embedded sessions.\n\nNo Authorization header is required: the grant code or the publishable key is the credential. Agent Kit calls this from the browser, so send the page Origin. With grant_code, the code is consumed atomically: concurrent attempts have exactly one winner, and unknown, used, expired and other-agent codes all return the same 401 GRANT_CODE_INVALID. The sign-in starts now and lasts the code's max_session_seconds. Unlike Shopify, a visitor without an account gets a token too: send publishable_key instead and a new anonymous customer (anon_…) is created, bound to the request Origin, for 7 days. The access token lasts at most two hours and never outlives the sign-in; renew it with access_tokens/renew before expires_at. Both forms share the per-IP minute limit of anonymous issuance (default 20). Example body: {\"grant_code\":\"cgc_…\"}.",
|
|
447
|
+
"http": "POST",
|
|
448
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
|
|
449
|
+
"streaming": "no",
|
|
450
|
+
"pagination": false,
|
|
451
|
+
"pathParams": [
|
|
452
|
+
{
|
|
453
|
+
"name": "agent_id",
|
|
454
|
+
"sdkName": "agent_id"
|
|
455
|
+
}
|
|
456
|
+
],
|
|
457
|
+
"query": [],
|
|
458
|
+
"body": {
|
|
459
|
+
"required": true,
|
|
460
|
+
"fields": []
|
|
461
|
+
}
|
|
462
|
+
},
|
|
463
|
+
{
|
|
464
|
+
"resource": "agent.agents.customers.auth.accessTokens",
|
|
465
|
+
"method": "deleteCurrent",
|
|
466
|
+
"summary": "Log out customer",
|
|
467
|
+
"description": "Log the customer out by revoking the sign-in of the presented access token and every token issued in it.\n\nSend the current customer access token as the Bearer credential, with no body, when the customer logs out of your site. Every token of the sign-in, including renewed ones, stops working, and their live event streams close; the customer's conversations are kept. Returns 204. Calling it again with the same token returns 401 ACCESS_TOKEN_REVOKED, so treat that as already logged out.",
|
|
468
|
+
"http": "DELETE",
|
|
469
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current",
|
|
470
|
+
"streaming": "no",
|
|
471
|
+
"pagination": false,
|
|
472
|
+
"pathParams": [
|
|
473
|
+
{
|
|
474
|
+
"name": "agent_id",
|
|
475
|
+
"sdkName": "agent_id"
|
|
476
|
+
}
|
|
477
|
+
],
|
|
478
|
+
"query": []
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"resource": "agent.agents.customers.auth.accessTokens.renew",
|
|
482
|
+
"method": "create",
|
|
483
|
+
"summary": "Renew customer access token",
|
|
484
|
+
"description": "Get a fresh customer access token in the same sign-in, authenticated with the current one.\n\nSend the current customer access token as the Bearer credential, with no body, a few minutes before expires_at. The new token keeps the version, budget, context, metadata and origin binding of the sign-in and lasts at most two hours, never past session_expires_at. Unlike Shopify, renewal does not revoke the presented token: it stays valid until its own expiry, so a reply that is streaming on it is not cut off. When less than 60 seconds of the sign-in remain, renewal returns 401 CUSTOMER_SESSION_EXPIRED; sign the customer in again with a new grant code from your backend. A token that was logged out or merged returns 401 ACCESS_TOKEN_REVOKED.",
|
|
485
|
+
"http": "POST",
|
|
486
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
|
|
487
|
+
"streaming": "no",
|
|
488
|
+
"pagination": false,
|
|
489
|
+
"pathParams": [
|
|
490
|
+
{
|
|
491
|
+
"name": "agent_id",
|
|
492
|
+
"sdkName": "agent_id"
|
|
493
|
+
}
|
|
494
|
+
],
|
|
495
|
+
"query": []
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"resource": "agent.agents.customers.auth.grantCodes",
|
|
499
|
+
"method": "create",
|
|
500
|
+
"summary": "Create customer grant code",
|
|
501
|
+
"description": "Sign your logged-in customer in to a service agent from your backend with a one-time grant code that Agent Kit exchanges for a customer access token.\n\nCall this from your backend with your API key after your own login succeeds, then pass the returned code to Agent Kit in the browser; never call it from the browser. Customer authorization follows Shopify Storefront customer access tokens (Multipass-style sign-in, a short-lived token, renewal and logout), so that experience applies. customer_id is your own identifier for the customer: use an opaque id such as your database user id, not an email address or phone number. The value auth is reserved, and ids starting with anon_ are reserved for anonymous customers. The code works once and expires after expires_in seconds (default 900). The sign-in it starts lasts max_session_seconds (default 7 days); version, budget_cents, system_message, agent_override and metadata apply to every token of the sign-in. Unlike Shopify, origin binds the whole sign-in to one page origin, and anonymous_access_token merges the conversations of the anonymous visitor who chatted before signing in into this customer. Example body: {\"customer_id\":\"cus_8f2a91\",\"origin\":\"https://shop.example.com\"}.",
|
|
502
|
+
"http": "POST",
|
|
503
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
|
|
504
|
+
"streaming": "no",
|
|
505
|
+
"pagination": false,
|
|
506
|
+
"pathParams": [
|
|
507
|
+
{
|
|
508
|
+
"name": "agent_id",
|
|
509
|
+
"sdkName": "agent_id"
|
|
510
|
+
}
|
|
511
|
+
],
|
|
512
|
+
"query": [],
|
|
513
|
+
"body": {
|
|
514
|
+
"required": true,
|
|
515
|
+
"fields": [
|
|
516
|
+
{
|
|
517
|
+
"name": "customer_id",
|
|
518
|
+
"type": "string",
|
|
519
|
+
"required": true,
|
|
520
|
+
"description": "Your stable, opaque identifier for the signed-in customer, such as your database user id. Do not use an email address or phone number. \"auth\" is reserved, and ids starting with anon_ are reserved for anonymous customers."
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
"name": "version",
|
|
524
|
+
"type": "integer",
|
|
525
|
+
"required": false,
|
|
526
|
+
"description": "Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued."
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"name": "budget_cents",
|
|
530
|
+
"type": "integer",
|
|
531
|
+
"required": false,
|
|
532
|
+
"description": "Budget in cents for each session the customer starts. Defaults to the embed policy session budget and cannot exceed its maximum."
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "system_message",
|
|
536
|
+
"type": "array",
|
|
537
|
+
"itemType": "object",
|
|
538
|
+
"required": false,
|
|
539
|
+
"description": "Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total."
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"name": "agent_override",
|
|
543
|
+
"type": "object",
|
|
544
|
+
"required": false,
|
|
545
|
+
"description": "Optional system prompt override, accepted only when the embed policy allows agent overrides."
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"name": "metadata",
|
|
549
|
+
"type": "object",
|
|
550
|
+
"required": false,
|
|
551
|
+
"description": "Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved."
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "origin",
|
|
555
|
+
"type": "string",
|
|
556
|
+
"required": false,
|
|
557
|
+
"description": "Page origin, such as https://shop.example.com, that must be one of the agent policy's allowed_origins (or localhost when the policy allows it). When set, every token of this sign-in works only from exactly this origin. Omit to accept any policy origin."
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "expires_in",
|
|
561
|
+
"type": "integer",
|
|
562
|
+
"required": false,
|
|
563
|
+
"description": "Seconds the code stays redeemable, from 60 to 86400. Defaults to 900."
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "max_session_seconds",
|
|
567
|
+
"type": "integer",
|
|
568
|
+
"required": false,
|
|
569
|
+
"description": "Total lifetime of the sign-in in seconds, from 3600 to 604800 (7 days). Tokens renew within it; after it the customer signs in again. Defaults to 604800."
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
"name": "anonymous_access_token",
|
|
573
|
+
"type": "string",
|
|
574
|
+
"required": false,
|
|
575
|
+
"description": "The current access token of the anonymous customer who used this agent before signing in. Their conversations become visible to the identified customer, and the anonymous sign-in ends at exchange."
|
|
576
|
+
}
|
|
577
|
+
]
|
|
578
|
+
}
|
|
579
|
+
},
|
|
378
580
|
{
|
|
379
581
|
"resource": "agent.agents.endUsers",
|
|
380
582
|
"method": "list",
|
|
381
583
|
"summary": "List End Users",
|
|
382
|
-
"description": "List users who have sessions or token issuance history on a
|
|
584
|
+
"description": "List users who have sessions or token issuance history on a service agent.\n\nOrdered by last_active_at and external_user_id descending. q is a case-sensitive literal prefix, including underscores. limit is 1–100, default 20. Reuse next_page with the same organization, agent, q and limit. Preemptively blocked users without history do not appear. End-user credentials and inaccessible or personal agents return 404.",
|
|
383
585
|
"http": "GET",
|
|
384
586
|
"path": "/agent/v1/agents/{agent_id}/end_users",
|
|
385
587
|
"streaming": "no",
|
|
@@ -415,7 +617,7 @@ export const operations = [
|
|
|
415
617
|
"resource": "agent.agents.endUsers",
|
|
416
618
|
"method": "delete",
|
|
417
619
|
"summary": "Delete end-user data",
|
|
418
|
-
"description": "Delete a host application's end-user data from one
|
|
620
|
+
"description": "Delete a host application's end-user data from one service agent after explicit confirmation.\n\nDevelop only. Set confirm to the exact external_user_id; missing or mismatched confirmation returns 400. Returns 202 with a pending task id, not completion. Poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the user is blocked before a seven-day recovery snapshot is verified. Sessions including child sessions, conversation data, grants and feedback are then removed. A pre-existing block remains; a temporary block is removed on success. Attachment metadata is recorded and File attachments are retained. No charge is introduced by this operation. Example: DELETE /agent/v1/agents/agent_example/end_users/customer_123?confirm=customer_123.",
|
|
419
621
|
"http": "DELETE",
|
|
420
622
|
"path": "/agent/v1/agents/{agent_id}/end_users/{external_user_id}",
|
|
421
623
|
"streaming": "no",
|
|
@@ -591,6 +793,27 @@ export const operations = [
|
|
|
591
793
|
}
|
|
592
794
|
]
|
|
593
795
|
},
|
|
796
|
+
{
|
|
797
|
+
"resource": "agent.agents.versions",
|
|
798
|
+
"method": "apply",
|
|
799
|
+
"summary": "Apply Agent Version",
|
|
800
|
+
"description": "Apply a version from agents.versions.list by its version number. This idempotent operation changes active_version without creating a version; existing sessions and tokens keep their version. The response is the latest saved agent with its current active_version. Missing versions return 404 Agent version not found; archived agents return 409 Agent is archived. For example, POST /agent/v1/agents/{agent_id}/versions/2/apply with no body.",
|
|
801
|
+
"http": "POST",
|
|
802
|
+
"path": "/agent/v1/agents/{agent_id}/versions/{version}/apply",
|
|
803
|
+
"streaming": "no",
|
|
804
|
+
"pagination": false,
|
|
805
|
+
"pathParams": [
|
|
806
|
+
{
|
|
807
|
+
"name": "agent_id",
|
|
808
|
+
"sdkName": "agent_id"
|
|
809
|
+
},
|
|
810
|
+
{
|
|
811
|
+
"name": "version",
|
|
812
|
+
"sdkName": "version"
|
|
813
|
+
}
|
|
814
|
+
],
|
|
815
|
+
"query": []
|
|
816
|
+
},
|
|
594
817
|
{
|
|
595
818
|
"resource": "agent.computers",
|
|
596
819
|
"method": "list",
|
|
@@ -756,7 +979,7 @@ export const operations = [
|
|
|
756
979
|
"resource": "agent.computers",
|
|
757
980
|
"method": "connect",
|
|
758
981
|
"summary": "Connect computer",
|
|
759
|
-
"description": "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy.
|
|
982
|
+
"description": "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Renew the lease while using the connection and release it with DELETE when finished.",
|
|
760
983
|
"http": "POST",
|
|
761
984
|
"path": "/agent/v1/computers/{computer_id}/connect",
|
|
762
985
|
"streaming": "no",
|
|
@@ -1341,7 +1564,7 @@ export const operations = [
|
|
|
1341
1564
|
"name": "agent_id",
|
|
1342
1565
|
"type": "string",
|
|
1343
1566
|
"required": false,
|
|
1344
|
-
"description": "Filter by
|
|
1567
|
+
"description": "Filter by service agent identifier (agent_ or agt_ prefix)."
|
|
1345
1568
|
},
|
|
1346
1569
|
{
|
|
1347
1570
|
"name": "external_user_id",
|
|
@@ -1367,7 +1590,7 @@ export const operations = [
|
|
|
1367
1590
|
"resource": "agent.embedTokens",
|
|
1368
1591
|
"method": "create",
|
|
1369
1592
|
"summary": "Create Embed Token",
|
|
1370
|
-
"description": "Issue a short-lived credential on your backend for an end user of a
|
|
1593
|
+
"description": "Issue a short-lived credential on your backend for an end user of a service agent.\n\nRequires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.",
|
|
1371
1594
|
"http": "POST",
|
|
1372
1595
|
"path": "/agent/v1/embed_tokens",
|
|
1373
1596
|
"streaming": "no",
|
|
@@ -1387,7 +1610,7 @@ export const operations = [
|
|
|
1387
1610
|
"name": "agent",
|
|
1388
1611
|
"type": "string",
|
|
1389
1612
|
"required": true,
|
|
1390
|
-
"description": "
|
|
1613
|
+
"description": "Service agent ID or identity_number from agent retrieval; it must belong to your organization and be active."
|
|
1391
1614
|
},
|
|
1392
1615
|
{
|
|
1393
1616
|
"name": "version",
|
|
@@ -1460,7 +1683,7 @@ export const operations = [
|
|
|
1460
1683
|
"name": "publishable_key",
|
|
1461
1684
|
"type": "string",
|
|
1462
1685
|
"required": true,
|
|
1463
|
-
"description": "Public key created by the
|
|
1686
|
+
"description": "Public key created by the service agent owner; safe to include in browser code."
|
|
1464
1687
|
},
|
|
1465
1688
|
{
|
|
1466
1689
|
"name": "visitor_secret",
|
|
@@ -1527,7 +1750,7 @@ export const operations = [
|
|
|
1527
1750
|
"resource": "agent.environments",
|
|
1528
1751
|
"method": "create",
|
|
1529
1752
|
"summary": "Create environment",
|
|
1530
|
-
"description": "Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported.",
|
|
1753
|
+
"description": "Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported. config.template must name an available sandbox template, otherwise 400 lists the available ones.",
|
|
1531
1754
|
"http": "POST",
|
|
1532
1755
|
"path": "/agent/v1/environments",
|
|
1533
1756
|
"streaming": "no",
|
|
@@ -1595,7 +1818,7 @@ export const operations = [
|
|
|
1595
1818
|
"resource": "agent.environments",
|
|
1596
1819
|
"method": "update",
|
|
1597
1820
|
"summary": "Update environment",
|
|
1598
|
-
"description": "Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value.",
|
|
1821
|
+
"description": "Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value. A changed config.template must name an available sandbox template, otherwise 400 lists the available ones.",
|
|
1599
1822
|
"http": "POST",
|
|
1600
1823
|
"path": "/agent/v1/environments/{environment_id}",
|
|
1601
1824
|
"streaming": "no",
|
|
@@ -1651,7 +1874,7 @@ export const operations = [
|
|
|
1651
1874
|
"resource": "agent.environments",
|
|
1652
1875
|
"method": "archive",
|
|
1653
1876
|
"summary": "Archive environment",
|
|
1654
|
-
"description": "Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived.",
|
|
1877
|
+
"description": "Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived. An environment that the active version of a non-archived agent uses as environment_id returns 409 RESOURCE_IN_USE naming the agents; point them at another environment first.",
|
|
1655
1878
|
"http": "POST",
|
|
1656
1879
|
"path": "/agent/v1/environments/{environment_id}/archive",
|
|
1657
1880
|
"streaming": "no",
|
|
@@ -1793,7 +2016,7 @@ export const operations = [
|
|
|
1793
2016
|
"resource": "agent.sessions",
|
|
1794
2017
|
"method": "create",
|
|
1795
2018
|
"summary": "Create session",
|
|
1796
|
-
"description": "Create a session: one conversation with an agent
|
|
2019
|
+
"description": "Create a session: one conversation with an agent. Pass agent as an agent id (active_version) or {id, version, type:\"agent\"}. Unlike Anthropic Managed Agents, omit environment_id to get a light machine, unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, omission returns environment_id=light; explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Inline agent overrides are not supported. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Omitted budget defaults to USD 20; null removes the limit, and a limit object uses a positive integer string of USD cents. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.",
|
|
1797
2020
|
"http": "POST",
|
|
1798
2021
|
"path": "/agent/v1/sessions",
|
|
1799
2022
|
"streaming": "no",
|
|
@@ -1813,7 +2036,7 @@ export const operations = [
|
|
|
1813
2036
|
"name": "environment_id",
|
|
1814
2037
|
"type": "string",
|
|
1815
2038
|
"required": false,
|
|
1816
|
-
"description": "
|
|
2039
|
+
"description": "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission selects the built-in light environment and returns session.environment_id=light; explicit null allocates no machine and makes machine tools, including codemode and bash, unavailable. Personal agents use their selected Computer."
|
|
1817
2040
|
},
|
|
1818
2041
|
{
|
|
1819
2042
|
"name": "budget",
|
|
@@ -2680,83 +2903,302 @@ export const operations = [
|
|
|
2680
2903
|
]
|
|
2681
2904
|
},
|
|
2682
2905
|
{
|
|
2683
|
-
"resource": "agent.
|
|
2906
|
+
"resource": "agent.skills",
|
|
2684
2907
|
"method": "list",
|
|
2685
|
-
"summary": "List
|
|
2686
|
-
"description": "
|
|
2908
|
+
"summary": "List skills",
|
|
2909
|
+
"description": "List the skills uploaded to your organization, newest first, in pages of at most 100 (default 20). Use it to find a skill id before reading, versioning or deleting it. Only source=custom has content; source=anthropic returns an empty list. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
2687
2910
|
"http": "GET",
|
|
2688
|
-
"path": "/agent/v1/
|
|
2911
|
+
"path": "/agent/v1/skills",
|
|
2689
2912
|
"streaming": "no",
|
|
2690
2913
|
"pagination": false,
|
|
2691
2914
|
"pathParams": [],
|
|
2692
|
-
"query": [
|
|
2915
|
+
"query": [
|
|
2916
|
+
{
|
|
2917
|
+
"name": "source",
|
|
2918
|
+
"type": "string",
|
|
2919
|
+
"required": false,
|
|
2920
|
+
"description": "Filter skills by source.\n\nIf provided, only skills from the specified source will be returned:\n\n- `\"custom\"`: only return user-created skills\n- `\"anthropic\"`: only return Anthropic-created skills"
|
|
2921
|
+
},
|
|
2922
|
+
{
|
|
2923
|
+
"name": "limit",
|
|
2924
|
+
"type": "number",
|
|
2925
|
+
"required": false,
|
|
2926
|
+
"description": "Number of items per page."
|
|
2927
|
+
},
|
|
2928
|
+
{
|
|
2929
|
+
"name": "page",
|
|
2930
|
+
"type": "string",
|
|
2931
|
+
"required": false,
|
|
2932
|
+
"description": "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400."
|
|
2933
|
+
}
|
|
2934
|
+
]
|
|
2693
2935
|
},
|
|
2694
2936
|
{
|
|
2695
|
-
"resource": "
|
|
2937
|
+
"resource": "agent.skills",
|
|
2696
2938
|
"method": "create",
|
|
2697
|
-
"summary": "
|
|
2698
|
-
"description": "Upload
|
|
2939
|
+
"summary": "Create skill",
|
|
2940
|
+
"description": "Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name and must be one folder name (1-255 characters, no \"/\", backslash or NUL, not \".\" or \"..\"), otherwise the upload returns 400 stating the allowed form. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.",
|
|
2699
2941
|
"http": "POST",
|
|
2700
|
-
"path": "/
|
|
2942
|
+
"path": "/agent/v1/skills",
|
|
2701
2943
|
"streaming": "no",
|
|
2702
2944
|
"pagination": false,
|
|
2945
|
+
"multipart": true,
|
|
2703
2946
|
"pathParams": [],
|
|
2704
2947
|
"query": [],
|
|
2705
2948
|
"body": {
|
|
2706
2949
|
"required": true,
|
|
2707
2950
|
"fields": [
|
|
2708
2951
|
{
|
|
2709
|
-
"name": "
|
|
2710
|
-
"type": "
|
|
2952
|
+
"name": "files",
|
|
2953
|
+
"type": "array",
|
|
2954
|
+
"itemType": "string",
|
|
2711
2955
|
"required": true,
|
|
2712
|
-
"description": "
|
|
2956
|
+
"description": "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory."
|
|
2713
2957
|
},
|
|
2714
2958
|
{
|
|
2715
|
-
"name": "
|
|
2716
|
-
"type": "
|
|
2717
|
-
"required":
|
|
2718
|
-
"description": "
|
|
2959
|
+
"name": "display_name",
|
|
2960
|
+
"type": "string",
|
|
2961
|
+
"required": false,
|
|
2962
|
+
"description": "Human-readable, single-line label for the Skill. Maximum 255\ncharacters. Always set: derived from the SKILL.md frontmatter `name` when\nomitted at creation. Not unique."
|
|
2719
2963
|
}
|
|
2720
2964
|
]
|
|
2721
2965
|
}
|
|
2722
2966
|
},
|
|
2723
2967
|
{
|
|
2724
|
-
"resource": "
|
|
2725
|
-
"method": "
|
|
2726
|
-
"summary": "
|
|
2727
|
-
"description": "
|
|
2728
|
-
"http": "
|
|
2729
|
-
"path": "/
|
|
2968
|
+
"resource": "agent.skills",
|
|
2969
|
+
"method": "delete",
|
|
2970
|
+
"summary": "Delete skill",
|
|
2971
|
+
"description": "Delete a skill that has no live versions. A skill that is still attached to an agent returns 409 RESOURCE_IN_USE naming up to 10 agent ids (the active or latest version of a non-archived agent counts); remove it from those agents first. A skill that still has versions returns 409 Delete all versions first; remove each with skills.versions.delete, then call this. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.",
|
|
2972
|
+
"http": "DELETE",
|
|
2973
|
+
"path": "/agent/v1/skills/{skill_id}",
|
|
2730
2974
|
"streaming": "no",
|
|
2731
2975
|
"pagination": false,
|
|
2732
|
-
"pathParams": [
|
|
2976
|
+
"pathParams": [
|
|
2977
|
+
{
|
|
2978
|
+
"name": "skill_id",
|
|
2979
|
+
"sdkName": "skill_id"
|
|
2980
|
+
}
|
|
2981
|
+
],
|
|
2733
2982
|
"query": []
|
|
2734
2983
|
},
|
|
2735
2984
|
{
|
|
2736
|
-
"resource": "
|
|
2737
|
-
"method": "
|
|
2738
|
-
"summary": "
|
|
2739
|
-
"description": "
|
|
2740
|
-
"http": "
|
|
2741
|
-
"path": "/
|
|
2985
|
+
"resource": "agent.skills",
|
|
2986
|
+
"method": "retrieve",
|
|
2987
|
+
"summary": "Get skill",
|
|
2988
|
+
"description": "Read one skill by id: its display_name, source and latest_version_id. skill_id comes from skills.create or skills.list. A skill of another organization, or a deleted one, returns 404 Skill not found.",
|
|
2989
|
+
"http": "GET",
|
|
2990
|
+
"path": "/agent/v1/skills/{skill_id}",
|
|
2742
2991
|
"streaming": "no",
|
|
2743
2992
|
"pagination": false,
|
|
2744
|
-
"pathParams": [
|
|
2745
|
-
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
"type": "string",
|
|
2752
|
-
"required": true,
|
|
2753
|
-
"description": "Account subdomain, 8–32 lowercase letters and digits; part of every Worker URL."
|
|
2754
|
-
}
|
|
2755
|
-
]
|
|
2756
|
-
}
|
|
2993
|
+
"pathParams": [
|
|
2994
|
+
{
|
|
2995
|
+
"name": "skill_id",
|
|
2996
|
+
"sdkName": "skill_id"
|
|
2997
|
+
}
|
|
2998
|
+
],
|
|
2999
|
+
"query": []
|
|
2757
3000
|
},
|
|
2758
3001
|
{
|
|
2759
|
-
"resource": "
|
|
3002
|
+
"resource": "agent.skills.versions",
|
|
3003
|
+
"method": "list",
|
|
3004
|
+
"summary": "List skill versions",
|
|
3005
|
+
"description": "List the live versions of one skill, newest first, in pages of at most 100 (default 20). Each item carries the name and description read from the SKILL.md of that version. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
3006
|
+
"http": "GET",
|
|
3007
|
+
"path": "/agent/v1/skills/{skill_id}/versions",
|
|
3008
|
+
"streaming": "no",
|
|
3009
|
+
"pagination": false,
|
|
3010
|
+
"pathParams": [
|
|
3011
|
+
{
|
|
3012
|
+
"name": "skill_id",
|
|
3013
|
+
"sdkName": "skill_id"
|
|
3014
|
+
}
|
|
3015
|
+
],
|
|
3016
|
+
"query": [
|
|
3017
|
+
{
|
|
3018
|
+
"name": "limit",
|
|
3019
|
+
"type": "number",
|
|
3020
|
+
"required": false,
|
|
3021
|
+
"description": "Number of items per page."
|
|
3022
|
+
},
|
|
3023
|
+
{
|
|
3024
|
+
"name": "page",
|
|
3025
|
+
"type": "string",
|
|
3026
|
+
"required": false,
|
|
3027
|
+
"description": "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400."
|
|
3028
|
+
}
|
|
3029
|
+
]
|
|
3030
|
+
},
|
|
3031
|
+
{
|
|
3032
|
+
"resource": "agent.skills.versions",
|
|
3033
|
+
"method": "create",
|
|
3034
|
+
"summary": "Create skill version",
|
|
3035
|
+
"description": "Upload a new version of a skill with the same multipart/form-data shape and limits as skills.create (8 MB, 200 files, one top-level directory containing SKILL.md). The SKILL.md name must equal the name of the skill; a different name returns 400. The new version becomes latest_version_id of the skill, and earlier versions stay unchanged because versions are immutable. Attach it to an agent with `skills` on the agent.",
|
|
3036
|
+
"http": "POST",
|
|
3037
|
+
"path": "/agent/v1/skills/{skill_id}/versions",
|
|
3038
|
+
"streaming": "no",
|
|
3039
|
+
"pagination": false,
|
|
3040
|
+
"multipart": true,
|
|
3041
|
+
"pathParams": [
|
|
3042
|
+
{
|
|
3043
|
+
"name": "skill_id",
|
|
3044
|
+
"sdkName": "skill_id"
|
|
3045
|
+
}
|
|
3046
|
+
],
|
|
3047
|
+
"query": [],
|
|
3048
|
+
"body": {
|
|
3049
|
+
"required": true,
|
|
3050
|
+
"fields": [
|
|
3051
|
+
{
|
|
3052
|
+
"name": "files",
|
|
3053
|
+
"type": "array",
|
|
3054
|
+
"itemType": "string",
|
|
3055
|
+
"required": true,
|
|
3056
|
+
"description": "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory."
|
|
3057
|
+
}
|
|
3058
|
+
]
|
|
3059
|
+
}
|
|
3060
|
+
},
|
|
3061
|
+
{
|
|
3062
|
+
"resource": "agent.skills.versions",
|
|
3063
|
+
"method": "delete",
|
|
3064
|
+
"summary": "Delete skill version",
|
|
3065
|
+
"description": "Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill can be deleted only after all of its versions are deleted. A version that a non-archived agent pins, or the last version of a skill an agent attaches without a pin, returns 409 RESOURCE_IN_USE naming the agents.",
|
|
3066
|
+
"http": "DELETE",
|
|
3067
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
3068
|
+
"streaming": "no",
|
|
3069
|
+
"pagination": false,
|
|
3070
|
+
"pathParams": [
|
|
3071
|
+
{
|
|
3072
|
+
"name": "skill_id",
|
|
3073
|
+
"sdkName": "skill_id"
|
|
3074
|
+
},
|
|
3075
|
+
{
|
|
3076
|
+
"name": "version",
|
|
3077
|
+
"sdkName": "version"
|
|
3078
|
+
}
|
|
3079
|
+
],
|
|
3080
|
+
"query": []
|
|
3081
|
+
},
|
|
3082
|
+
{
|
|
3083
|
+
"resource": "agent.skills.versions",
|
|
3084
|
+
"method": "retrieve",
|
|
3085
|
+
"summary": "Get skill version",
|
|
3086
|
+
"description": "Read one version of a skill: its name, description and created_at as read from SKILL.md. version is the id returned by skills.versions.create or skills.versions.list. A deleted or unknown version returns 404 Skill version not found.",
|
|
3087
|
+
"http": "GET",
|
|
3088
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
3089
|
+
"streaming": "no",
|
|
3090
|
+
"pagination": false,
|
|
3091
|
+
"pathParams": [
|
|
3092
|
+
{
|
|
3093
|
+
"name": "skill_id",
|
|
3094
|
+
"sdkName": "skill_id"
|
|
3095
|
+
},
|
|
3096
|
+
{
|
|
3097
|
+
"name": "version",
|
|
3098
|
+
"sdkName": "version"
|
|
3099
|
+
}
|
|
3100
|
+
],
|
|
3101
|
+
"query": []
|
|
3102
|
+
},
|
|
3103
|
+
{
|
|
3104
|
+
"resource": "agent.skills.versions",
|
|
3105
|
+
"method": "retrieveContent",
|
|
3106
|
+
"summary": "Download skill version",
|
|
3107
|
+
"description": "Download the content of one version as a zip archive (application/zip): the uploaded directory with its top-level folder and every file. version is the id returned by skills.versions.create or skills.versions.list; a deleted version returns 404.",
|
|
3108
|
+
"http": "GET",
|
|
3109
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}/content",
|
|
3110
|
+
"streaming": "no",
|
|
3111
|
+
"pagination": false,
|
|
3112
|
+
"pathParams": [
|
|
3113
|
+
{
|
|
3114
|
+
"name": "skill_id",
|
|
3115
|
+
"sdkName": "skill_id"
|
|
3116
|
+
},
|
|
3117
|
+
{
|
|
3118
|
+
"name": "version",
|
|
3119
|
+
"sdkName": "version"
|
|
3120
|
+
}
|
|
3121
|
+
],
|
|
3122
|
+
"query": []
|
|
3123
|
+
},
|
|
3124
|
+
{
|
|
3125
|
+
"resource": "agent.toolsets",
|
|
3126
|
+
"method": "list",
|
|
3127
|
+
"summary": "List Toolsets",
|
|
3128
|
+
"description": "Discover tool names, input schemas, read-only status and default permission policies before configuring an agent. The catalog is read-only: enable tools through agents.create or agents.update. agent_toolset_20260401 includes bash, edit, glob, grep, read, write, web_search, web_fetch, task_output, task_stop, monitor, agent, send_message, codemode and skill, plus todo_write, enter_plan_mode, ask_user_question and goal_read, which are listed so they can be switched off. Native additions require bash enabled; codemode requires bash (enabling it with bash disabled returns 400; keep bash enabled with permission_policy always_ask to restrict it); send_message also requires agent. To keep only some tools, set default_config.enabled to false and enable the wanted tools in configs; unlisted tools follow default_config. The catalog includes plugin names and versions. Sessions created through /anthropic/v1 expose only the eight official tools.",
|
|
3129
|
+
"http": "GET",
|
|
3130
|
+
"path": "/agent/v1/toolsets",
|
|
3131
|
+
"streaming": "no",
|
|
3132
|
+
"pagination": false,
|
|
3133
|
+
"pathParams": [],
|
|
3134
|
+
"query": []
|
|
3135
|
+
},
|
|
3136
|
+
{
|
|
3137
|
+
"resource": "application.assets.upload",
|
|
3138
|
+
"method": "create",
|
|
3139
|
+
"summary": "Upload assets",
|
|
3140
|
+
"description": "Upload one batch: files maps hash to base64 content. The last batch returns the completion token.",
|
|
3141
|
+
"http": "POST",
|
|
3142
|
+
"path": "/application/v1/assets/upload",
|
|
3143
|
+
"streaming": "no",
|
|
3144
|
+
"pagination": false,
|
|
3145
|
+
"pathParams": [],
|
|
3146
|
+
"query": [],
|
|
3147
|
+
"body": {
|
|
3148
|
+
"required": true,
|
|
3149
|
+
"fields": [
|
|
3150
|
+
{
|
|
3151
|
+
"name": "jwt",
|
|
3152
|
+
"type": "string",
|
|
3153
|
+
"required": true,
|
|
3154
|
+
"description": "Upload token from the session."
|
|
3155
|
+
},
|
|
3156
|
+
{
|
|
3157
|
+
"name": "files",
|
|
3158
|
+
"type": "object",
|
|
3159
|
+
"required": true,
|
|
3160
|
+
"description": "Hash → base64 file content."
|
|
3161
|
+
}
|
|
3162
|
+
]
|
|
3163
|
+
}
|
|
3164
|
+
},
|
|
3165
|
+
{
|
|
3166
|
+
"resource": "application.subdomain",
|
|
3167
|
+
"method": "retrieve",
|
|
3168
|
+
"summary": "Get account subdomain",
|
|
3169
|
+
"description": "Return the account subdomain used in every Worker URL. A default is created on first use.",
|
|
3170
|
+
"http": "GET",
|
|
3171
|
+
"path": "/application/v1/subdomain",
|
|
3172
|
+
"streaming": "no",
|
|
3173
|
+
"pagination": false,
|
|
3174
|
+
"pathParams": [],
|
|
3175
|
+
"query": []
|
|
3176
|
+
},
|
|
3177
|
+
{
|
|
3178
|
+
"resource": "application.subdomain",
|
|
3179
|
+
"method": "update",
|
|
3180
|
+
"summary": "Change account subdomain",
|
|
3181
|
+
"description": "Change the account subdomain. Every Worker moves to the new address at once; old addresses stop resolving.",
|
|
3182
|
+
"http": "PUT",
|
|
3183
|
+
"path": "/application/v1/subdomain",
|
|
3184
|
+
"streaming": "no",
|
|
3185
|
+
"pagination": false,
|
|
3186
|
+
"pathParams": [],
|
|
3187
|
+
"query": [],
|
|
3188
|
+
"body": {
|
|
3189
|
+
"required": true,
|
|
3190
|
+
"fields": [
|
|
3191
|
+
{
|
|
3192
|
+
"name": "subdomain",
|
|
3193
|
+
"type": "string",
|
|
3194
|
+
"required": true,
|
|
3195
|
+
"description": "Account subdomain, 8–32 lowercase letters and digits; part of every Worker URL."
|
|
3196
|
+
}
|
|
3197
|
+
]
|
|
3198
|
+
}
|
|
3199
|
+
},
|
|
3200
|
+
{
|
|
3201
|
+
"resource": "application.workers",
|
|
2760
3202
|
"method": "list",
|
|
2761
3203
|
"summary": "List Workers",
|
|
2762
3204
|
"description": "List Workers in your account. Filter by status or by label with label.<key>=<value>.",
|
|
@@ -3521,13 +3963,13 @@ export const operations = [
|
|
|
3521
3963
|
"name": "namespace",
|
|
3522
3964
|
"type": "string",
|
|
3523
3965
|
"required": true,
|
|
3524
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
3966
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
3525
3967
|
},
|
|
3526
3968
|
{
|
|
3527
3969
|
"name": "name",
|
|
3528
3970
|
"type": "string",
|
|
3529
3971
|
"required": true,
|
|
3530
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3972
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
3531
3973
|
},
|
|
3532
3974
|
{
|
|
3533
3975
|
"name": "description",
|
|
@@ -3590,8 +4032,8 @@ export const operations = [
|
|
|
3590
4032
|
{
|
|
3591
4033
|
"resource": "automation.actions",
|
|
3592
4034
|
"method": "retrieve",
|
|
3593
|
-
"summary": "Get an
|
|
3594
|
-
"description": "Read the
|
|
4035
|
+
"summary": "Get an Action with its current input and output JSON Schemas",
|
|
4036
|
+
"description": "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input). The response ETag is the current revision ID for conditional updates.",
|
|
3595
4037
|
"http": "GET",
|
|
3596
4038
|
"path": "/automation/v1/actions/{ns}/{name}",
|
|
3597
4039
|
"streaming": "no",
|
|
@@ -4165,8 +4607,8 @@ export const operations = [
|
|
|
4165
4607
|
{
|
|
4166
4608
|
"resource": "automation.runs",
|
|
4167
4609
|
"method": "create",
|
|
4168
|
-
"summary": "
|
|
4169
|
-
"description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters
|
|
4610
|
+
"summary": "Run a published target or execute draft source",
|
|
4611
|
+
"description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 7 days. Each run can start at most 100 child runs, with at most 20 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.",
|
|
4170
4612
|
"http": "POST",
|
|
4171
4613
|
"path": "/automation/v1/runs",
|
|
4172
4614
|
"streaming": "no",
|
|
@@ -4644,7 +5086,7 @@ export const operations = [
|
|
|
4644
5086
|
"resource": "automation.scripts",
|
|
4645
5087
|
"method": "create",
|
|
4646
5088
|
"summary": "Create a script",
|
|
4647
|
-
"description": "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is
|
|
5089
|
+
"description": "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.",
|
|
4648
5090
|
"http": "POST",
|
|
4649
5091
|
"path": "/automation/v1/scripts",
|
|
4650
5092
|
"streaming": "no",
|
|
@@ -4658,13 +5100,13 @@ export const operations = [
|
|
|
4658
5100
|
"name": "namespace",
|
|
4659
5101
|
"type": "string",
|
|
4660
5102
|
"required": true,
|
|
4661
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
5103
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
4662
5104
|
},
|
|
4663
5105
|
{
|
|
4664
5106
|
"name": "name",
|
|
4665
5107
|
"type": "string",
|
|
4666
5108
|
"required": true,
|
|
4667
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
5109
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
4668
5110
|
},
|
|
4669
5111
|
{
|
|
4670
5112
|
"name": "description",
|
|
@@ -4712,7 +5154,7 @@ export const operations = [
|
|
|
4712
5154
|
"resource": "automation.scripts",
|
|
4713
5155
|
"method": "update",
|
|
4714
5156
|
"summary": "Update a script draft",
|
|
4715
|
-
"description": "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.",
|
|
5157
|
+
"description": "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist.",
|
|
4716
5158
|
"http": "PATCH",
|
|
4717
5159
|
"path": "/automation/v1/scripts/{ns}/{name}",
|
|
4718
5160
|
"streaming": "no",
|
|
@@ -5666,7 +6108,7 @@ export const operations = [
|
|
|
5666
6108
|
"resource": "automation.workflows",
|
|
5667
6109
|
"method": "create",
|
|
5668
6110
|
"summary": "Create a workflow",
|
|
5669
|
-
"description": "Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is
|
|
6111
|
+
"description": "Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. To test the draft, send its source and language=yaml to praxis.automation.runs.create. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.",
|
|
5670
6112
|
"http": "POST",
|
|
5671
6113
|
"path": "/automation/v1/workflows",
|
|
5672
6114
|
"streaming": "no",
|
|
@@ -5680,13 +6122,13 @@ export const operations = [
|
|
|
5680
6122
|
"name": "namespace",
|
|
5681
6123
|
"type": "string",
|
|
5682
6124
|
"required": true,
|
|
5683
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
6125
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
5684
6126
|
},
|
|
5685
6127
|
{
|
|
5686
6128
|
"name": "name",
|
|
5687
6129
|
"type": "string",
|
|
5688
6130
|
"required": true,
|
|
5689
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
6131
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
5690
6132
|
},
|
|
5691
6133
|
{
|
|
5692
6134
|
"name": "description",
|
|
@@ -6841,7 +7283,7 @@ export const operations = [
|
|
|
6841
7283
|
"name": "{column}",
|
|
6842
7284
|
"type": "string",
|
|
6843
7285
|
"required": false,
|
|
6844
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7286
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
6845
7287
|
},
|
|
6846
7288
|
{
|
|
6847
7289
|
"name": "and",
|
|
@@ -6889,7 +7331,7 @@ export const operations = [
|
|
|
6889
7331
|
"name": "on_conflict",
|
|
6890
7332
|
"type": "string",
|
|
6891
7333
|
"required": false,
|
|
6892
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7334
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
6893
7335
|
},
|
|
6894
7336
|
{
|
|
6895
7337
|
"name": "columns",
|
|
@@ -6903,7 +7345,7 @@ export const operations = [
|
|
|
6903
7345
|
"resource": "database.databases.rest",
|
|
6904
7346
|
"method": "retrieve",
|
|
6905
7347
|
"summary": "Select rows",
|
|
6906
|
-
"description": "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property.
|
|
7348
|
+
"description": "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property. Use praxis.database.count in the SDK or codemode to return { count: number | null }; a page length is not a total unless you know all matches fit in that page.",
|
|
6907
7349
|
"http": "GET",
|
|
6908
7350
|
"path": "/database/v1/databases/{database_id}/rest/{table}",
|
|
6909
7351
|
"streaming": "no",
|
|
@@ -6929,7 +7371,7 @@ export const operations = [
|
|
|
6929
7371
|
"name": "{column}",
|
|
6930
7372
|
"type": "string",
|
|
6931
7373
|
"required": false,
|
|
6932
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7374
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
6933
7375
|
},
|
|
6934
7376
|
{
|
|
6935
7377
|
"name": "and",
|
|
@@ -6977,7 +7419,7 @@ export const operations = [
|
|
|
6977
7419
|
"name": "on_conflict",
|
|
6978
7420
|
"type": "string",
|
|
6979
7421
|
"required": false,
|
|
6980
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7422
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
6981
7423
|
},
|
|
6982
7424
|
{
|
|
6983
7425
|
"name": "columns",
|
|
@@ -6991,7 +7433,7 @@ export const operations = [
|
|
|
6991
7433
|
"resource": "database.databases.rest",
|
|
6992
7434
|
"method": "head",
|
|
6993
7435
|
"summary": "Count rows",
|
|
6994
|
-
"description": "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode.
|
|
7436
|
+
"description": "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Use praxis.database.count in the SDK or codemode to return { count: number | null } from this header without retrieving rows.",
|
|
6995
7437
|
"http": "HEAD",
|
|
6996
7438
|
"path": "/database/v1/databases/{database_id}/rest/{table}",
|
|
6997
7439
|
"streaming": "no",
|
|
@@ -7017,7 +7459,7 @@ export const operations = [
|
|
|
7017
7459
|
"name": "{column}",
|
|
7018
7460
|
"type": "string",
|
|
7019
7461
|
"required": false,
|
|
7020
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7462
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
7021
7463
|
},
|
|
7022
7464
|
{
|
|
7023
7465
|
"name": "and",
|
|
@@ -7065,7 +7507,7 @@ export const operations = [
|
|
|
7065
7507
|
"name": "on_conflict",
|
|
7066
7508
|
"type": "string",
|
|
7067
7509
|
"required": false,
|
|
7068
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7510
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7069
7511
|
},
|
|
7070
7512
|
{
|
|
7071
7513
|
"name": "columns",
|
|
@@ -7105,7 +7547,7 @@ export const operations = [
|
|
|
7105
7547
|
"name": "{column}",
|
|
7106
7548
|
"type": "string",
|
|
7107
7549
|
"required": false,
|
|
7108
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7550
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
7109
7551
|
},
|
|
7110
7552
|
{
|
|
7111
7553
|
"name": "and",
|
|
@@ -7153,7 +7595,7 @@ export const operations = [
|
|
|
7153
7595
|
"name": "on_conflict",
|
|
7154
7596
|
"type": "string",
|
|
7155
7597
|
"required": false,
|
|
7156
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7598
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7157
7599
|
},
|
|
7158
7600
|
{
|
|
7159
7601
|
"name": "columns",
|
|
@@ -7171,7 +7613,7 @@ export const operations = [
|
|
|
7171
7613
|
"resource": "database.databases.rest",
|
|
7172
7614
|
"method": "create",
|
|
7173
7615
|
"summary": "Insert rows",
|
|
7174
|
-
"description": "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.",
|
|
7616
|
+
"description": "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.",
|
|
7175
7617
|
"http": "POST",
|
|
7176
7618
|
"path": "/database/v1/databases/{database_id}/rest/{table}",
|
|
7177
7619
|
"streaming": "no",
|
|
@@ -7197,7 +7639,7 @@ export const operations = [
|
|
|
7197
7639
|
"name": "{column}",
|
|
7198
7640
|
"type": "string",
|
|
7199
7641
|
"required": false,
|
|
7200
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7642
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
7201
7643
|
},
|
|
7202
7644
|
{
|
|
7203
7645
|
"name": "and",
|
|
@@ -7245,7 +7687,7 @@ export const operations = [
|
|
|
7245
7687
|
"name": "on_conflict",
|
|
7246
7688
|
"type": "string",
|
|
7247
7689
|
"required": false,
|
|
7248
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7690
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7249
7691
|
},
|
|
7250
7692
|
{
|
|
7251
7693
|
"name": "columns",
|
|
@@ -7297,7 +7739,7 @@ export const operations = [
|
|
|
7297
7739
|
"resource": "database.databases.tables",
|
|
7298
7740
|
"method": "create",
|
|
7299
7741
|
"summary": "Create table",
|
|
7300
|
-
"description": "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.",
|
|
7742
|
+
"description": "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.",
|
|
7301
7743
|
"http": "POST",
|
|
7302
7744
|
"path": "/database/v1/databases/{database_id}/tables",
|
|
7303
7745
|
"streaming": "no",
|
|
@@ -7418,7 +7860,7 @@ export const operations = [
|
|
|
7418
7860
|
"resource": "database.databases.tables.fields",
|
|
7419
7861
|
"method": "create",
|
|
7420
7862
|
"summary": "Add field",
|
|
7421
|
-
"description": "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row.
|
|
7863
|
+
"description": "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. JSON and link fields cannot be indexed. Limits: 64 fields and 16 indexed or unique fields per table (400 LIMIT_EXCEEDED). Unlike Supabase, schema evolution uses field definitions rather than ALTER TABLE statements or SQL migrations.",
|
|
7422
7864
|
"http": "POST",
|
|
7423
7865
|
"path": "/database/v1/databases/{database_id}/tables/{table}/fields",
|
|
7424
7866
|
"streaming": "no",
|
|
@@ -7587,7 +8029,7 @@ export const operations = [
|
|
|
7587
8029
|
"resource": "file.files",
|
|
7588
8030
|
"method": "create",
|
|
7589
8031
|
"summary": "Upload file",
|
|
7590
|
-
"description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most
|
|
8032
|
+
"description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–2592000), or praxis[expires_in_seconds] (3600–7776000), never both. Without expiry, the file persists until deleted.",
|
|
7591
8033
|
"http": "POST",
|
|
7592
8034
|
"path": "/file/v1/files",
|
|
7593
8035
|
"streaming": "no",
|
|
@@ -7602,7 +8044,7 @@ export const operations = [
|
|
|
7602
8044
|
"name": "file",
|
|
7603
8045
|
"type": "string",
|
|
7604
8046
|
"required": true,
|
|
7605
|
-
"description": "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most
|
|
8047
|
+
"description": "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most 100000000 bytes; its content determines the MIME type."
|
|
7606
8048
|
},
|
|
7607
8049
|
{
|
|
7608
8050
|
"name": "purpose",
|
|
@@ -7651,7 +8093,7 @@ export const operations = [
|
|
|
7651
8093
|
"resource": "file.files",
|
|
7652
8094
|
"method": "retrieve",
|
|
7653
8095
|
"summary": "Retrieve file",
|
|
7654
|
-
"description": "Retrieve metadata for a live file owned by your tenant. Use its
|
|
8096
|
+
"description": "Retrieve metadata for a live file owned by your tenant. Use its file- ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.",
|
|
7655
8097
|
"http": "GET",
|
|
7656
8098
|
"path": "/file/v1/files/{file_id}",
|
|
7657
8099
|
"streaming": "no",
|
|
@@ -7668,7 +8110,7 @@ export const operations = [
|
|
|
7668
8110
|
"resource": "file.files",
|
|
7669
8111
|
"method": "retrieveContent",
|
|
7670
8112
|
"summary": "Retrieve file content",
|
|
7671
|
-
"description": "Download the original bytes of a live file owned by your tenant. Supply its
|
|
8113
|
+
"description": "Download the original bytes of a live file owned by your tenant. Supply its file- ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.",
|
|
7672
8114
|
"http": "GET",
|
|
7673
8115
|
"path": "/file/v1/files/{file_id}/content",
|
|
7674
8116
|
"streaming": "no",
|
|
@@ -7682,63 +8124,12 @@ export const operations = [
|
|
|
7682
8124
|
"query": []
|
|
7683
8125
|
},
|
|
7684
8126
|
{
|
|
7685
|
-
"resource": "
|
|
7686
|
-
"method": "list",
|
|
7687
|
-
"summary": "List knowledge bases",
|
|
7688
|
-
"description": "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.",
|
|
7689
|
-
"http": "GET",
|
|
7690
|
-
"path": "/knowledge/v1/vector_stores",
|
|
7691
|
-
"streaming": "no",
|
|
7692
|
-
"pagination": false,
|
|
7693
|
-
"pathParams": [],
|
|
7694
|
-
"query": [
|
|
7695
|
-
{
|
|
7696
|
-
"name": "status",
|
|
7697
|
-
"type": "string",
|
|
7698
|
-
"enum": [
|
|
7699
|
-
"active",
|
|
7700
|
-
"deleting"
|
|
7701
|
-
],
|
|
7702
|
-
"required": false,
|
|
7703
|
-
"description": "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores."
|
|
7704
|
-
},
|
|
7705
|
-
{
|
|
7706
|
-
"name": "after",
|
|
7707
|
-
"type": "string",
|
|
7708
|
-
"required": false,
|
|
7709
|
-
"description": "Cursor ID from the previous page."
|
|
7710
|
-
},
|
|
7711
|
-
{
|
|
7712
|
-
"name": "before",
|
|
7713
|
-
"type": "string",
|
|
7714
|
-
"required": false,
|
|
7715
|
-
"description": "Return items before this ID."
|
|
7716
|
-
},
|
|
7717
|
-
{
|
|
7718
|
-
"name": "limit",
|
|
7719
|
-
"type": "integer",
|
|
7720
|
-
"required": false,
|
|
7721
|
-
"description": "Page size."
|
|
7722
|
-
},
|
|
7723
|
-
{
|
|
7724
|
-
"name": "order",
|
|
7725
|
-
"type": "string",
|
|
7726
|
-
"enum": [
|
|
7727
|
-
"asc",
|
|
7728
|
-
"desc"
|
|
7729
|
-
],
|
|
7730
|
-
"required": false,
|
|
7731
|
-
"description": "Order by creation time; defaults to desc for stores/files and asc by index for segments."
|
|
7732
|
-
}
|
|
7733
|
-
]
|
|
7734
|
-
},
|
|
7735
|
-
{
|
|
7736
|
-
"resource": "knowledge.vectorStores",
|
|
8127
|
+
"resource": "file.uploads",
|
|
7737
8128
|
"method": "create",
|
|
7738
|
-
"summary": "Create
|
|
7739
|
-
"description": "
|
|
8129
|
+
"summary": "Create an upload",
|
|
8130
|
+
"description": "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
|
|
7740
8131
|
"http": "POST",
|
|
7741
|
-
"path": "/
|
|
8132
|
+
"path": "/file/v1/uploads",
|
|
7742
8133
|
"streaming": "no",
|
|
7743
8134
|
"pagination": false,
|
|
7744
8135
|
"pathParams": [],
|
|
@@ -7747,30 +8138,227 @@ export const operations = [
|
|
|
7747
8138
|
"required": true,
|
|
7748
8139
|
"fields": [
|
|
7749
8140
|
{
|
|
7750
|
-
"name": "
|
|
8141
|
+
"name": "bytes",
|
|
8142
|
+
"type": "integer",
|
|
8143
|
+
"required": true,
|
|
8144
|
+
"description": "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match."
|
|
8145
|
+
},
|
|
8146
|
+
{
|
|
8147
|
+
"name": "filename",
|
|
7751
8148
|
"type": "string",
|
|
7752
|
-
"required":
|
|
7753
|
-
"description": "
|
|
8149
|
+
"required": true,
|
|
8150
|
+
"description": "Filename for the resulting file, at most 255 UTF-8 bytes."
|
|
7754
8151
|
},
|
|
7755
8152
|
{
|
|
7756
|
-
"name": "
|
|
7757
|
-
"type": "
|
|
7758
|
-
"required":
|
|
7759
|
-
"description": "
|
|
8153
|
+
"name": "mime_type",
|
|
8154
|
+
"type": "string",
|
|
8155
|
+
"required": true,
|
|
8156
|
+
"description": "Declared MIME type; validated against the assembled content."
|
|
8157
|
+
},
|
|
8158
|
+
{
|
|
8159
|
+
"name": "purpose",
|
|
8160
|
+
"type": "string",
|
|
8161
|
+
"enum": [
|
|
8162
|
+
"user_data",
|
|
8163
|
+
"assistants",
|
|
8164
|
+
"vision"
|
|
8165
|
+
],
|
|
8166
|
+
"required": true,
|
|
8167
|
+
"description": "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images."
|
|
7760
8168
|
},
|
|
7761
8169
|
{
|
|
7762
8170
|
"name": "expires_after",
|
|
7763
8171
|
"type": "object",
|
|
7764
8172
|
"required": false,
|
|
7765
|
-
"description": "
|
|
8173
|
+
"description": "Optional expiry policy for the resulting file; omission retains the file until deletion."
|
|
7766
8174
|
},
|
|
7767
8175
|
{
|
|
7768
|
-
"name": "
|
|
7769
|
-
"type": "
|
|
7770
|
-
"itemType": "string",
|
|
8176
|
+
"name": "part_size",
|
|
8177
|
+
"type": "integer",
|
|
7771
8178
|
"required": false,
|
|
7772
|
-
"description": "
|
|
7773
|
-
}
|
|
8179
|
+
"description": "Optional fixed part size in bytes, 5242880–64000000. Requires part_number on every part; retries of identical bytes at the same number return the same part. Omit to use arbitrary-sized parts."
|
|
8180
|
+
}
|
|
8181
|
+
]
|
|
8182
|
+
}
|
|
8183
|
+
},
|
|
8184
|
+
{
|
|
8185
|
+
"resource": "file.uploads",
|
|
8186
|
+
"method": "cancel",
|
|
8187
|
+
"summary": "Cancel an upload",
|
|
8188
|
+
"description": "Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.",
|
|
8189
|
+
"http": "POST",
|
|
8190
|
+
"path": "/file/v1/uploads/{upload_id}/cancel",
|
|
8191
|
+
"streaming": "no",
|
|
8192
|
+
"pagination": false,
|
|
8193
|
+
"pathParams": [
|
|
8194
|
+
{
|
|
8195
|
+
"name": "upload_id",
|
|
8196
|
+
"sdkName": "upload_id"
|
|
8197
|
+
}
|
|
8198
|
+
],
|
|
8199
|
+
"query": []
|
|
8200
|
+
},
|
|
8201
|
+
{
|
|
8202
|
+
"resource": "file.uploads",
|
|
8203
|
+
"method": "complete",
|
|
8204
|
+
"summary": "Complete an upload",
|
|
8205
|
+
"description": "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
|
|
8206
|
+
"http": "POST",
|
|
8207
|
+
"path": "/file/v1/uploads/{upload_id}/complete",
|
|
8208
|
+
"streaming": "no",
|
|
8209
|
+
"pagination": false,
|
|
8210
|
+
"pathParams": [
|
|
8211
|
+
{
|
|
8212
|
+
"name": "upload_id",
|
|
8213
|
+
"sdkName": "upload_id"
|
|
8214
|
+
}
|
|
8215
|
+
],
|
|
8216
|
+
"query": [],
|
|
8217
|
+
"body": {
|
|
8218
|
+
"required": true,
|
|
8219
|
+
"fields": [
|
|
8220
|
+
{
|
|
8221
|
+
"name": "part_ids",
|
|
8222
|
+
"type": "array",
|
|
8223
|
+
"itemType": "string",
|
|
8224
|
+
"required": true,
|
|
8225
|
+
"description": "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order."
|
|
8226
|
+
},
|
|
8227
|
+
{
|
|
8228
|
+
"name": "md5",
|
|
8229
|
+
"type": "string",
|
|
8230
|
+
"required": false,
|
|
8231
|
+
"description": "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly."
|
|
8232
|
+
}
|
|
8233
|
+
]
|
|
8234
|
+
}
|
|
8235
|
+
},
|
|
8236
|
+
{
|
|
8237
|
+
"resource": "file.uploads.parts",
|
|
8238
|
+
"method": "create",
|
|
8239
|
+
"summary": "Add an upload part",
|
|
8240
|
+
"description": "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
|
|
8241
|
+
"http": "POST",
|
|
8242
|
+
"path": "/file/v1/uploads/{upload_id}/parts",
|
|
8243
|
+
"streaming": "no",
|
|
8244
|
+
"pagination": false,
|
|
8245
|
+
"multipart": true,
|
|
8246
|
+
"pathParams": [
|
|
8247
|
+
{
|
|
8248
|
+
"name": "upload_id",
|
|
8249
|
+
"sdkName": "upload_id"
|
|
8250
|
+
}
|
|
8251
|
+
],
|
|
8252
|
+
"query": [
|
|
8253
|
+
{
|
|
8254
|
+
"name": "part_number",
|
|
8255
|
+
"type": "integer",
|
|
8256
|
+
"required": false,
|
|
8257
|
+
"description": "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads."
|
|
8258
|
+
}
|
|
8259
|
+
],
|
|
8260
|
+
"body": {
|
|
8261
|
+
"required": true,
|
|
8262
|
+
"fields": [
|
|
8263
|
+
{
|
|
8264
|
+
"name": "data",
|
|
8265
|
+
"type": "string",
|
|
8266
|
+
"required": true,
|
|
8267
|
+
"description": "Raw bytes of this part, nonempty and at most 64000000 bytes."
|
|
8268
|
+
}
|
|
8269
|
+
]
|
|
8270
|
+
}
|
|
8271
|
+
},
|
|
8272
|
+
{
|
|
8273
|
+
"resource": "knowledge.vectorStores",
|
|
8274
|
+
"method": "list",
|
|
8275
|
+
"summary": "List knowledge bases",
|
|
8276
|
+
"description": "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.",
|
|
8277
|
+
"http": "GET",
|
|
8278
|
+
"path": "/knowledge/v1/vector_stores",
|
|
8279
|
+
"streaming": "no",
|
|
8280
|
+
"pagination": false,
|
|
8281
|
+
"pathParams": [],
|
|
8282
|
+
"query": [
|
|
8283
|
+
{
|
|
8284
|
+
"name": "status",
|
|
8285
|
+
"type": "string",
|
|
8286
|
+
"enum": [
|
|
8287
|
+
"active",
|
|
8288
|
+
"deleting"
|
|
8289
|
+
],
|
|
8290
|
+
"required": false,
|
|
8291
|
+
"description": "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores."
|
|
8292
|
+
},
|
|
8293
|
+
{
|
|
8294
|
+
"name": "after",
|
|
8295
|
+
"type": "string",
|
|
8296
|
+
"required": false,
|
|
8297
|
+
"description": "Cursor ID from the previous page."
|
|
8298
|
+
},
|
|
8299
|
+
{
|
|
8300
|
+
"name": "before",
|
|
8301
|
+
"type": "string",
|
|
8302
|
+
"required": false,
|
|
8303
|
+
"description": "Return items before this ID."
|
|
8304
|
+
},
|
|
8305
|
+
{
|
|
8306
|
+
"name": "limit",
|
|
8307
|
+
"type": "integer",
|
|
8308
|
+
"required": false,
|
|
8309
|
+
"description": "Page size."
|
|
8310
|
+
},
|
|
8311
|
+
{
|
|
8312
|
+
"name": "order",
|
|
8313
|
+
"type": "string",
|
|
8314
|
+
"enum": [
|
|
8315
|
+
"asc",
|
|
8316
|
+
"desc"
|
|
8317
|
+
],
|
|
8318
|
+
"required": false,
|
|
8319
|
+
"description": "Order by creation time; defaults to desc for stores/files and asc by index for segments."
|
|
8320
|
+
}
|
|
8321
|
+
]
|
|
8322
|
+
},
|
|
8323
|
+
{
|
|
8324
|
+
"resource": "knowledge.vectorStores",
|
|
8325
|
+
"method": "create",
|
|
8326
|
+
"summary": "Create knowledge base",
|
|
8327
|
+
"description": "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Unlike OpenAI vector stores, each file is limited to 100000000 bytes and each account to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.",
|
|
8328
|
+
"http": "POST",
|
|
8329
|
+
"path": "/knowledge/v1/vector_stores",
|
|
8330
|
+
"streaming": "no",
|
|
8331
|
+
"pagination": false,
|
|
8332
|
+
"pathParams": [],
|
|
8333
|
+
"query": [],
|
|
8334
|
+
"body": {
|
|
8335
|
+
"required": true,
|
|
8336
|
+
"fields": [
|
|
8337
|
+
{
|
|
8338
|
+
"name": "name",
|
|
8339
|
+
"type": "string",
|
|
8340
|
+
"required": false,
|
|
8341
|
+
"description": "Omitted name becomes an empty string; null is rejected."
|
|
8342
|
+
},
|
|
8343
|
+
{
|
|
8344
|
+
"name": "metadata",
|
|
8345
|
+
"type": "object",
|
|
8346
|
+
"required": false,
|
|
8347
|
+
"description": "User-defined string metadata for the store; omission or null creates an empty map."
|
|
8348
|
+
},
|
|
8349
|
+
{
|
|
8350
|
+
"name": "expires_after",
|
|
8351
|
+
"type": "object",
|
|
8352
|
+
"required": false,
|
|
8353
|
+
"description": "Expiry policy from last activity; omission or null disables automatic expiry."
|
|
8354
|
+
},
|
|
8355
|
+
{
|
|
8356
|
+
"name": "file_ids",
|
|
8357
|
+
"type": "array",
|
|
8358
|
+
"itemType": "string",
|
|
8359
|
+
"required": false,
|
|
8360
|
+
"description": "Existing File IDs to attach; the store allows up to 10,000 files."
|
|
8361
|
+
},
|
|
7774
8362
|
{
|
|
7775
8363
|
"name": "chunking_strategy",
|
|
7776
8364
|
"type": "object",
|
|
@@ -11811,7 +12399,7 @@ export const operations = [
|
|
|
11811
12399
|
"name": "message",
|
|
11812
12400
|
"type": "string",
|
|
11813
12401
|
"required": true,
|
|
11814
|
-
"description": "Problem description
|
|
12402
|
+
"description": "Problem description, at most 4096 Unicode code points; may be empty only when contexts.praxis.error.message is a non-empty string."
|
|
11815
12403
|
},
|
|
11816
12404
|
{
|
|
11817
12405
|
"name": "contact_email",
|
|
@@ -12109,7 +12697,7 @@ export const operations = [
|
|
|
12109
12697
|
"resource": "sandbox.sandboxes",
|
|
12110
12698
|
"method": "create",
|
|
12111
12699
|
"summary": "Create sandbox (v2)",
|
|
12112
|
-
"description": "
|
|
12700
|
+
"description": "Create a sandbox from the template. All system communication with the sandbox is secured.",
|
|
12113
12701
|
"http": "POST",
|
|
12114
12702
|
"path": "/sandbox/v1/sandboxes",
|
|
12115
12703
|
"streaming": "no",
|
|
@@ -12123,7 +12711,7 @@ export const operations = [
|
|
|
12123
12711
|
"name": "templateID",
|
|
12124
12712
|
"type": "string",
|
|
12125
12713
|
"required": true,
|
|
12126
|
-
"description": "
|
|
12714
|
+
"description": "Identifier of the required template"
|
|
12127
12715
|
},
|
|
12128
12716
|
{
|
|
12129
12717
|
"name": "timeout",
|
|
@@ -12261,7 +12849,7 @@ export const operations = [
|
|
|
12261
12849
|
"resource": "sandbox.sandboxes",
|
|
12262
12850
|
"method": "connect",
|
|
12263
12851
|
"summary": "Connect sandbox (v2)",
|
|
12264
|
-
"description": "
|
|
12852
|
+
"description": "Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.",
|
|
12265
12853
|
"http": "POST",
|
|
12266
12854
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/connect",
|
|
12267
12855
|
"streaming": "no",
|
|
@@ -12420,7 +13008,7 @@ export const operations = [
|
|
|
12420
13008
|
"resource": "sandbox.sandboxes.metrics",
|
|
12421
13009
|
"method": "list",
|
|
12422
13010
|
"summary": "Sandbox metrics",
|
|
12423
|
-
"description": "Read CPU, memory and disk usage over
|
|
13011
|
+
"description": "Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.",
|
|
12424
13012
|
"http": "GET",
|
|
12425
13013
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/metrics",
|
|
12426
13014
|
"streaming": "no",
|
|
@@ -12504,7 +13092,7 @@ export const operations = [
|
|
|
12504
13092
|
"resource": "sandbox.sandboxes",
|
|
12505
13093
|
"method": "pause",
|
|
12506
13094
|
"summary": "Pause sandbox",
|
|
12507
|
-
"description": "
|
|
13095
|
+
"description": "Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.",
|
|
12508
13096
|
"http": "POST",
|
|
12509
13097
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/pause",
|
|
12510
13098
|
"streaming": "no",
|
|
@@ -12896,7 +13484,7 @@ export const operations = [
|
|
|
12896
13484
|
"resource": "sandbox.templates",
|
|
12897
13485
|
"method": "list",
|
|
12898
13486
|
"summary": "List templates (v2)",
|
|
12899
|
-
"description": "
|
|
13487
|
+
"description": "List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.",
|
|
12900
13488
|
"http": "GET",
|
|
12901
13489
|
"path": "/sandbox/v1/templates",
|
|
12902
13490
|
"streaming": "no",
|
|
@@ -13657,6 +14245,1466 @@ export const operations = [
|
|
|
13657
14245
|
]
|
|
13658
14246
|
}
|
|
13659
14247
|
},
|
|
14248
|
+
{
|
|
14249
|
+
"resource": "ticket.activity",
|
|
14250
|
+
"method": "retrieve",
|
|
14251
|
+
"summary": "List activity",
|
|
14252
|
+
"description": "List activity within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14253
|
+
"http": "GET",
|
|
14254
|
+
"path": "/ticket/v1/activity",
|
|
14255
|
+
"streaming": "no",
|
|
14256
|
+
"pagination": false,
|
|
14257
|
+
"pathParams": [],
|
|
14258
|
+
"query": [
|
|
14259
|
+
{
|
|
14260
|
+
"name": "repository",
|
|
14261
|
+
"type": "string",
|
|
14262
|
+
"required": false,
|
|
14263
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14264
|
+
},
|
|
14265
|
+
{
|
|
14266
|
+
"name": "page_size",
|
|
14267
|
+
"type": "integer",
|
|
14268
|
+
"required": false,
|
|
14269
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14270
|
+
},
|
|
14271
|
+
{
|
|
14272
|
+
"name": "page_token",
|
|
14273
|
+
"type": "string",
|
|
14274
|
+
"required": false,
|
|
14275
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14276
|
+
},
|
|
14277
|
+
{
|
|
14278
|
+
"name": "filter",
|
|
14279
|
+
"type": "string",
|
|
14280
|
+
"required": false,
|
|
14281
|
+
"description": "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service."
|
|
14282
|
+
}
|
|
14283
|
+
]
|
|
14284
|
+
},
|
|
14285
|
+
{
|
|
14286
|
+
"resource": "ticket.comments",
|
|
14287
|
+
"method": "delete",
|
|
14288
|
+
"summary": "Remove comments",
|
|
14289
|
+
"description": "Remove comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14290
|
+
"http": "DELETE",
|
|
14291
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14292
|
+
"streaming": "no",
|
|
14293
|
+
"pagination": false,
|
|
14294
|
+
"pathParams": [
|
|
14295
|
+
{
|
|
14296
|
+
"name": "id",
|
|
14297
|
+
"sdkName": "id"
|
|
14298
|
+
}
|
|
14299
|
+
],
|
|
14300
|
+
"query": [
|
|
14301
|
+
{
|
|
14302
|
+
"name": "repository",
|
|
14303
|
+
"type": "string",
|
|
14304
|
+
"required": false,
|
|
14305
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14306
|
+
}
|
|
14307
|
+
]
|
|
14308
|
+
},
|
|
14309
|
+
{
|
|
14310
|
+
"resource": "ticket.comments",
|
|
14311
|
+
"method": "retrieve",
|
|
14312
|
+
"summary": "Read comments",
|
|
14313
|
+
"description": "Read comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14314
|
+
"http": "GET",
|
|
14315
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14316
|
+
"streaming": "no",
|
|
14317
|
+
"pagination": false,
|
|
14318
|
+
"pathParams": [
|
|
14319
|
+
{
|
|
14320
|
+
"name": "id",
|
|
14321
|
+
"sdkName": "id"
|
|
14322
|
+
}
|
|
14323
|
+
],
|
|
14324
|
+
"query": [
|
|
14325
|
+
{
|
|
14326
|
+
"name": "repository",
|
|
14327
|
+
"type": "string",
|
|
14328
|
+
"required": false,
|
|
14329
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14330
|
+
}
|
|
14331
|
+
]
|
|
14332
|
+
},
|
|
14333
|
+
{
|
|
14334
|
+
"resource": "ticket.comments",
|
|
14335
|
+
"method": "update",
|
|
14336
|
+
"summary": "Update comments",
|
|
14337
|
+
"description": "Update comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14338
|
+
"http": "PATCH",
|
|
14339
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14340
|
+
"streaming": "no",
|
|
14341
|
+
"pagination": false,
|
|
14342
|
+
"pathParams": [
|
|
14343
|
+
{
|
|
14344
|
+
"name": "id",
|
|
14345
|
+
"sdkName": "id"
|
|
14346
|
+
}
|
|
14347
|
+
],
|
|
14348
|
+
"query": [
|
|
14349
|
+
{
|
|
14350
|
+
"name": "repository",
|
|
14351
|
+
"type": "string",
|
|
14352
|
+
"required": false,
|
|
14353
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14354
|
+
}
|
|
14355
|
+
],
|
|
14356
|
+
"body": {
|
|
14357
|
+
"required": true,
|
|
14358
|
+
"fields": [
|
|
14359
|
+
{
|
|
14360
|
+
"name": "body",
|
|
14361
|
+
"type": "string",
|
|
14362
|
+
"required": true,
|
|
14363
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14364
|
+
},
|
|
14365
|
+
{
|
|
14366
|
+
"name": "in_reply_to",
|
|
14367
|
+
"type": "string",
|
|
14368
|
+
"required": false,
|
|
14369
|
+
"description": "Opaque identifier returned by this resource's create or list operation."
|
|
14370
|
+
}
|
|
14371
|
+
]
|
|
14372
|
+
}
|
|
14373
|
+
},
|
|
14374
|
+
{
|
|
14375
|
+
"resource": "ticket.comments.reactions",
|
|
14376
|
+
"method": "list",
|
|
14377
|
+
"summary": "List reactions",
|
|
14378
|
+
"description": "List reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14379
|
+
"http": "GET",
|
|
14380
|
+
"path": "/ticket/v1/comments/{id}/reactions",
|
|
14381
|
+
"streaming": "no",
|
|
14382
|
+
"pagination": false,
|
|
14383
|
+
"pathParams": [
|
|
14384
|
+
{
|
|
14385
|
+
"name": "id",
|
|
14386
|
+
"sdkName": "id"
|
|
14387
|
+
}
|
|
14388
|
+
],
|
|
14389
|
+
"query": [
|
|
14390
|
+
{
|
|
14391
|
+
"name": "repository",
|
|
14392
|
+
"type": "string",
|
|
14393
|
+
"required": false,
|
|
14394
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14395
|
+
},
|
|
14396
|
+
{
|
|
14397
|
+
"name": "page_size",
|
|
14398
|
+
"type": "integer",
|
|
14399
|
+
"required": false,
|
|
14400
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14401
|
+
},
|
|
14402
|
+
{
|
|
14403
|
+
"name": "page_token",
|
|
14404
|
+
"type": "string",
|
|
14405
|
+
"required": false,
|
|
14406
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14407
|
+
}
|
|
14408
|
+
]
|
|
14409
|
+
},
|
|
14410
|
+
{
|
|
14411
|
+
"resource": "ticket.comments.reactions",
|
|
14412
|
+
"method": "create",
|
|
14413
|
+
"summary": "Create or add reactions",
|
|
14414
|
+
"description": "Create or add reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14415
|
+
"http": "POST",
|
|
14416
|
+
"path": "/ticket/v1/comments/{id}/reactions",
|
|
14417
|
+
"streaming": "no",
|
|
14418
|
+
"pagination": false,
|
|
14419
|
+
"pathParams": [
|
|
14420
|
+
{
|
|
14421
|
+
"name": "id",
|
|
14422
|
+
"sdkName": "id"
|
|
14423
|
+
}
|
|
14424
|
+
],
|
|
14425
|
+
"query": [
|
|
14426
|
+
{
|
|
14427
|
+
"name": "repository",
|
|
14428
|
+
"type": "string",
|
|
14429
|
+
"required": false,
|
|
14430
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14431
|
+
}
|
|
14432
|
+
],
|
|
14433
|
+
"body": {
|
|
14434
|
+
"required": true,
|
|
14435
|
+
"fields": [
|
|
14436
|
+
{
|
|
14437
|
+
"name": "content",
|
|
14438
|
+
"type": "string",
|
|
14439
|
+
"enum": [
|
|
14440
|
+
"+1",
|
|
14441
|
+
"-1",
|
|
14442
|
+
"laugh",
|
|
14443
|
+
"confused",
|
|
14444
|
+
"heart",
|
|
14445
|
+
"hooray",
|
|
14446
|
+
"eyes",
|
|
14447
|
+
"rocket"
|
|
14448
|
+
],
|
|
14449
|
+
"required": true,
|
|
14450
|
+
"description": "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket."
|
|
14451
|
+
}
|
|
14452
|
+
]
|
|
14453
|
+
}
|
|
14454
|
+
},
|
|
14455
|
+
{
|
|
14456
|
+
"resource": "ticket.comments.reactions",
|
|
14457
|
+
"method": "delete",
|
|
14458
|
+
"summary": "Remove reactions",
|
|
14459
|
+
"description": "Remove reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14460
|
+
"http": "DELETE",
|
|
14461
|
+
"path": "/ticket/v1/comments/{id}/reactions/{content}",
|
|
14462
|
+
"streaming": "no",
|
|
14463
|
+
"pagination": false,
|
|
14464
|
+
"pathParams": [
|
|
14465
|
+
{
|
|
14466
|
+
"name": "id",
|
|
14467
|
+
"sdkName": "id"
|
|
14468
|
+
},
|
|
14469
|
+
{
|
|
14470
|
+
"name": "content",
|
|
14471
|
+
"sdkName": "content"
|
|
14472
|
+
}
|
|
14473
|
+
],
|
|
14474
|
+
"query": [
|
|
14475
|
+
{
|
|
14476
|
+
"name": "repository",
|
|
14477
|
+
"type": "string",
|
|
14478
|
+
"required": false,
|
|
14479
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14480
|
+
}
|
|
14481
|
+
]
|
|
14482
|
+
},
|
|
14483
|
+
{
|
|
14484
|
+
"resource": "ticket.labels",
|
|
14485
|
+
"method": "list",
|
|
14486
|
+
"summary": "List labels",
|
|
14487
|
+
"description": "List labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14488
|
+
"http": "GET",
|
|
14489
|
+
"path": "/ticket/v1/labels",
|
|
14490
|
+
"streaming": "no",
|
|
14491
|
+
"pagination": false,
|
|
14492
|
+
"pathParams": [],
|
|
14493
|
+
"query": [
|
|
14494
|
+
{
|
|
14495
|
+
"name": "repository",
|
|
14496
|
+
"type": "string",
|
|
14497
|
+
"required": false,
|
|
14498
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14499
|
+
},
|
|
14500
|
+
{
|
|
14501
|
+
"name": "page_size",
|
|
14502
|
+
"type": "integer",
|
|
14503
|
+
"required": false,
|
|
14504
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14505
|
+
},
|
|
14506
|
+
{
|
|
14507
|
+
"name": "page_token",
|
|
14508
|
+
"type": "string",
|
|
14509
|
+
"required": false,
|
|
14510
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14511
|
+
}
|
|
14512
|
+
]
|
|
14513
|
+
},
|
|
14514
|
+
{
|
|
14515
|
+
"resource": "ticket.labels",
|
|
14516
|
+
"method": "create",
|
|
14517
|
+
"summary": "Create or add labels",
|
|
14518
|
+
"description": "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14519
|
+
"http": "POST",
|
|
14520
|
+
"path": "/ticket/v1/labels",
|
|
14521
|
+
"streaming": "no",
|
|
14522
|
+
"pagination": false,
|
|
14523
|
+
"pathParams": [],
|
|
14524
|
+
"query": [
|
|
14525
|
+
{
|
|
14526
|
+
"name": "repository",
|
|
14527
|
+
"type": "string",
|
|
14528
|
+
"required": false,
|
|
14529
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14530
|
+
}
|
|
14531
|
+
],
|
|
14532
|
+
"body": {
|
|
14533
|
+
"required": true,
|
|
14534
|
+
"fields": [
|
|
14535
|
+
{
|
|
14536
|
+
"name": "name",
|
|
14537
|
+
"type": "string",
|
|
14538
|
+
"required": true,
|
|
14539
|
+
"description": "Case-insensitive label name within the repository."
|
|
14540
|
+
},
|
|
14541
|
+
{
|
|
14542
|
+
"name": "color",
|
|
14543
|
+
"type": "string",
|
|
14544
|
+
"required": true,
|
|
14545
|
+
"description": "Six hexadecimal digits without #."
|
|
14546
|
+
},
|
|
14547
|
+
{
|
|
14548
|
+
"name": "description",
|
|
14549
|
+
"type": "string",
|
|
14550
|
+
"required": false,
|
|
14551
|
+
"description": "Label's purpose."
|
|
14552
|
+
}
|
|
14553
|
+
]
|
|
14554
|
+
}
|
|
14555
|
+
},
|
|
14556
|
+
{
|
|
14557
|
+
"resource": "ticket.labels",
|
|
14558
|
+
"method": "delete",
|
|
14559
|
+
"summary": "Remove labels",
|
|
14560
|
+
"description": "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14561
|
+
"http": "DELETE",
|
|
14562
|
+
"path": "/ticket/v1/labels/{name}",
|
|
14563
|
+
"streaming": "no",
|
|
14564
|
+
"pagination": false,
|
|
14565
|
+
"pathParams": [
|
|
14566
|
+
{
|
|
14567
|
+
"name": "name",
|
|
14568
|
+
"sdkName": "name"
|
|
14569
|
+
}
|
|
14570
|
+
],
|
|
14571
|
+
"query": [
|
|
14572
|
+
{
|
|
14573
|
+
"name": "repository",
|
|
14574
|
+
"type": "string",
|
|
14575
|
+
"required": false,
|
|
14576
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14577
|
+
}
|
|
14578
|
+
]
|
|
14579
|
+
},
|
|
14580
|
+
{
|
|
14581
|
+
"resource": "ticket.labels",
|
|
14582
|
+
"method": "update",
|
|
14583
|
+
"summary": "Update labels",
|
|
14584
|
+
"description": "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14585
|
+
"http": "PATCH",
|
|
14586
|
+
"path": "/ticket/v1/labels/{name}",
|
|
14587
|
+
"streaming": "no",
|
|
14588
|
+
"pagination": false,
|
|
14589
|
+
"pathParams": [
|
|
14590
|
+
{
|
|
14591
|
+
"name": "name",
|
|
14592
|
+
"sdkName": "name"
|
|
14593
|
+
}
|
|
14594
|
+
],
|
|
14595
|
+
"query": [
|
|
14596
|
+
{
|
|
14597
|
+
"name": "repository",
|
|
14598
|
+
"type": "string",
|
|
14599
|
+
"required": false,
|
|
14600
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14601
|
+
}
|
|
14602
|
+
],
|
|
14603
|
+
"body": {
|
|
14604
|
+
"required": true,
|
|
14605
|
+
"fields": [
|
|
14606
|
+
{
|
|
14607
|
+
"name": "color",
|
|
14608
|
+
"type": "string",
|
|
14609
|
+
"required": false,
|
|
14610
|
+
"description": "Six hexadecimal digits without #."
|
|
14611
|
+
},
|
|
14612
|
+
{
|
|
14613
|
+
"name": "description",
|
|
14614
|
+
"type": "string",
|
|
14615
|
+
"required": false,
|
|
14616
|
+
"description": "Label's purpose."
|
|
14617
|
+
},
|
|
14618
|
+
{
|
|
14619
|
+
"name": "new_name",
|
|
14620
|
+
"type": "string",
|
|
14621
|
+
"required": false,
|
|
14622
|
+
"description": "Case-insensitive label name within the repository."
|
|
14623
|
+
}
|
|
14624
|
+
]
|
|
14625
|
+
}
|
|
14626
|
+
},
|
|
14627
|
+
{
|
|
14628
|
+
"resource": "ticket.milestones",
|
|
14629
|
+
"method": "list",
|
|
14630
|
+
"summary": "List milestones",
|
|
14631
|
+
"description": "List milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14632
|
+
"http": "GET",
|
|
14633
|
+
"path": "/ticket/v1/milestones",
|
|
14634
|
+
"streaming": "no",
|
|
14635
|
+
"pagination": false,
|
|
14636
|
+
"pathParams": [],
|
|
14637
|
+
"query": [
|
|
14638
|
+
{
|
|
14639
|
+
"name": "repository",
|
|
14640
|
+
"type": "string",
|
|
14641
|
+
"required": false,
|
|
14642
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14643
|
+
},
|
|
14644
|
+
{
|
|
14645
|
+
"name": "page_size",
|
|
14646
|
+
"type": "integer",
|
|
14647
|
+
"required": false,
|
|
14648
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14649
|
+
},
|
|
14650
|
+
{
|
|
14651
|
+
"name": "page_token",
|
|
14652
|
+
"type": "string",
|
|
14653
|
+
"required": false,
|
|
14654
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14655
|
+
}
|
|
14656
|
+
]
|
|
14657
|
+
},
|
|
14658
|
+
{
|
|
14659
|
+
"resource": "ticket.milestones",
|
|
14660
|
+
"method": "create",
|
|
14661
|
+
"summary": "Create or add milestones",
|
|
14662
|
+
"description": "Create or add milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14663
|
+
"http": "POST",
|
|
14664
|
+
"path": "/ticket/v1/milestones",
|
|
14665
|
+
"streaming": "no",
|
|
14666
|
+
"pagination": false,
|
|
14667
|
+
"pathParams": [],
|
|
14668
|
+
"query": [
|
|
14669
|
+
{
|
|
14670
|
+
"name": "repository",
|
|
14671
|
+
"type": "string",
|
|
14672
|
+
"required": false,
|
|
14673
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14674
|
+
}
|
|
14675
|
+
],
|
|
14676
|
+
"body": {
|
|
14677
|
+
"required": true,
|
|
14678
|
+
"fields": [
|
|
14679
|
+
{
|
|
14680
|
+
"name": "title",
|
|
14681
|
+
"type": "string",
|
|
14682
|
+
"required": true,
|
|
14683
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14684
|
+
},
|
|
14685
|
+
{
|
|
14686
|
+
"name": "description",
|
|
14687
|
+
"type": "string",
|
|
14688
|
+
"required": false,
|
|
14689
|
+
"description": "Milestone description."
|
|
14690
|
+
},
|
|
14691
|
+
{
|
|
14692
|
+
"name": "due_on",
|
|
14693
|
+
"type": "string",
|
|
14694
|
+
"required": false,
|
|
14695
|
+
"description": "Due date, or null if unset."
|
|
14696
|
+
},
|
|
14697
|
+
{
|
|
14698
|
+
"name": "state",
|
|
14699
|
+
"type": "string",
|
|
14700
|
+
"enum": [
|
|
14701
|
+
"open",
|
|
14702
|
+
"closed"
|
|
14703
|
+
],
|
|
14704
|
+
"required": false,
|
|
14705
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14706
|
+
}
|
|
14707
|
+
]
|
|
14708
|
+
}
|
|
14709
|
+
},
|
|
14710
|
+
{
|
|
14711
|
+
"resource": "ticket.milestones",
|
|
14712
|
+
"method": "delete",
|
|
14713
|
+
"summary": "Remove milestones",
|
|
14714
|
+
"description": "Remove milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14715
|
+
"http": "DELETE",
|
|
14716
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14717
|
+
"streaming": "no",
|
|
14718
|
+
"pagination": false,
|
|
14719
|
+
"pathParams": [
|
|
14720
|
+
{
|
|
14721
|
+
"name": "number",
|
|
14722
|
+
"sdkName": "number"
|
|
14723
|
+
}
|
|
14724
|
+
],
|
|
14725
|
+
"query": [
|
|
14726
|
+
{
|
|
14727
|
+
"name": "repository",
|
|
14728
|
+
"type": "string",
|
|
14729
|
+
"required": false,
|
|
14730
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14731
|
+
}
|
|
14732
|
+
]
|
|
14733
|
+
},
|
|
14734
|
+
{
|
|
14735
|
+
"resource": "ticket.milestones",
|
|
14736
|
+
"method": "retrieve",
|
|
14737
|
+
"summary": "Read milestones",
|
|
14738
|
+
"description": "Read milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14739
|
+
"http": "GET",
|
|
14740
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14741
|
+
"streaming": "no",
|
|
14742
|
+
"pagination": false,
|
|
14743
|
+
"pathParams": [
|
|
14744
|
+
{
|
|
14745
|
+
"name": "number",
|
|
14746
|
+
"sdkName": "number"
|
|
14747
|
+
}
|
|
14748
|
+
],
|
|
14749
|
+
"query": [
|
|
14750
|
+
{
|
|
14751
|
+
"name": "repository",
|
|
14752
|
+
"type": "string",
|
|
14753
|
+
"required": false,
|
|
14754
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14755
|
+
}
|
|
14756
|
+
]
|
|
14757
|
+
},
|
|
14758
|
+
{
|
|
14759
|
+
"resource": "ticket.milestones",
|
|
14760
|
+
"method": "update",
|
|
14761
|
+
"summary": "Update milestones",
|
|
14762
|
+
"description": "Update milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14763
|
+
"http": "PATCH",
|
|
14764
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14765
|
+
"streaming": "no",
|
|
14766
|
+
"pagination": false,
|
|
14767
|
+
"pathParams": [
|
|
14768
|
+
{
|
|
14769
|
+
"name": "number",
|
|
14770
|
+
"sdkName": "number"
|
|
14771
|
+
}
|
|
14772
|
+
],
|
|
14773
|
+
"query": [
|
|
14774
|
+
{
|
|
14775
|
+
"name": "repository",
|
|
14776
|
+
"type": "string",
|
|
14777
|
+
"required": false,
|
|
14778
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14779
|
+
}
|
|
14780
|
+
],
|
|
14781
|
+
"body": {
|
|
14782
|
+
"required": true,
|
|
14783
|
+
"fields": [
|
|
14784
|
+
{
|
|
14785
|
+
"name": "title",
|
|
14786
|
+
"type": "string",
|
|
14787
|
+
"required": false,
|
|
14788
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14789
|
+
},
|
|
14790
|
+
{
|
|
14791
|
+
"name": "description",
|
|
14792
|
+
"type": "string",
|
|
14793
|
+
"required": false,
|
|
14794
|
+
"description": "Milestone description."
|
|
14795
|
+
},
|
|
14796
|
+
{
|
|
14797
|
+
"name": "due_on",
|
|
14798
|
+
"type": "string",
|
|
14799
|
+
"required": false,
|
|
14800
|
+
"description": "Due date, or null if unset."
|
|
14801
|
+
},
|
|
14802
|
+
{
|
|
14803
|
+
"name": "state",
|
|
14804
|
+
"type": "string",
|
|
14805
|
+
"enum": [
|
|
14806
|
+
"open",
|
|
14807
|
+
"closed"
|
|
14808
|
+
],
|
|
14809
|
+
"required": false,
|
|
14810
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14811
|
+
}
|
|
14812
|
+
]
|
|
14813
|
+
}
|
|
14814
|
+
},
|
|
14815
|
+
{
|
|
14816
|
+
"resource": "ticket.repositories",
|
|
14817
|
+
"method": "list",
|
|
14818
|
+
"summary": "List repositories",
|
|
14819
|
+
"description": "List repositories within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14820
|
+
"http": "GET",
|
|
14821
|
+
"path": "/ticket/v1/repositories",
|
|
14822
|
+
"streaming": "no",
|
|
14823
|
+
"pagination": false,
|
|
14824
|
+
"pathParams": [],
|
|
14825
|
+
"query": [
|
|
14826
|
+
{
|
|
14827
|
+
"name": "page_size",
|
|
14828
|
+
"type": "integer",
|
|
14829
|
+
"required": false,
|
|
14830
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14831
|
+
},
|
|
14832
|
+
{
|
|
14833
|
+
"name": "page_token",
|
|
14834
|
+
"type": "string",
|
|
14835
|
+
"required": false,
|
|
14836
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14837
|
+
}
|
|
14838
|
+
]
|
|
14839
|
+
},
|
|
14840
|
+
{
|
|
14841
|
+
"resource": "ticket.tickets",
|
|
14842
|
+
"method": "list",
|
|
14843
|
+
"summary": "List tickets",
|
|
14844
|
+
"description": "List tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14845
|
+
"http": "GET",
|
|
14846
|
+
"path": "/ticket/v1/tickets",
|
|
14847
|
+
"streaming": "no",
|
|
14848
|
+
"pagination": false,
|
|
14849
|
+
"pathParams": [],
|
|
14850
|
+
"query": [
|
|
14851
|
+
{
|
|
14852
|
+
"name": "repository",
|
|
14853
|
+
"type": "string",
|
|
14854
|
+
"required": false,
|
|
14855
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14856
|
+
},
|
|
14857
|
+
{
|
|
14858
|
+
"name": "page_size",
|
|
14859
|
+
"type": "integer",
|
|
14860
|
+
"required": false,
|
|
14861
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14862
|
+
},
|
|
14863
|
+
{
|
|
14864
|
+
"name": "page_token",
|
|
14865
|
+
"type": "string",
|
|
14866
|
+
"required": false,
|
|
14867
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14868
|
+
},
|
|
14869
|
+
{
|
|
14870
|
+
"name": "filter",
|
|
14871
|
+
"type": "string",
|
|
14872
|
+
"required": false,
|
|
14873
|
+
"description": "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service."
|
|
14874
|
+
}
|
|
14875
|
+
]
|
|
14876
|
+
},
|
|
14877
|
+
{
|
|
14878
|
+
"resource": "ticket.tickets",
|
|
14879
|
+
"method": "create",
|
|
14880
|
+
"summary": "Create or add tickets",
|
|
14881
|
+
"description": "Create or add tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14882
|
+
"http": "POST",
|
|
14883
|
+
"path": "/ticket/v1/tickets",
|
|
14884
|
+
"streaming": "no",
|
|
14885
|
+
"pagination": false,
|
|
14886
|
+
"pathParams": [],
|
|
14887
|
+
"query": [
|
|
14888
|
+
{
|
|
14889
|
+
"name": "repository",
|
|
14890
|
+
"type": "string",
|
|
14891
|
+
"required": false,
|
|
14892
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14893
|
+
}
|
|
14894
|
+
],
|
|
14895
|
+
"body": {
|
|
14896
|
+
"required": true,
|
|
14897
|
+
"fields": [
|
|
14898
|
+
{
|
|
14899
|
+
"name": "title",
|
|
14900
|
+
"type": "string",
|
|
14901
|
+
"required": true,
|
|
14902
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14903
|
+
},
|
|
14904
|
+
{
|
|
14905
|
+
"name": "body",
|
|
14906
|
+
"type": "string",
|
|
14907
|
+
"required": false,
|
|
14908
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14909
|
+
},
|
|
14910
|
+
{
|
|
14911
|
+
"name": "type",
|
|
14912
|
+
"type": "string",
|
|
14913
|
+
"required": false,
|
|
14914
|
+
"description": "Built-in type name; null clears an existing type."
|
|
14915
|
+
},
|
|
14916
|
+
{
|
|
14917
|
+
"name": "labels",
|
|
14918
|
+
"type": "array",
|
|
14919
|
+
"itemType": "string",
|
|
14920
|
+
"required": false,
|
|
14921
|
+
"description": "Labels attached to this ticket; updates replace the complete list."
|
|
14922
|
+
},
|
|
14923
|
+
{
|
|
14924
|
+
"name": "assignees",
|
|
14925
|
+
"type": "array",
|
|
14926
|
+
"itemType": "string",
|
|
14927
|
+
"required": false,
|
|
14928
|
+
"description": "Complete assignee list, at most ten."
|
|
14929
|
+
},
|
|
14930
|
+
{
|
|
14931
|
+
"name": "milestone",
|
|
14932
|
+
"type": "integer",
|
|
14933
|
+
"required": false,
|
|
14934
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14935
|
+
},
|
|
14936
|
+
{
|
|
14937
|
+
"name": "parent",
|
|
14938
|
+
"type": "integer",
|
|
14939
|
+
"required": false,
|
|
14940
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14941
|
+
}
|
|
14942
|
+
]
|
|
14943
|
+
}
|
|
14944
|
+
},
|
|
14945
|
+
{
|
|
14946
|
+
"resource": "ticket.tickets",
|
|
14947
|
+
"method": "retrieve",
|
|
14948
|
+
"summary": "Read tickets",
|
|
14949
|
+
"description": "Read tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14950
|
+
"http": "GET",
|
|
14951
|
+
"path": "/ticket/v1/tickets/{number}",
|
|
14952
|
+
"streaming": "no",
|
|
14953
|
+
"pagination": false,
|
|
14954
|
+
"pathParams": [
|
|
14955
|
+
{
|
|
14956
|
+
"name": "number",
|
|
14957
|
+
"sdkName": "number"
|
|
14958
|
+
}
|
|
14959
|
+
],
|
|
14960
|
+
"query": [
|
|
14961
|
+
{
|
|
14962
|
+
"name": "repository",
|
|
14963
|
+
"type": "string",
|
|
14964
|
+
"required": false,
|
|
14965
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14966
|
+
}
|
|
14967
|
+
]
|
|
14968
|
+
},
|
|
14969
|
+
{
|
|
14970
|
+
"resource": "ticket.tickets",
|
|
14971
|
+
"method": "update",
|
|
14972
|
+
"summary": "Update tickets",
|
|
14973
|
+
"description": "Update tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14974
|
+
"http": "PATCH",
|
|
14975
|
+
"path": "/ticket/v1/tickets/{number}",
|
|
14976
|
+
"streaming": "no",
|
|
14977
|
+
"pagination": false,
|
|
14978
|
+
"pathParams": [
|
|
14979
|
+
{
|
|
14980
|
+
"name": "number",
|
|
14981
|
+
"sdkName": "number"
|
|
14982
|
+
}
|
|
14983
|
+
],
|
|
14984
|
+
"query": [
|
|
14985
|
+
{
|
|
14986
|
+
"name": "repository",
|
|
14987
|
+
"type": "string",
|
|
14988
|
+
"required": false,
|
|
14989
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14990
|
+
}
|
|
14991
|
+
],
|
|
14992
|
+
"body": {
|
|
14993
|
+
"required": true,
|
|
14994
|
+
"fields": [
|
|
14995
|
+
{
|
|
14996
|
+
"name": "title",
|
|
14997
|
+
"type": "string",
|
|
14998
|
+
"required": false,
|
|
14999
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
15000
|
+
},
|
|
15001
|
+
{
|
|
15002
|
+
"name": "body",
|
|
15003
|
+
"type": "string",
|
|
15004
|
+
"required": false,
|
|
15005
|
+
"description": "Markdown text, at most 65536 characters."
|
|
15006
|
+
},
|
|
15007
|
+
{
|
|
15008
|
+
"name": "type",
|
|
15009
|
+
"type": "string",
|
|
15010
|
+
"required": false,
|
|
15011
|
+
"description": "Built-in type name; null clears an existing type."
|
|
15012
|
+
},
|
|
15013
|
+
{
|
|
15014
|
+
"name": "labels",
|
|
15015
|
+
"type": "array",
|
|
15016
|
+
"itemType": "string",
|
|
15017
|
+
"required": false,
|
|
15018
|
+
"description": "Labels attached to this ticket; updates replace the complete list."
|
|
15019
|
+
},
|
|
15020
|
+
{
|
|
15021
|
+
"name": "assignees",
|
|
15022
|
+
"type": "array",
|
|
15023
|
+
"itemType": "string",
|
|
15024
|
+
"required": false,
|
|
15025
|
+
"description": "Complete assignee list, at most ten."
|
|
15026
|
+
},
|
|
15027
|
+
{
|
|
15028
|
+
"name": "milestone",
|
|
15029
|
+
"type": "integer",
|
|
15030
|
+
"required": false,
|
|
15031
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15032
|
+
},
|
|
15033
|
+
{
|
|
15034
|
+
"name": "state",
|
|
15035
|
+
"type": "string",
|
|
15036
|
+
"enum": [
|
|
15037
|
+
"open",
|
|
15038
|
+
"closed"
|
|
15039
|
+
],
|
|
15040
|
+
"required": false,
|
|
15041
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
15042
|
+
},
|
|
15043
|
+
{
|
|
15044
|
+
"name": "state_reason",
|
|
15045
|
+
"type": "string",
|
|
15046
|
+
"enum": [
|
|
15047
|
+
"completed",
|
|
15048
|
+
"not_planned",
|
|
15049
|
+
"duplicate"
|
|
15050
|
+
],
|
|
15051
|
+
"required": false,
|
|
15052
|
+
"description": "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate."
|
|
15053
|
+
},
|
|
15054
|
+
{
|
|
15055
|
+
"name": "duplicate_of",
|
|
15056
|
+
"type": "integer",
|
|
15057
|
+
"required": false,
|
|
15058
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15059
|
+
}
|
|
15060
|
+
]
|
|
15061
|
+
}
|
|
15062
|
+
},
|
|
15063
|
+
{
|
|
15064
|
+
"resource": "ticket.tickets.comments",
|
|
15065
|
+
"method": "list",
|
|
15066
|
+
"summary": "List comments",
|
|
15067
|
+
"description": "List comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15068
|
+
"http": "GET",
|
|
15069
|
+
"path": "/ticket/v1/tickets/{number}/comments",
|
|
15070
|
+
"streaming": "no",
|
|
15071
|
+
"pagination": false,
|
|
15072
|
+
"pathParams": [
|
|
15073
|
+
{
|
|
15074
|
+
"name": "number",
|
|
15075
|
+
"sdkName": "number"
|
|
15076
|
+
}
|
|
15077
|
+
],
|
|
15078
|
+
"query": [
|
|
15079
|
+
{
|
|
15080
|
+
"name": "repository",
|
|
15081
|
+
"type": "string",
|
|
15082
|
+
"required": false,
|
|
15083
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15084
|
+
},
|
|
15085
|
+
{
|
|
15086
|
+
"name": "page_size",
|
|
15087
|
+
"type": "integer",
|
|
15088
|
+
"required": false,
|
|
15089
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15090
|
+
},
|
|
15091
|
+
{
|
|
15092
|
+
"name": "page_token",
|
|
15093
|
+
"type": "string",
|
|
15094
|
+
"required": false,
|
|
15095
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15096
|
+
}
|
|
15097
|
+
]
|
|
15098
|
+
},
|
|
15099
|
+
{
|
|
15100
|
+
"resource": "ticket.tickets.comments",
|
|
15101
|
+
"method": "create",
|
|
15102
|
+
"summary": "Create or add comments",
|
|
15103
|
+
"description": "Create or add comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15104
|
+
"http": "POST",
|
|
15105
|
+
"path": "/ticket/v1/tickets/{number}/comments",
|
|
15106
|
+
"streaming": "no",
|
|
15107
|
+
"pagination": false,
|
|
15108
|
+
"pathParams": [
|
|
15109
|
+
{
|
|
15110
|
+
"name": "number",
|
|
15111
|
+
"sdkName": "number"
|
|
15112
|
+
}
|
|
15113
|
+
],
|
|
15114
|
+
"query": [
|
|
15115
|
+
{
|
|
15116
|
+
"name": "repository",
|
|
15117
|
+
"type": "string",
|
|
15118
|
+
"required": false,
|
|
15119
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15120
|
+
}
|
|
15121
|
+
],
|
|
15122
|
+
"body": {
|
|
15123
|
+
"required": true,
|
|
15124
|
+
"fields": [
|
|
15125
|
+
{
|
|
15126
|
+
"name": "body",
|
|
15127
|
+
"type": "string",
|
|
15128
|
+
"required": true,
|
|
15129
|
+
"description": "Markdown text, at most 65536 characters."
|
|
15130
|
+
},
|
|
15131
|
+
{
|
|
15132
|
+
"name": "in_reply_to",
|
|
15133
|
+
"type": "string",
|
|
15134
|
+
"required": false,
|
|
15135
|
+
"description": "Opaque identifier returned by this resource's create or list operation."
|
|
15136
|
+
}
|
|
15137
|
+
]
|
|
15138
|
+
}
|
|
15139
|
+
},
|
|
15140
|
+
{
|
|
15141
|
+
"resource": "ticket.tickets.dependencies",
|
|
15142
|
+
"method": "retrieveBlockedBy",
|
|
15143
|
+
"summary": "List blocked by",
|
|
15144
|
+
"description": "List blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15145
|
+
"http": "GET",
|
|
15146
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by",
|
|
15147
|
+
"streaming": "no",
|
|
15148
|
+
"pagination": false,
|
|
15149
|
+
"pathParams": [
|
|
15150
|
+
{
|
|
15151
|
+
"name": "number",
|
|
15152
|
+
"sdkName": "number"
|
|
15153
|
+
}
|
|
15154
|
+
],
|
|
15155
|
+
"query": [
|
|
15156
|
+
{
|
|
15157
|
+
"name": "repository",
|
|
15158
|
+
"type": "string",
|
|
15159
|
+
"required": false,
|
|
15160
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15161
|
+
},
|
|
15162
|
+
{
|
|
15163
|
+
"name": "page_size",
|
|
15164
|
+
"type": "integer",
|
|
15165
|
+
"required": false,
|
|
15166
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15167
|
+
},
|
|
15168
|
+
{
|
|
15169
|
+
"name": "page_token",
|
|
15170
|
+
"type": "string",
|
|
15171
|
+
"required": false,
|
|
15172
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15173
|
+
}
|
|
15174
|
+
]
|
|
15175
|
+
},
|
|
15176
|
+
{
|
|
15177
|
+
"resource": "ticket.tickets.dependencies.blockedBy",
|
|
15178
|
+
"method": "create",
|
|
15179
|
+
"summary": "Create or add blocked by",
|
|
15180
|
+
"description": "Create or add blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15181
|
+
"http": "POST",
|
|
15182
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by",
|
|
15183
|
+
"streaming": "no",
|
|
15184
|
+
"pagination": false,
|
|
15185
|
+
"pathParams": [
|
|
15186
|
+
{
|
|
15187
|
+
"name": "number",
|
|
15188
|
+
"sdkName": "number"
|
|
15189
|
+
}
|
|
15190
|
+
],
|
|
15191
|
+
"query": [
|
|
15192
|
+
{
|
|
15193
|
+
"name": "repository",
|
|
15194
|
+
"type": "string",
|
|
15195
|
+
"required": false,
|
|
15196
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15197
|
+
}
|
|
15198
|
+
],
|
|
15199
|
+
"body": {
|
|
15200
|
+
"required": true,
|
|
15201
|
+
"fields": [
|
|
15202
|
+
{
|
|
15203
|
+
"name": "blocked_by",
|
|
15204
|
+
"type": "integer",
|
|
15205
|
+
"required": true,
|
|
15206
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15207
|
+
}
|
|
15208
|
+
]
|
|
15209
|
+
}
|
|
15210
|
+
},
|
|
15211
|
+
{
|
|
15212
|
+
"resource": "ticket.tickets.dependencies.blockedBy",
|
|
15213
|
+
"method": "delete",
|
|
15214
|
+
"summary": "Remove blocked by",
|
|
15215
|
+
"description": "Remove blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15216
|
+
"http": "DELETE",
|
|
15217
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}",
|
|
15218
|
+
"streaming": "no",
|
|
15219
|
+
"pagination": false,
|
|
15220
|
+
"pathParams": [
|
|
15221
|
+
{
|
|
15222
|
+
"name": "number",
|
|
15223
|
+
"sdkName": "number"
|
|
15224
|
+
},
|
|
15225
|
+
{
|
|
15226
|
+
"name": "n",
|
|
15227
|
+
"sdkName": "n"
|
|
15228
|
+
}
|
|
15229
|
+
],
|
|
15230
|
+
"query": [
|
|
15231
|
+
{
|
|
15232
|
+
"name": "repository",
|
|
15233
|
+
"type": "string",
|
|
15234
|
+
"required": false,
|
|
15235
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15236
|
+
}
|
|
15237
|
+
]
|
|
15238
|
+
},
|
|
15239
|
+
{
|
|
15240
|
+
"resource": "ticket.tickets.dependencies",
|
|
15241
|
+
"method": "retrieveBlocking",
|
|
15242
|
+
"summary": "List blocking",
|
|
15243
|
+
"description": "List blocking within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15244
|
+
"http": "GET",
|
|
15245
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocking",
|
|
15246
|
+
"streaming": "no",
|
|
15247
|
+
"pagination": false,
|
|
15248
|
+
"pathParams": [
|
|
15249
|
+
{
|
|
15250
|
+
"name": "number",
|
|
15251
|
+
"sdkName": "number"
|
|
15252
|
+
}
|
|
15253
|
+
],
|
|
15254
|
+
"query": [
|
|
15255
|
+
{
|
|
15256
|
+
"name": "repository",
|
|
15257
|
+
"type": "string",
|
|
15258
|
+
"required": false,
|
|
15259
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15260
|
+
},
|
|
15261
|
+
{
|
|
15262
|
+
"name": "page_size",
|
|
15263
|
+
"type": "integer",
|
|
15264
|
+
"required": false,
|
|
15265
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15266
|
+
},
|
|
15267
|
+
{
|
|
15268
|
+
"name": "page_token",
|
|
15269
|
+
"type": "string",
|
|
15270
|
+
"required": false,
|
|
15271
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15272
|
+
}
|
|
15273
|
+
]
|
|
15274
|
+
},
|
|
15275
|
+
{
|
|
15276
|
+
"resource": "ticket.tickets.events",
|
|
15277
|
+
"method": "list",
|
|
15278
|
+
"summary": "List events",
|
|
15279
|
+
"description": "List events within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15280
|
+
"http": "GET",
|
|
15281
|
+
"path": "/ticket/v1/tickets/{number}/events",
|
|
15282
|
+
"streaming": "no",
|
|
15283
|
+
"pagination": false,
|
|
15284
|
+
"pathParams": [
|
|
15285
|
+
{
|
|
15286
|
+
"name": "number",
|
|
15287
|
+
"sdkName": "number"
|
|
15288
|
+
}
|
|
15289
|
+
],
|
|
15290
|
+
"query": [
|
|
15291
|
+
{
|
|
15292
|
+
"name": "repository",
|
|
15293
|
+
"type": "string",
|
|
15294
|
+
"required": false,
|
|
15295
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15296
|
+
},
|
|
15297
|
+
{
|
|
15298
|
+
"name": "page_size",
|
|
15299
|
+
"type": "integer",
|
|
15300
|
+
"required": false,
|
|
15301
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15302
|
+
},
|
|
15303
|
+
{
|
|
15304
|
+
"name": "page_token",
|
|
15305
|
+
"type": "string",
|
|
15306
|
+
"required": false,
|
|
15307
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15308
|
+
}
|
|
15309
|
+
]
|
|
15310
|
+
},
|
|
15311
|
+
{
|
|
15312
|
+
"resource": "ticket.tickets",
|
|
15313
|
+
"method": "deleteLock",
|
|
15314
|
+
"summary": "Remove lock",
|
|
15315
|
+
"description": "Remove lock within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
15316
|
+
"http": "DELETE",
|
|
15317
|
+
"path": "/ticket/v1/tickets/{number}/lock",
|
|
15318
|
+
"streaming": "no",
|
|
15319
|
+
"pagination": false,
|
|
15320
|
+
"pathParams": [
|
|
15321
|
+
{
|
|
15322
|
+
"name": "number",
|
|
15323
|
+
"sdkName": "number"
|
|
15324
|
+
}
|
|
15325
|
+
],
|
|
15326
|
+
"query": [
|
|
15327
|
+
{
|
|
15328
|
+
"name": "repository",
|
|
15329
|
+
"type": "string",
|
|
15330
|
+
"required": false,
|
|
15331
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15332
|
+
}
|
|
15333
|
+
]
|
|
15334
|
+
},
|
|
15335
|
+
{
|
|
15336
|
+
"resource": "ticket.tickets",
|
|
15337
|
+
"method": "updateLock",
|
|
15338
|
+
"summary": "Update lock",
|
|
15339
|
+
"description": "Update lock within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
15340
|
+
"http": "PUT",
|
|
15341
|
+
"path": "/ticket/v1/tickets/{number}/lock",
|
|
15342
|
+
"streaming": "no",
|
|
15343
|
+
"pagination": false,
|
|
15344
|
+
"pathParams": [
|
|
15345
|
+
{
|
|
15346
|
+
"name": "number",
|
|
15347
|
+
"sdkName": "number"
|
|
15348
|
+
}
|
|
15349
|
+
],
|
|
15350
|
+
"query": [
|
|
15351
|
+
{
|
|
15352
|
+
"name": "repository",
|
|
15353
|
+
"type": "string",
|
|
15354
|
+
"required": false,
|
|
15355
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15356
|
+
}
|
|
15357
|
+
],
|
|
15358
|
+
"body": {
|
|
15359
|
+
"required": false,
|
|
15360
|
+
"fields": [
|
|
15361
|
+
{
|
|
15362
|
+
"name": "lock_reason",
|
|
15363
|
+
"type": "string",
|
|
15364
|
+
"enum": [
|
|
15365
|
+
"off-topic",
|
|
15366
|
+
"too heated",
|
|
15367
|
+
"resolved",
|
|
15368
|
+
"spam"
|
|
15369
|
+
],
|
|
15370
|
+
"required": false,
|
|
15371
|
+
"description": "Reason for locking: off-topic, too heated, resolved, or spam."
|
|
15372
|
+
}
|
|
15373
|
+
]
|
|
15374
|
+
}
|
|
15375
|
+
},
|
|
15376
|
+
{
|
|
15377
|
+
"resource": "ticket.tickets.reactions",
|
|
15378
|
+
"method": "list",
|
|
15379
|
+
"summary": "List reactions",
|
|
15380
|
+
"description": "List reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15381
|
+
"http": "GET",
|
|
15382
|
+
"path": "/ticket/v1/tickets/{number}/reactions",
|
|
15383
|
+
"streaming": "no",
|
|
15384
|
+
"pagination": false,
|
|
15385
|
+
"pathParams": [
|
|
15386
|
+
{
|
|
15387
|
+
"name": "number",
|
|
15388
|
+
"sdkName": "number"
|
|
15389
|
+
}
|
|
15390
|
+
],
|
|
15391
|
+
"query": [
|
|
15392
|
+
{
|
|
15393
|
+
"name": "repository",
|
|
15394
|
+
"type": "string",
|
|
15395
|
+
"required": false,
|
|
15396
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15397
|
+
},
|
|
15398
|
+
{
|
|
15399
|
+
"name": "page_size",
|
|
15400
|
+
"type": "integer",
|
|
15401
|
+
"required": false,
|
|
15402
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15403
|
+
},
|
|
15404
|
+
{
|
|
15405
|
+
"name": "page_token",
|
|
15406
|
+
"type": "string",
|
|
15407
|
+
"required": false,
|
|
15408
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15409
|
+
}
|
|
15410
|
+
]
|
|
15411
|
+
},
|
|
15412
|
+
{
|
|
15413
|
+
"resource": "ticket.tickets.reactions",
|
|
15414
|
+
"method": "create",
|
|
15415
|
+
"summary": "Create or add reactions",
|
|
15416
|
+
"description": "Create or add reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15417
|
+
"http": "POST",
|
|
15418
|
+
"path": "/ticket/v1/tickets/{number}/reactions",
|
|
15419
|
+
"streaming": "no",
|
|
15420
|
+
"pagination": false,
|
|
15421
|
+
"pathParams": [
|
|
15422
|
+
{
|
|
15423
|
+
"name": "number",
|
|
15424
|
+
"sdkName": "number"
|
|
15425
|
+
}
|
|
15426
|
+
],
|
|
15427
|
+
"query": [
|
|
15428
|
+
{
|
|
15429
|
+
"name": "repository",
|
|
15430
|
+
"type": "string",
|
|
15431
|
+
"required": false,
|
|
15432
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15433
|
+
}
|
|
15434
|
+
],
|
|
15435
|
+
"body": {
|
|
15436
|
+
"required": true,
|
|
15437
|
+
"fields": [
|
|
15438
|
+
{
|
|
15439
|
+
"name": "content",
|
|
15440
|
+
"type": "string",
|
|
15441
|
+
"enum": [
|
|
15442
|
+
"+1",
|
|
15443
|
+
"-1",
|
|
15444
|
+
"laugh",
|
|
15445
|
+
"confused",
|
|
15446
|
+
"heart",
|
|
15447
|
+
"hooray",
|
|
15448
|
+
"eyes",
|
|
15449
|
+
"rocket"
|
|
15450
|
+
],
|
|
15451
|
+
"required": true,
|
|
15452
|
+
"description": "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket."
|
|
15453
|
+
}
|
|
15454
|
+
]
|
|
15455
|
+
}
|
|
15456
|
+
},
|
|
15457
|
+
{
|
|
15458
|
+
"resource": "ticket.tickets.reactions",
|
|
15459
|
+
"method": "delete",
|
|
15460
|
+
"summary": "Remove reactions",
|
|
15461
|
+
"description": "Remove reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15462
|
+
"http": "DELETE",
|
|
15463
|
+
"path": "/ticket/v1/tickets/{number}/reactions/{content}",
|
|
15464
|
+
"streaming": "no",
|
|
15465
|
+
"pagination": false,
|
|
15466
|
+
"pathParams": [
|
|
15467
|
+
{
|
|
15468
|
+
"name": "number",
|
|
15469
|
+
"sdkName": "number"
|
|
15470
|
+
},
|
|
15471
|
+
{
|
|
15472
|
+
"name": "content",
|
|
15473
|
+
"sdkName": "content"
|
|
15474
|
+
}
|
|
15475
|
+
],
|
|
15476
|
+
"query": [
|
|
15477
|
+
{
|
|
15478
|
+
"name": "repository",
|
|
15479
|
+
"type": "string",
|
|
15480
|
+
"required": false,
|
|
15481
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15482
|
+
}
|
|
15483
|
+
]
|
|
15484
|
+
},
|
|
15485
|
+
{
|
|
15486
|
+
"resource": "ticket.tickets.relations",
|
|
15487
|
+
"method": "list",
|
|
15488
|
+
"summary": "List relations",
|
|
15489
|
+
"description": "List relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15490
|
+
"http": "GET",
|
|
15491
|
+
"path": "/ticket/v1/tickets/{number}/relations",
|
|
15492
|
+
"streaming": "no",
|
|
15493
|
+
"pagination": false,
|
|
15494
|
+
"pathParams": [
|
|
15495
|
+
{
|
|
15496
|
+
"name": "number",
|
|
15497
|
+
"sdkName": "number"
|
|
15498
|
+
}
|
|
15499
|
+
],
|
|
15500
|
+
"query": [
|
|
15501
|
+
{
|
|
15502
|
+
"name": "repository",
|
|
15503
|
+
"type": "string",
|
|
15504
|
+
"required": false,
|
|
15505
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15506
|
+
},
|
|
15507
|
+
{
|
|
15508
|
+
"name": "page_size",
|
|
15509
|
+
"type": "integer",
|
|
15510
|
+
"required": false,
|
|
15511
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15512
|
+
},
|
|
15513
|
+
{
|
|
15514
|
+
"name": "page_token",
|
|
15515
|
+
"type": "string",
|
|
15516
|
+
"required": false,
|
|
15517
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15518
|
+
}
|
|
15519
|
+
]
|
|
15520
|
+
},
|
|
15521
|
+
{
|
|
15522
|
+
"resource": "ticket.tickets.relations",
|
|
15523
|
+
"method": "create",
|
|
15524
|
+
"summary": "Create or add relations",
|
|
15525
|
+
"description": "Create or add relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15526
|
+
"http": "POST",
|
|
15527
|
+
"path": "/ticket/v1/tickets/{number}/relations",
|
|
15528
|
+
"streaming": "no",
|
|
15529
|
+
"pagination": false,
|
|
15530
|
+
"pathParams": [
|
|
15531
|
+
{
|
|
15532
|
+
"name": "number",
|
|
15533
|
+
"sdkName": "number"
|
|
15534
|
+
}
|
|
15535
|
+
],
|
|
15536
|
+
"query": [
|
|
15537
|
+
{
|
|
15538
|
+
"name": "repository",
|
|
15539
|
+
"type": "string",
|
|
15540
|
+
"required": false,
|
|
15541
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15542
|
+
}
|
|
15543
|
+
],
|
|
15544
|
+
"body": {
|
|
15545
|
+
"required": true,
|
|
15546
|
+
"fields": [
|
|
15547
|
+
{
|
|
15548
|
+
"name": "relates_to",
|
|
15549
|
+
"type": "integer",
|
|
15550
|
+
"required": true,
|
|
15551
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15552
|
+
}
|
|
15553
|
+
]
|
|
15554
|
+
}
|
|
15555
|
+
},
|
|
15556
|
+
{
|
|
15557
|
+
"resource": "ticket.tickets.relations",
|
|
15558
|
+
"method": "delete",
|
|
15559
|
+
"summary": "Remove relations",
|
|
15560
|
+
"description": "Remove relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15561
|
+
"http": "DELETE",
|
|
15562
|
+
"path": "/ticket/v1/tickets/{number}/relations/{n}",
|
|
15563
|
+
"streaming": "no",
|
|
15564
|
+
"pagination": false,
|
|
15565
|
+
"pathParams": [
|
|
15566
|
+
{
|
|
15567
|
+
"name": "number",
|
|
15568
|
+
"sdkName": "number"
|
|
15569
|
+
},
|
|
15570
|
+
{
|
|
15571
|
+
"name": "n",
|
|
15572
|
+
"sdkName": "n"
|
|
15573
|
+
}
|
|
15574
|
+
],
|
|
15575
|
+
"query": [
|
|
15576
|
+
{
|
|
15577
|
+
"name": "repository",
|
|
15578
|
+
"type": "string",
|
|
15579
|
+
"required": false,
|
|
15580
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15581
|
+
}
|
|
15582
|
+
]
|
|
15583
|
+
},
|
|
15584
|
+
{
|
|
15585
|
+
"resource": "ticket.tickets.subTickets",
|
|
15586
|
+
"method": "list",
|
|
15587
|
+
"summary": "List sub tickets",
|
|
15588
|
+
"description": "List sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15589
|
+
"http": "GET",
|
|
15590
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets",
|
|
15591
|
+
"streaming": "no",
|
|
15592
|
+
"pagination": false,
|
|
15593
|
+
"pathParams": [
|
|
15594
|
+
{
|
|
15595
|
+
"name": "number",
|
|
15596
|
+
"sdkName": "number"
|
|
15597
|
+
}
|
|
15598
|
+
],
|
|
15599
|
+
"query": [
|
|
15600
|
+
{
|
|
15601
|
+
"name": "repository",
|
|
15602
|
+
"type": "string",
|
|
15603
|
+
"required": false,
|
|
15604
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15605
|
+
},
|
|
15606
|
+
{
|
|
15607
|
+
"name": "page_size",
|
|
15608
|
+
"type": "integer",
|
|
15609
|
+
"required": false,
|
|
15610
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15611
|
+
},
|
|
15612
|
+
{
|
|
15613
|
+
"name": "page_token",
|
|
15614
|
+
"type": "string",
|
|
15615
|
+
"required": false,
|
|
15616
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15617
|
+
}
|
|
15618
|
+
]
|
|
15619
|
+
},
|
|
15620
|
+
{
|
|
15621
|
+
"resource": "ticket.tickets.subTickets",
|
|
15622
|
+
"method": "create",
|
|
15623
|
+
"summary": "Create or add sub tickets",
|
|
15624
|
+
"description": "Create or add sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15625
|
+
"http": "POST",
|
|
15626
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets",
|
|
15627
|
+
"streaming": "no",
|
|
15628
|
+
"pagination": false,
|
|
15629
|
+
"pathParams": [
|
|
15630
|
+
{
|
|
15631
|
+
"name": "number",
|
|
15632
|
+
"sdkName": "number"
|
|
15633
|
+
}
|
|
15634
|
+
],
|
|
15635
|
+
"query": [
|
|
15636
|
+
{
|
|
15637
|
+
"name": "repository",
|
|
15638
|
+
"type": "string",
|
|
15639
|
+
"required": false,
|
|
15640
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15641
|
+
}
|
|
15642
|
+
],
|
|
15643
|
+
"body": {
|
|
15644
|
+
"required": true,
|
|
15645
|
+
"fields": [
|
|
15646
|
+
{
|
|
15647
|
+
"name": "child",
|
|
15648
|
+
"type": "integer",
|
|
15649
|
+
"required": true,
|
|
15650
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15651
|
+
},
|
|
15652
|
+
{
|
|
15653
|
+
"name": "replace_parent",
|
|
15654
|
+
"type": "boolean",
|
|
15655
|
+
"required": false,
|
|
15656
|
+
"description": "Allow replacing an existing parent."
|
|
15657
|
+
}
|
|
15658
|
+
]
|
|
15659
|
+
}
|
|
15660
|
+
},
|
|
15661
|
+
{
|
|
15662
|
+
"resource": "ticket.tickets.subTickets",
|
|
15663
|
+
"method": "delete",
|
|
15664
|
+
"summary": "Remove sub tickets",
|
|
15665
|
+
"description": "Remove sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15666
|
+
"http": "DELETE",
|
|
15667
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets/{child}",
|
|
15668
|
+
"streaming": "no",
|
|
15669
|
+
"pagination": false,
|
|
15670
|
+
"pathParams": [
|
|
15671
|
+
{
|
|
15672
|
+
"name": "number",
|
|
15673
|
+
"sdkName": "number"
|
|
15674
|
+
},
|
|
15675
|
+
{
|
|
15676
|
+
"name": "child",
|
|
15677
|
+
"sdkName": "child"
|
|
15678
|
+
}
|
|
15679
|
+
],
|
|
15680
|
+
"query": [
|
|
15681
|
+
{
|
|
15682
|
+
"name": "repository",
|
|
15683
|
+
"type": "string",
|
|
15684
|
+
"required": false,
|
|
15685
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15686
|
+
}
|
|
15687
|
+
]
|
|
15688
|
+
},
|
|
15689
|
+
{
|
|
15690
|
+
"resource": "ticket.types",
|
|
15691
|
+
"method": "list",
|
|
15692
|
+
"summary": "Read types",
|
|
15693
|
+
"description": "Read types within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15694
|
+
"http": "GET",
|
|
15695
|
+
"path": "/ticket/v1/types",
|
|
15696
|
+
"streaming": "no",
|
|
15697
|
+
"pagination": false,
|
|
15698
|
+
"pathParams": [],
|
|
15699
|
+
"query": [
|
|
15700
|
+
{
|
|
15701
|
+
"name": "repository",
|
|
15702
|
+
"type": "string",
|
|
15703
|
+
"required": false,
|
|
15704
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15705
|
+
}
|
|
15706
|
+
]
|
|
15707
|
+
},
|
|
13660
15708
|
{
|
|
13661
15709
|
"resource": "vault.authorizations",
|
|
13662
15710
|
"method": "create",
|