03eb16a7c6
* add endpoints * feat: add MCP tools for script/flow/app CRUD and run endpoints with field filtering Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: convert enum arrays to description text in MCP tool schemas Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: auto-detect and rename conflicting parameter names across MCP tool schemas Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use two-pass approach in convert_enums_to_descriptions to preserve dict ordering Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add MCP instructions to createScript, runScriptByPath, and runFlowByPath Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add query param exclusion for MCP tools, slim down run endpoints Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: preserve additional top-level keys in allOf schema flattening Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor: replace x-mcp-tool-exclude-query-params with x-mcp-tool-include-query-params Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: replace empty {} schemas with valid JSON Schema draft 2020-12 equivalents Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: revert openapi value:{} changes, sanitize empty schemas in generator instead Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Ruben Fiszel <ruben@windmill.dev>
1857 lines
70 KiB
TypeScript
1857 lines
70 KiB
TypeScript
// Auto-generated MCP tools from OpenAPI specification
|
|
// This file is generated by generate_mcp_tools.py - DO NOT EDIT MANUALLY
|
|
|
|
export interface EndpointTool {
|
|
name: string;
|
|
description: string;
|
|
instructions: string;
|
|
path: string;
|
|
method: string;
|
|
pathParamsSchema?: object;
|
|
queryParamsSchema?: object;
|
|
bodySchema?: object;
|
|
pathFieldRenames?: Record<string, string>;
|
|
queryFieldRenames?: Record<string, string>;
|
|
bodyFieldRenames?: Record<string, string>;
|
|
}
|
|
|
|
export const mcpEndpointTools: EndpointTool[] = [
|
|
{
|
|
name: "queryDocumentation",
|
|
description: "query Windmill AI documentation assistant (EE only)",
|
|
instructions: "",
|
|
path: "/inkeep",
|
|
method: "POST",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"query": {
|
|
"type": "string",
|
|
"description": "The documentation query to send to the AI assistant"
|
|
}
|
|
},
|
|
"required": [
|
|
"query"
|
|
]
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "createVariable",
|
|
description: "create variable",
|
|
instructions: "",
|
|
path: "/w/{workspace}/variables/create",
|
|
method: "POST",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"already_encrypted": {
|
|
"type": "boolean",
|
|
"description": "whether the variable is already encrypted (default false)"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The path to the variable"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"description": "The value of the variable"
|
|
},
|
|
"is_secret": {
|
|
"type": "boolean",
|
|
"description": "Whether the variable is a secret"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "The description of the variable"
|
|
},
|
|
"account": {
|
|
"type": "integer",
|
|
"description": "The account identifier"
|
|
},
|
|
"is_oauth": {
|
|
"type": "boolean",
|
|
"description": "Whether the variable is an OAuth variable"
|
|
},
|
|
"expires_at": {
|
|
"type": "string",
|
|
"description": "The expiration date of the variable",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"required": [
|
|
"path",
|
|
"value",
|
|
"is_secret",
|
|
"description"
|
|
]
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "deleteVariable",
|
|
description: "delete variable",
|
|
instructions: "",
|
|
path: "/w/{workspace}/variables/delete/{path}",
|
|
method: "DELETE",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "updateVariable",
|
|
description: "update variable",
|
|
instructions: "",
|
|
path: "/w/{workspace}/variables/update/{path}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path__path": {
|
|
"type": "string",
|
|
"description": "(path parameter)"
|
|
}
|
|
},
|
|
"required": [
|
|
"path__path"
|
|
]
|
|
},
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"already_encrypted": {
|
|
"type": "boolean",
|
|
"description": "whether the variable is already encrypted (default false)"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "string",
|
|
"description": "The new value of the variable"
|
|
},
|
|
"is_secret": {
|
|
"type": "boolean",
|
|
"description": "Whether the variable is a secret"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "The new description of the variable"
|
|
},
|
|
"path__body": {
|
|
"type": "string",
|
|
"description": "The path to the variable (body parameter)"
|
|
}
|
|
}
|
|
},
|
|
pathFieldRenames: {
|
|
"path__path": "path"
|
|
},
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: {
|
|
"path__body": "path"
|
|
}
|
|
},
|
|
{
|
|
name: "getVariable",
|
|
description: "get variable",
|
|
instructions: "",
|
|
path: "/w/{workspace}/variables/get/{path}",
|
|
method: "GET",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"decrypt_secret": {
|
|
"type": "boolean",
|
|
"description": "ask to decrypt secret if this variable is secret\n(if not secret no effect, default: true)\n"
|
|
},
|
|
"include_encrypted": {
|
|
"type": "boolean",
|
|
"description": "ask to include the encrypted value if secret and decrypt secret is not true (default: false)\n"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listVariable",
|
|
description: "list variables",
|
|
instructions: "",
|
|
path: "/w/{workspace}/variables/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path_start": {
|
|
"type": "string",
|
|
"description": "filter variables by path prefix"
|
|
},
|
|
"page": {
|
|
"type": "integer",
|
|
"description": "which page to return (start at 1, default 1)"
|
|
},
|
|
"per_page": {
|
|
"type": "integer",
|
|
"description": "number of items to return for a given page (default 30, max 100)"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "createResource",
|
|
description: "create resource",
|
|
instructions: "",
|
|
path: "/w/{workspace}/resources/create",
|
|
method: "POST",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"update_if_exists": {
|
|
"type": "boolean",
|
|
"description": "update the resource if it already exists (default false)"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The path to the resource"
|
|
},
|
|
"value": {
|
|
"type": "object"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "The description of the resource"
|
|
},
|
|
"resource_type": {
|
|
"type": "string",
|
|
"description": "The resource_type associated with the resource"
|
|
}
|
|
},
|
|
"required": [
|
|
"path",
|
|
"value",
|
|
"resource_type"
|
|
]
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "deleteResource",
|
|
description: "delete resource",
|
|
instructions: "",
|
|
path: "/w/{workspace}/resources/delete/{path}",
|
|
method: "DELETE",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "updateResource",
|
|
description: "update resource",
|
|
instructions: "",
|
|
path: "/w/{workspace}/resources/update/{path}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path__path": {
|
|
"type": "string",
|
|
"description": "(path parameter)"
|
|
}
|
|
},
|
|
"required": [
|
|
"path__path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"description": "The new description of the resource"
|
|
},
|
|
"value": {
|
|
"type": "object"
|
|
},
|
|
"resource_type": {
|
|
"type": "string",
|
|
"description": "The new resource_type to be associated with the resource"
|
|
},
|
|
"path__body": {
|
|
"type": "string",
|
|
"description": "The path to the resource (body parameter)"
|
|
}
|
|
}
|
|
},
|
|
pathFieldRenames: {
|
|
"path__path": "path"
|
|
},
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: {
|
|
"path__body": "path"
|
|
}
|
|
},
|
|
{
|
|
name: "getResource",
|
|
description: "get resource",
|
|
instructions: "",
|
|
path: "/w/{workspace}/resources/get/{path}",
|
|
method: "GET",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listResource",
|
|
description: "list resources",
|
|
instructions: "",
|
|
path: "/w/{workspace}/resources/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"page": {
|
|
"type": "integer",
|
|
"description": "which page to return (start at 1, default 1)"
|
|
},
|
|
"per_page": {
|
|
"type": "integer",
|
|
"description": "number of items to return for a given page (default 30, max 100)"
|
|
},
|
|
"resource_type": {
|
|
"type": "string",
|
|
"description": "resource_types to list from, separated by ',',"
|
|
},
|
|
"resource_type_exclude": {
|
|
"type": "string",
|
|
"description": "resource_types to not list from, separated by ',',"
|
|
},
|
|
"path_start": {
|
|
"type": "string",
|
|
"description": "filter resources by path prefix"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listResourceType",
|
|
description: "list resource_types",
|
|
instructions: "",
|
|
path: "/w/{workspace}/resources/type/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: undefined,
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listScripts",
|
|
description: "list all scripts",
|
|
instructions: "",
|
|
path: "/w/{workspace}/scripts/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"page": {
|
|
"type": "integer",
|
|
"description": "which page to return (start at 1, default 1)"
|
|
},
|
|
"per_page": {
|
|
"type": "integer",
|
|
"description": "number of items to return for a given page (default 30, max 100)"
|
|
},
|
|
"order_desc": {
|
|
"type": "boolean",
|
|
"description": "order by desc order (default true)"
|
|
},
|
|
"created_by": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching user creator"
|
|
},
|
|
"path_start": {
|
|
"type": "string",
|
|
"description": "mask to filter matching starting path"
|
|
},
|
|
"path_exact": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching path"
|
|
},
|
|
"first_parent_hash": {
|
|
"type": "string",
|
|
"description": "mask to filter scripts whom first direct parent has exact hash"
|
|
},
|
|
"last_parent_hash": {
|
|
"type": "string",
|
|
"description": "mask to filter scripts whom last parent in the chain has exact hash.\nBeware that each script stores only a limited number of parents. Hence\nthe last parent hash for a script is not necessarily its top-most parent.\nTo find the top-most parent you will have to jump from last to last hash\n until finding the parent\n"
|
|
},
|
|
"parent_hash": {
|
|
"type": "string",
|
|
"description": "is the hash present in the array of stored parent hashes for this script.\nThe same warning applies than for last_parent_hash. A script only store a\nlimited number of direct parent\n"
|
|
},
|
|
"show_archived": {
|
|
"type": "boolean",
|
|
"description": "(default false)\nshow only the archived files.\nwhen multiple archived hash share the same path, only the ones with the latest create_at\nare\ned.\n"
|
|
},
|
|
"include_without_main": {
|
|
"type": "boolean",
|
|
"description": "(default false)\ninclude scripts without an exported main function\n"
|
|
},
|
|
"include_draft_only": {
|
|
"type": "boolean",
|
|
"description": "(default false)\ninclude scripts that have no deployed version\n"
|
|
},
|
|
"is_template": {
|
|
"type": "boolean",
|
|
"description": "(default regardless)\nif true show only the templates\nif false show only the non templates\nif not defined, show all regardless of if the script is a template\n"
|
|
},
|
|
"kinds": {
|
|
"type": "string",
|
|
"description": "(default regardless)\nscript kinds to filter, split by comma\n"
|
|
},
|
|
"starred_only": {
|
|
"type": "boolean",
|
|
"description": "(default false)\nshow only the starred items\n"
|
|
},
|
|
"with_deployment_msg": {
|
|
"type": "boolean",
|
|
"description": "(default false)\ninclude deployment message\n"
|
|
},
|
|
"languages": {
|
|
"type": "string",
|
|
"description": "Filter to only include scripts written in the given languages.\nAccepts multiple values as a comma-separated list.\n"
|
|
},
|
|
"without_description": {
|
|
"type": "boolean",
|
|
"description": "(default false)\nIf true, the description field will be omitted from the response.\n"
|
|
},
|
|
"dedicated_worker": {
|
|
"type": "boolean",
|
|
"description": "(default regardless)\nIf true, show only scripts with dedicated_worker enabled.\nIf false, show only scripts with dedicated_worker disabled.\n"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "createScript",
|
|
description: "create script",
|
|
instructions: "To create a script, specify the path (e.g., 'f/my_folder/my_script'), the content (source code), and the language. For TypeScript, use 'bun' unless deno-specific APIs are needed.",
|
|
path: "/w/{workspace}/scripts/create",
|
|
method: "POST",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"summary": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"type": "string",
|
|
"description": "Possible values: python3, deno, go, bash, powershell, postgresql, mysql, bigquery, snowflake, mssql, oracledb, graphql, nativets, bun, php, rust, ansible, csharp, nu, java, ruby, duckdb, bunnative"
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Possible values: script, failure, trigger, command, approval, preprocessor"
|
|
},
|
|
"tag": {
|
|
"type": "string"
|
|
},
|
|
"deployment_message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path",
|
|
"summary",
|
|
"description",
|
|
"content",
|
|
"language"
|
|
]
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "deleteScriptByHash",
|
|
description: "delete script by hash (erase content but keep hash, require admin)",
|
|
instructions: "",
|
|
path: "/w/{workspace}/scripts/delete/h/{hash}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"hash": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"hash"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "deleteScriptByPath",
|
|
description: "delete script at a given path (require admin)",
|
|
instructions: "",
|
|
path: "/w/{workspace}/scripts/delete/p/{path}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"keep_captures": {
|
|
"type": "boolean",
|
|
"description": "keep captures"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "getScriptByPath",
|
|
description: "get script by path",
|
|
instructions: "",
|
|
path: "/w/{workspace}/scripts/get/p/{path}",
|
|
method: "GET",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"with_starred_info": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "runScriptByPath",
|
|
description: "run script by path",
|
|
instructions: "You should first use getScriptByPath to retrieve the script's schema and understand what arguments are expected.",
|
|
path: "/w/{workspace}/jobs/run/p/{path}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listFlows",
|
|
description: "list all flows",
|
|
instructions: "",
|
|
path: "/w/{workspace}/flows/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"page": {
|
|
"type": "integer",
|
|
"description": "which page to return (start at 1, default 1)"
|
|
},
|
|
"per_page": {
|
|
"type": "integer",
|
|
"description": "number of items to return for a given page (default 30, max 100)"
|
|
},
|
|
"order_desc": {
|
|
"type": "boolean",
|
|
"description": "order by desc order (default true)"
|
|
},
|
|
"created_by": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching user creator"
|
|
},
|
|
"path_start": {
|
|
"type": "string",
|
|
"description": "mask to filter matching starting path"
|
|
},
|
|
"path_exact": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching path"
|
|
},
|
|
"show_archived": {
|
|
"type": "boolean",
|
|
"description": "(default false)\nshow only the archived files.\nwhen multiple archived hash share the same path, only the ones with the latest create_at\nare displayed.\n"
|
|
},
|
|
"starred_only": {
|
|
"type": "boolean",
|
|
"description": "(default false)\nshow only the starred items\n"
|
|
},
|
|
"include_draft_only": {
|
|
"type": "boolean",
|
|
"description": "(default false)\ninclude items that have no deployed version\n"
|
|
},
|
|
"with_deployment_msg": {
|
|
"type": "boolean",
|
|
"description": "(default false)\ninclude deployment message\n"
|
|
},
|
|
"without_description": {
|
|
"type": "boolean",
|
|
"description": "(default false)\nIf true, the description field will be omitted from the response.\n"
|
|
},
|
|
"dedicated_worker": {
|
|
"type": "boolean",
|
|
"description": "(default regardless)\nIf true, show only flows with dedicated_worker enabled.\nIf false, show only flows with dedicated_worker disabled.\n"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "getFlowByPath",
|
|
description: "get flow by path",
|
|
instructions: "",
|
|
path: "/w/{workspace}/flows/get/{path}",
|
|
method: "GET",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"with_starred_info": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "createFlow",
|
|
description: "create flow",
|
|
instructions: "",
|
|
path: "/w/{workspace}/flows/create",
|
|
method: "POST",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"summary": {
|
|
"type": "string",
|
|
"description": "Short description of what this flow does"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Detailed documentation for this flow"
|
|
},
|
|
"value": {
|
|
"type": "object"
|
|
},
|
|
"schema": {
|
|
"type": "object"
|
|
},
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"tag": {
|
|
"type": "string"
|
|
},
|
|
"deployment_message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"summary",
|
|
"value",
|
|
"path"
|
|
],
|
|
"description": "Top-level flow definition containing metadata, configuration, and the flow structure"
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "updateFlow",
|
|
description: "update flow",
|
|
instructions: "",
|
|
path: "/w/{workspace}/flows/update/{path}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path__path": {
|
|
"type": "string",
|
|
"description": "(path parameter)"
|
|
}
|
|
},
|
|
"required": [
|
|
"path__path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"summary": {
|
|
"type": "string",
|
|
"description": "Short description of what this flow does"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Detailed documentation for this flow"
|
|
},
|
|
"value": {
|
|
"type": "object"
|
|
},
|
|
"schema": {
|
|
"type": "object"
|
|
},
|
|
"tag": {
|
|
"type": "string"
|
|
},
|
|
"deployment_message": {
|
|
"type": "string"
|
|
},
|
|
"path__body": {
|
|
"type": "string",
|
|
"description": "(body parameter)"
|
|
}
|
|
},
|
|
"required": [
|
|
"summary",
|
|
"value",
|
|
"path__body"
|
|
],
|
|
"description": "Top-level flow definition containing metadata, configuration, and the flow structure"
|
|
},
|
|
pathFieldRenames: {
|
|
"path__path": "path"
|
|
},
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: {
|
|
"path__body": "path"
|
|
}
|
|
},
|
|
{
|
|
name: "deleteFlowByPath",
|
|
description: "delete flow by path",
|
|
instructions: "",
|
|
path: "/w/{workspace}/flows/delete/{path}",
|
|
method: "DELETE",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"keep_captures": {
|
|
"type": "boolean",
|
|
"description": "keep captures"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "createApp",
|
|
description: "create app",
|
|
instructions: "",
|
|
path: "/w/{workspace}/apps/create",
|
|
method: "POST",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "object"
|
|
},
|
|
"summary": {
|
|
"type": "string"
|
|
},
|
|
"policy": {
|
|
"type": "object"
|
|
},
|
|
"deployment_message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path",
|
|
"value",
|
|
"summary",
|
|
"policy"
|
|
]
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "updateApp",
|
|
description: "update app",
|
|
instructions: "",
|
|
path: "/w/{workspace}/apps/update/{path}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path__path": {
|
|
"type": "string",
|
|
"description": "(path parameter)"
|
|
}
|
|
},
|
|
"required": [
|
|
"path__path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"summary": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "object"
|
|
},
|
|
"policy": {
|
|
"type": "object"
|
|
},
|
|
"deployment_message": {
|
|
"type": "string"
|
|
},
|
|
"path__body": {
|
|
"type": "string",
|
|
"description": "(body parameter)"
|
|
}
|
|
}
|
|
},
|
|
pathFieldRenames: {
|
|
"path__path": "path"
|
|
},
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: {
|
|
"path__body": "path"
|
|
}
|
|
},
|
|
{
|
|
name: "runFlowByPath",
|
|
description: "run flow by path",
|
|
instructions: "You should first use getFlowByPath to retrieve the flow's schema and understand what arguments are expected.",
|
|
path: "/w/{workspace}/jobs/run/f/{path}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "runScriptPreviewAndWaitResult",
|
|
description: "run script preview and wait for result",
|
|
instructions: "Allows testing a script before deploying it. For typescript code, the language to send is either bun or deno. By default, send bun if no deno specific code is detected.",
|
|
path: "/w/{workspace}/jobs/run_wait_result/preview",
|
|
method: "POST",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"content": {
|
|
"type": "string",
|
|
"description": "The code to run"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The path to the script"
|
|
},
|
|
"script_hash": {
|
|
"type": "string",
|
|
"description": "The hash of the script"
|
|
},
|
|
"args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"language": {
|
|
"type": "string",
|
|
"description": "Possible values: python3, deno, go, bash, powershell, postgresql, mysql, bigquery, snowflake, mssql, oracledb, graphql, nativets, bun, php, rust, ansible, csharp, nu, java, ruby, duckdb, bunnative"
|
|
},
|
|
"tag": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Possible values: code, identity, http"
|
|
},
|
|
"dedicated_worker": {
|
|
"type": "boolean"
|
|
},
|
|
"lock": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"args",
|
|
"content",
|
|
"language"
|
|
]
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listQueue",
|
|
description: "list all queued jobs",
|
|
instructions: "",
|
|
path: "/w/{workspace}/jobs/queue/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"order_desc": {
|
|
"type": "boolean",
|
|
"description": "order by desc order (default true)"
|
|
},
|
|
"created_by": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching user creator"
|
|
},
|
|
"parent_job": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"description": "The parent job that is at the origin and responsible for the execution of this script if any"
|
|
},
|
|
"worker": {
|
|
"type": "string",
|
|
"description": "worker this job was ran on"
|
|
},
|
|
"script_path_exact": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching path"
|
|
},
|
|
"script_path_start": {
|
|
"type": "string",
|
|
"description": "mask to filter matching starting path"
|
|
},
|
|
"schedule_path": {
|
|
"type": "string",
|
|
"description": "mask to filter by schedule path"
|
|
},
|
|
"trigger_path": {
|
|
"type": "string",
|
|
"description": "mask to filter by trigger path"
|
|
},
|
|
"trigger_kind": {
|
|
"description": "trigger kind (schedule, http, websocket...). Possible values: webhook, default_email, email, schedule, http, websocket, postgres, kafka, nats, mqtt, sqs, gcp",
|
|
"type": "string"
|
|
},
|
|
"script_hash": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching path"
|
|
},
|
|
"started_before": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on started before (inclusive) timestamp"
|
|
},
|
|
"started_after": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on started after (exclusive) timestamp"
|
|
},
|
|
"success": {
|
|
"type": "boolean",
|
|
"description": "filter on successful jobs"
|
|
},
|
|
"scheduled_for_before_now": {
|
|
"type": "boolean",
|
|
"description": "filter on jobs scheduled_for before now (hence waitinf for a worker)"
|
|
},
|
|
"job_kinds": {
|
|
"type": "string",
|
|
"description": "filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,"
|
|
},
|
|
"suspended": {
|
|
"type": "boolean",
|
|
"description": "filter on suspended jobs"
|
|
},
|
|
"running": {
|
|
"type": "boolean",
|
|
"description": "filter on running jobs"
|
|
},
|
|
"args": {
|
|
"type": "string",
|
|
"description": "filter on jobs containing those args as a json subset (@> in postgres)"
|
|
},
|
|
"result": {
|
|
"type": "string",
|
|
"description": "filter on jobs containing those result as a json subset (@> in postgres)"
|
|
},
|
|
"allow_wildcards": {
|
|
"type": "boolean",
|
|
"description": "allow wildcards (*) in the filter of label, tag, worker"
|
|
},
|
|
"tag": {
|
|
"type": "string",
|
|
"description": "filter on jobs with a given tag/worker group"
|
|
},
|
|
"page": {
|
|
"type": "integer",
|
|
"description": "which page to return (start at 1, default 1)"
|
|
},
|
|
"per_page": {
|
|
"type": "integer",
|
|
"description": "number of items to return for a given page (default 30, max 100)"
|
|
},
|
|
"all_workspaces": {
|
|
"type": "boolean",
|
|
"description": "get jobs from all workspaces (only valid if request come from the `admins` workspace)"
|
|
},
|
|
"is_not_schedule": {
|
|
"type": "boolean",
|
|
"description": "is not a scheduled job"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listJobs",
|
|
description: "list all jobs",
|
|
instructions: "",
|
|
path: "/w/{workspace}/jobs/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"created_by": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching user creator"
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')"
|
|
},
|
|
"worker": {
|
|
"type": "string",
|
|
"description": "worker this job was ran on"
|
|
},
|
|
"parent_job": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"description": "The parent job that is at the origin and responsible for the execution of this script if any"
|
|
},
|
|
"script_path_exact": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching path"
|
|
},
|
|
"script_path_start": {
|
|
"type": "string",
|
|
"description": "mask to filter matching starting path"
|
|
},
|
|
"schedule_path": {
|
|
"type": "string",
|
|
"description": "mask to filter by schedule path"
|
|
},
|
|
"script_hash": {
|
|
"type": "string",
|
|
"description": "mask to filter exact matching path"
|
|
},
|
|
"started_before": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on started before (inclusive) timestamp"
|
|
},
|
|
"started_after": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on started after (exclusive) timestamp"
|
|
},
|
|
"created_before": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on created before (inclusive) timestamp"
|
|
},
|
|
"created_after": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on created after (exclusive) timestamp"
|
|
},
|
|
"completed_before": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on started before (inclusive) timestamp"
|
|
},
|
|
"completed_after": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on started after (exclusive) timestamp"
|
|
},
|
|
"created_before_queue": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on jobs created before X for jobs in the queue only"
|
|
},
|
|
"created_after_queue": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "filter on jobs created after X for jobs in the queue only"
|
|
},
|
|
"running": {
|
|
"type": "boolean",
|
|
"description": "filter on running jobs"
|
|
},
|
|
"scheduled_for_before_now": {
|
|
"type": "boolean",
|
|
"description": "filter on jobs scheduled_for before now (hence waitinf for a worker)"
|
|
},
|
|
"job_kinds": {
|
|
"type": "string",
|
|
"description": "filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,"
|
|
},
|
|
"suspended": {
|
|
"type": "boolean",
|
|
"description": "filter on suspended jobs"
|
|
},
|
|
"args": {
|
|
"type": "string",
|
|
"description": "filter on jobs containing those args as a json subset (@> in postgres)"
|
|
},
|
|
"tag": {
|
|
"type": "string",
|
|
"description": "filter on jobs with a given tag/worker group"
|
|
},
|
|
"result": {
|
|
"type": "string",
|
|
"description": "filter on jobs containing those result as a json subset (@> in postgres)"
|
|
},
|
|
"allow_wildcards": {
|
|
"type": "boolean",
|
|
"description": "allow wildcards (*) in the filter of label, tag, worker"
|
|
},
|
|
"per_page": {
|
|
"type": "integer",
|
|
"description": "number of items to return for a given page (default 30, max 100)"
|
|
},
|
|
"trigger_kind": {
|
|
"description": "trigger kind (schedule, http, websocket...). Possible values: webhook, default_email, email, schedule, http, websocket, postgres, kafka, nats, mqtt, sqs, gcp",
|
|
"type": "string"
|
|
},
|
|
"is_skipped": {
|
|
"type": "boolean",
|
|
"description": "is the job skipped"
|
|
},
|
|
"is_flow_step": {
|
|
"type": "boolean",
|
|
"description": "is the job a flow step"
|
|
},
|
|
"has_null_parent": {
|
|
"type": "boolean",
|
|
"description": "has null parent"
|
|
},
|
|
"success": {
|
|
"type": "boolean",
|
|
"description": "filter on successful jobs"
|
|
},
|
|
"all_workspaces": {
|
|
"type": "boolean",
|
|
"description": "get jobs from all workspaces (only valid if request come from the `admins` workspace)"
|
|
},
|
|
"is_not_schedule": {
|
|
"type": "boolean",
|
|
"description": "is not a scheduled job"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "createSchedule",
|
|
description: "create schedule",
|
|
instructions: "Creates a new schedule.\nThe schedule should include seconds.\nYou should get the schema of the script or flow before creating the schedule to correctly specify the arguments needed.\n",
|
|
path: "/w/{workspace}/schedules/create",
|
|
method: "POST",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The unique path identifier for this schedule"
|
|
},
|
|
"schedule": {
|
|
"type": "string",
|
|
"description": "Cron expression with 6 fields (seconds, minutes, hours, day of month, month, day of week). Example '0 0 12 * * *' for daily at noon"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"description": "IANA timezone for the schedule (e.g., 'UTC', 'Europe/Paris', 'America/New_York')"
|
|
},
|
|
"script_path": {
|
|
"type": "string",
|
|
"description": "Path to the script or flow to execute when triggered"
|
|
},
|
|
"is_flow": {
|
|
"type": "boolean",
|
|
"description": "True if script_path points to a flow, false if it points to a script"
|
|
},
|
|
"args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"description": "Whether the schedule is currently active and will trigger jobs"
|
|
},
|
|
"on_failure": {
|
|
"type": "string",
|
|
"description": "Path to a script or flow to run when the scheduled job fails"
|
|
},
|
|
"on_failure_times": {
|
|
"type": "number",
|
|
"description": "Number of consecutive failures before the on_failure handler is triggered (default 1)"
|
|
},
|
|
"on_failure_exact": {
|
|
"type": "boolean",
|
|
"description": "If true, trigger on_failure handler only on exactly N failures, not on every failure after N"
|
|
},
|
|
"on_failure_extra_args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"on_recovery": {
|
|
"type": "string",
|
|
"description": "Path to a script or flow to run when the schedule recovers after failures"
|
|
},
|
|
"on_recovery_times": {
|
|
"type": "number",
|
|
"description": "Number of consecutive successes before the on_recovery handler is triggered (default 1)"
|
|
},
|
|
"on_recovery_extra_args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"on_success": {
|
|
"type": "string",
|
|
"description": "Path to a script or flow to run after each successful execution"
|
|
},
|
|
"on_success_extra_args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"ws_error_handler_muted": {
|
|
"type": "boolean",
|
|
"description": "If true, the workspace-level error handler will not be triggered for this schedule's failures"
|
|
},
|
|
"retry": {
|
|
"type": "object",
|
|
"description": "Retry configuration for failed module executions",
|
|
"properties": {
|
|
"constant": {
|
|
"type": "object",
|
|
"description": "Retry with constant delay between attempts",
|
|
"properties": {
|
|
"attempts": {
|
|
"type": "integer",
|
|
"description": "Number of retry attempts"
|
|
},
|
|
"seconds": {
|
|
"type": "integer",
|
|
"description": "Seconds to wait between retries"
|
|
}
|
|
}
|
|
},
|
|
"exponential": {
|
|
"type": "object",
|
|
"description": "Retry with exponential backoff (delay doubles each time)",
|
|
"properties": {
|
|
"attempts": {
|
|
"type": "integer",
|
|
"description": "Number of retry attempts"
|
|
},
|
|
"multiplier": {
|
|
"type": "integer",
|
|
"description": "Multiplier for exponential backoff"
|
|
},
|
|
"seconds": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Initial delay in seconds"
|
|
},
|
|
"random_factor": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 100,
|
|
"description": "Random jitter percentage (0-100) to avoid thundering herd"
|
|
}
|
|
}
|
|
},
|
|
"retry_if": {
|
|
"type": "object",
|
|
"description": "Conditional retry based on error or result",
|
|
"properties": {
|
|
"expr": {
|
|
"type": "string",
|
|
"description": "JavaScript expression that returns true to retry. Has access to 'result' and 'error' variables"
|
|
}
|
|
},
|
|
"required": [
|
|
"expr"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"no_flow_overlap": {
|
|
"type": "boolean",
|
|
"description": "If true, skip this schedule's execution if the previous run is still in progress (prevents concurrent runs)"
|
|
},
|
|
"summary": {
|
|
"type": "string",
|
|
"description": "Short summary describing the purpose of this schedule"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Detailed description of what this schedule does"
|
|
},
|
|
"tag": {
|
|
"type": "string",
|
|
"description": "Worker tag to route jobs to specific worker groups"
|
|
},
|
|
"paused_until": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "ISO 8601 datetime until which the schedule is paused. Schedule resumes automatically after this time"
|
|
},
|
|
"cron_version": {
|
|
"type": "string",
|
|
"description": "Cron parser version. Use 'v2' for extended syntax with additional features"
|
|
},
|
|
"dynamic_skip": {
|
|
"type": "string",
|
|
"description": "Path to a script that validates scheduled datetimes. Receives scheduled_for datetime and returns boolean to skip (true) or run (false)"
|
|
}
|
|
},
|
|
"required": [
|
|
"path",
|
|
"schedule",
|
|
"timezone",
|
|
"script_path",
|
|
"is_flow",
|
|
"args"
|
|
]
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "updateSchedule",
|
|
description: "update schedule",
|
|
instructions: "Updates a schedule.\nThe schedule should include seconds.\nYou should get the schema of the script or flow before updating the schedule to correctly specify the arguments needed.\n",
|
|
path: "/w/{workspace}/schedules/update/{path}",
|
|
method: "POST",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"schedule": {
|
|
"type": "string",
|
|
"description": "Cron expression with 6 fields (seconds, minutes, hours, day of month, month, day of week). Example '0 0 12 * * *' for daily at noon"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"description": "IANA timezone for the schedule (e.g., 'UTC', 'Europe/Paris', 'America/New_York')"
|
|
},
|
|
"args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"on_failure": {
|
|
"type": "string",
|
|
"description": "Path to a script or flow to run when the scheduled job fails"
|
|
},
|
|
"on_failure_times": {
|
|
"type": "number",
|
|
"description": "Number of consecutive failures before the on_failure handler is triggered (default 1)"
|
|
},
|
|
"on_failure_exact": {
|
|
"type": "boolean",
|
|
"description": "If true, trigger on_failure handler only on exactly N failures, not on every failure after N"
|
|
},
|
|
"on_failure_extra_args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"on_recovery": {
|
|
"type": "string",
|
|
"description": "Path to a script or flow to run when the schedule recovers after failures"
|
|
},
|
|
"on_recovery_times": {
|
|
"type": "number",
|
|
"description": "Number of consecutive successes before the on_recovery handler is triggered (default 1)"
|
|
},
|
|
"on_recovery_extra_args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"on_success": {
|
|
"type": "string",
|
|
"description": "Path to a script or flow to run after each successful execution"
|
|
},
|
|
"on_success_extra_args": {
|
|
"type": "object",
|
|
"description": "The arguments to pass to the script or flow",
|
|
"additionalProperties": true
|
|
},
|
|
"ws_error_handler_muted": {
|
|
"type": "boolean",
|
|
"description": "If true, the workspace-level error handler will not be triggered for this schedule's failures"
|
|
},
|
|
"retry": {
|
|
"type": "object",
|
|
"description": "Retry configuration for failed module executions",
|
|
"properties": {
|
|
"constant": {
|
|
"type": "object",
|
|
"description": "Retry with constant delay between attempts",
|
|
"properties": {
|
|
"attempts": {
|
|
"type": "integer",
|
|
"description": "Number of retry attempts"
|
|
},
|
|
"seconds": {
|
|
"type": "integer",
|
|
"description": "Seconds to wait between retries"
|
|
}
|
|
}
|
|
},
|
|
"exponential": {
|
|
"type": "object",
|
|
"description": "Retry with exponential backoff (delay doubles each time)",
|
|
"properties": {
|
|
"attempts": {
|
|
"type": "integer",
|
|
"description": "Number of retry attempts"
|
|
},
|
|
"multiplier": {
|
|
"type": "integer",
|
|
"description": "Multiplier for exponential backoff"
|
|
},
|
|
"seconds": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Initial delay in seconds"
|
|
},
|
|
"random_factor": {
|
|
"type": "integer",
|
|
"minimum": 0,
|
|
"maximum": 100,
|
|
"description": "Random jitter percentage (0-100) to avoid thundering herd"
|
|
}
|
|
}
|
|
},
|
|
"retry_if": {
|
|
"type": "object",
|
|
"description": "Conditional retry based on error or result",
|
|
"properties": {
|
|
"expr": {
|
|
"type": "string",
|
|
"description": "JavaScript expression that returns true to retry. Has access to 'result' and 'error' variables"
|
|
}
|
|
},
|
|
"required": [
|
|
"expr"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"no_flow_overlap": {
|
|
"type": "boolean",
|
|
"description": "If true, skip this schedule's execution if the previous run is still in progress (prevents concurrent runs)"
|
|
},
|
|
"summary": {
|
|
"type": "string",
|
|
"description": "Short summary describing the purpose of this schedule"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Detailed description of what this schedule does"
|
|
},
|
|
"tag": {
|
|
"type": "string",
|
|
"description": "Worker tag to route jobs to specific worker groups"
|
|
},
|
|
"paused_until": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "ISO 8601 datetime until which the schedule is paused. Schedule resumes automatically after this time"
|
|
},
|
|
"cron_version": {
|
|
"type": "string",
|
|
"description": "Cron parser version. Use 'v2' for extended syntax with additional features"
|
|
},
|
|
"dynamic_skip": {
|
|
"type": "string",
|
|
"description": "Path to a script that validates scheduled datetimes. Receives scheduled_for datetime and returns boolean to skip (true) or run (false)"
|
|
}
|
|
},
|
|
"required": [
|
|
"schedule",
|
|
"timezone",
|
|
"args"
|
|
]
|
|
},
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "deleteSchedule",
|
|
description: "delete schedule",
|
|
instructions: "",
|
|
path: "/w/{workspace}/schedules/delete/{path}",
|
|
method: "DELETE",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "getSchedule",
|
|
description: "get schedule",
|
|
instructions: "",
|
|
path: "/w/{workspace}/schedules/get/{path}",
|
|
method: "GET",
|
|
pathParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
]
|
|
},
|
|
queryParamsSchema: undefined,
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listSchedules",
|
|
description: "list schedules",
|
|
instructions: "",
|
|
path: "/w/{workspace}/schedules/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"page": {
|
|
"type": "integer",
|
|
"description": "which page to return (start at 1, default 1)"
|
|
},
|
|
"per_page": {
|
|
"type": "integer",
|
|
"description": "number of items to return for a given page (default 30, max 100)"
|
|
},
|
|
"args": {
|
|
"type": "string",
|
|
"description": "filter on jobs containing those args as a json subset (@> in postgres)"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"description": "filter by path"
|
|
},
|
|
"is_flow": {
|
|
"type": "boolean",
|
|
"description": "filter schedules by whether they target a flow"
|
|
},
|
|
"path_start": {
|
|
"type": "string",
|
|
"description": "filter schedules by path prefix"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
},
|
|
{
|
|
name: "listWorkers",
|
|
description: "list workers",
|
|
instructions: "",
|
|
path: "/workers/list",
|
|
method: "GET",
|
|
pathParamsSchema: undefined,
|
|
queryParamsSchema: {
|
|
"type": "object",
|
|
"properties": {
|
|
"page": {
|
|
"type": "integer",
|
|
"description": "which page to return (start at 1, default 1)"
|
|
},
|
|
"per_page": {
|
|
"type": "integer",
|
|
"description": "number of items to return for a given page (default 30, max 100)"
|
|
},
|
|
"ping_since": {
|
|
"type": "integer",
|
|
"description": "number of seconds the worker must have had a last ping more recent of (default to 300)"
|
|
}
|
|
},
|
|
"required": []
|
|
},
|
|
bodySchema: undefined,
|
|
pathFieldRenames: undefined,
|
|
queryFieldRenames: undefined,
|
|
bodyFieldRenames: undefined
|
|
}
|
|
];
|