{"openapi":"3.1.0","info":{"title":"YepCode REST API","termsOfService":"https://yepcode.io/terms-of-use","contact":{"email":"apiteam@yepcode.io"},"version":"1.0"},"servers":[{"url":"https://cloud.yepcode.io/api/{team}/rest","variables":{"team":{"description":"YepCode Team Id (the same at https://cloud.yepcode.io/{team})","default":"your-team-id"}}}],"security":[{"oauth2":["executor"]}],"paths":{"/schedules/{id}/resume":{"put":{"tags":["Schedules"],"summary":"Resume scheduled process","description":"Resumes a previously paused scheduled process. The process will continue executing according to its original schedule configuration.","operationId":"resumeSchedule","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the scheduled process to resume","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Scheduled process not found"}},"security":[{"oauth2":["executor"]}]}},"/schedules/{id}/pause":{"put":{"tags":["Schedules"],"summary":"Pause scheduled process","description":"Pauses a currently active scheduled process. The process will stop executing until it is resumed.","operationId":"pauseSchedule","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the scheduled process to pause","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"404":{"description":"Scheduled process not found"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/executions/{id}/kill":{"put":{"tags":["Executions"],"summary":"Kill execution","description":"Terminates a running execution immediately. This operation sends a kill signal to stop the execution process and marks it as killed.","operationId":"killExecution","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the execution to terminate","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Execution not found"}},"security":[{"oauth2":["executor"]}]}},"/dependencies/{language}":{"get":{"tags":["Dependencies"],"summary":"Get team dependencies","description":"Retrieves the current dependency manifest for the specified programming language, including installed dependencies and any pending installation.","operationId":"getTeamDependencies","parameters":[{"name":"language","in":"path","description":"Programming language identifier (JAVASCRIPT or PYTHON)","required":true,"schema":{"type":"string"},"example":"JAVASCRIPT"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgrammingLanguageManifest"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Manifest not found"}},"security":[{"oauth2":["executor"]}]},"put":{"tags":["Dependencies"],"summary":"Update team dependencies","description":"Replaces the full dependency list for the specified programming language. The changes are staged and must be installed separately via the install endpoint.","operationId":"updateTeamDependencies","parameters":[{"name":"language","in":"path","description":"Programming language identifier (JAVASCRIPT or PYTHON)","required":true,"schema":{"type":"string"},"example":"JAVASCRIPT"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTeamDependenciesInput"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgrammingLanguageManifest"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Manifest not found"}},"security":[{"oauth2":["executor"]}]}},"/variables":{"get":{"tags":["Variables"],"summary":"Get variables","description":"Retrieves a paginated list of team variables. Variables are key-value pairs that can be used across processes and executions.","operationId":"getVariables","parameters":[{"name":"page","in":"query","description":"Page number for pagination (0-based index)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of variables to retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamVariablesPaginatedResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"post":{"tags":["Variables"],"summary":"Create variable","description":"Creates a new team variable that can be used across processes and executions. Variables can be marked as sensitive to hide their values in logs and UI.","operationId":"createVariable","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamVariableInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamVariable"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/storage/signed-urls":{"post":{"tags":["Storage"],"summary":"Create a signed URL","description":"Generates a time-limited signed URL that can be used to download an existing object from the team's storage bucket directly, without going through this API. The URL is signed with GCS V4 and expires after the configured time-to-live (default 1 hour, maximum 7 days).","operationId":"createStorageSignedUrl","requestBody":{"description":"Signed URL parameters. The path must point to an existing object in the team's storage bucket.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrlRequest"}}},"required":true},"responses":{"200":{"description":"Signed URL successfully generated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedUrl"}}}},"400":{"description":"Invalid path or out-of-range expiration"},"401":{"description":"Unauthorized"},"404":{"description":"File not found"}},"security":[{"oauth2":["executor"]}]}},"/storage/objects":{"get":{"tags":["Storage"],"summary":"Get objects","description":"Retrieves a list of storage objects in the team's storage bucket. Objects can be filtered by prefix to organize files in folders.","operationId":"getStorageObjects","parameters":[{"name":"prefix","in":"query","description":"Filter results to include only objects whose names begin with this prefix (useful for folder-like organization)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StorageObject"}}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"post":{"tags":["Storage"],"summary":"Upload an object","description":"Uploads a file to the team's storage bucket. Files can be organized using folder-like paths in the filename parameter.","operationId":"uploadStorageObject","parameters":[{"name":"filename","in":"query","description":"Object filename (can include slashes for folder-like organization, e.g., 'folder/subfolder/file.txt')","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"File content to upload. Can be sent as multipart/form-data or binary data","content":{"multipart/form-data":{},"application/octet-stream":{}},"required":true},"responses":{"204":{"description":"File uploaded successfully"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/sandboxes":{"post":{"tags":["Sandboxes"],"summary":"Create a sandbox","description":"Creates a new sandbox environment for isolated execution and testing.","operationId":"createSandbox","requestBody":{"description":"Sandbox input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSandboxInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sandbox"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/sandboxes/{sandboxId}":{"post":{"tags":["Sandboxes"],"summary":"Update sandbox","description":"Sets the sandbox timeout deadline to the current time plus timeout (extends or shortens remaining time from now).","operationId":"updateSandbox","parameters":[{"name":"sandboxId","in":"path","description":"Unique identifier (UUID) of the sandbox entity","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New timeout in ms","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSandboxInput"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sandbox"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["executor"]}]}},"/sandboxes/{sandboxId}/kill":{"post":{"tags":["Sandboxes"],"summary":"Kill sandbox","description":"Stops the sandbox on its VM instance and marks the sandbox as killed in the API. Use POST with an empty body.","operationId":"killSandbox","parameters":[{"name":"sandboxId","in":"path","description":"Unique identifier (UUID) of the sandbox entity","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sandbox"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["executor"]}]}},"/processes":{"get":{"tags":["Processes"],"summary":"Get processes","description":"Retrieves a paginated list of processes with optional filtering by keywords and tags. Processes are executable code units that can be scheduled or triggered manually.","operationId":"getProcesses","parameters":[{"name":"keywords","in":"query","description":"Search keywords that apply to process name or description (case-insensitive)","required":false,"schema":{"type":"string"}},{"name":"tags","in":"query","description":"Filter processes by tags (array of tag names)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"page","in":"query","description":"Page number for pagination (0-based index)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of processes to retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessesPaginatedResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"post":{"tags":["Processes"],"summary":"Create a process","description":"Creates a new process with source code, configuration, and metadata. The process can be written in JavaScript or Python and includes parameter schemas for form generation.","operationId":"createProcess","requestBody":{"description":"Process input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProcessInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Process"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/processes/{identifier}/versions":{"get":{"tags":["Processes"],"summary":"Get process versions","operationId":"getProcessVersions","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process (UUID or process slug)","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Amount of items to retrieve","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcessesPaginatedResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"post":{"tags":["Processes"],"summary":"Publish a process version","operationId":"publishProcessVersion","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process (UUID or slug)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Publish process version input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishProcessInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcess"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Process not found"}},"security":[{"oauth2":["executor"]}]}},"/processes/{identifier}/schedule":{"post":{"tags":["Processes"],"summary":"Schedule a process","operationId":"createSchedule","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process to schedule (UUID or slug)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Schedule input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledProcessInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Scheduled process not found"}},"security":[{"oauth2":["executor"]}]}},"/processes/{identifier}/execute":{"post":{"tags":["Processes"],"summary":"Execute a process asynchronously","operationId":"executeProcessAsync","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process to execute asynchronously (UUID or slug)","required":true,"schema":{"type":"string"}},{"name":"Yep-Initiated-By","in":"header","description":"An identifier for the individual initiating the request. This could be an employee ID, a username, or any other unique identifier.","schema":{"type":"string"}}],"requestBody":{"description":"Execute process input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteProcessInput"}}},"required":true},"responses":{"202":{"description":"Accepted","headers":{"Yep-Execution-ID":{"description":"Unique identifier (UUID) of the execution","style":"simple","schema":{"type":"string"}},"Location":{"description":"URL to check the status of the execution","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionId"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Process not found"}},"security":[{"oauth2":["executor"]}]}},"/processes/{identifier}/execute-sync":{"post":{"tags":["Processes"],"summary":"Execute a process synchronously","operationId":"executeProcessSync","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process to execute synchronously (UUID or slug)","required":true,"schema":{"type":"string"}},{"name":"Yep-Initiated-By","in":"header","description":"An identifier for the individual initiating the request. This could be an employee ID, a username, or any other unique identifier.","schema":{"type":"string"}}],"requestBody":{"description":"Execute process input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteProcessInput"}}},"required":true},"responses":{"203":{"description":"successful operation","headers":{"Yep-Execution-ID":{"description":"Unique identifier (UUID) of the execution","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Process not found"}},"security":[{"oauth2":["executor"]}]}},"/processes/{identifier}/aliases":{"get":{"tags":["Processes"],"summary":"Get process version aliases","operationId":"getProcessVersionAliases","parameters":[{"name":"identifier","in":"path","description":"Process ID (UUID) or slug in the current team's scope","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"query","description":"Version ID","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Amount of items to retrieve","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcessAliasesPaginatedResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"post":{"tags":["Processes"],"summary":"Create a process version alias","operationId":"createProcessVersionAlias","parameters":[{"name":"identifier","in":"path","description":"Process ID (UUID) or slug in the current team's scope","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Create process version alias input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcessAliasInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcessAlias"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Versioned process not found"}},"security":[{"oauth2":["executor"]}]}},"/modules":{"get":{"tags":["Modules"],"summary":"Get modules","description":"Retrieves a paginated list of script library modules. Modules are reusable code libraries that can be imported and used across different processes.","operationId":"getModules","parameters":[{"name":"page","in":"query","description":"Page number for pagination (0-based index)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of modules to retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModulesPaginatedResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"post":{"tags":["Modules"],"summary":"Create a module","description":"Creates a new script library module with source code and metadata. Modules can be written in JavaScript or Python and can be imported by processes.","operationId":"createModule","requestBody":{"description":"Create module input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModuleInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Module"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/modules/{moduleId}/versions":{"get":{"tags":["Modules"],"summary":"Get module versions","operationId":"getModuleVersions","parameters":[{"name":"moduleId","in":"path","description":"Module ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Amount of items to retrieve","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedModulesPaginatedResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"post":{"tags":["Modules"],"summary":"Publish a module version","operationId":"publishModuleVersion","parameters":[{"name":"moduleId","in":"path","description":"Module ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Publish module version input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVersionedModuleInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedModule"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Module not found"}},"security":[{"oauth2":["executor"]}]}},"/modules/{moduleId}/aliases":{"get":{"tags":["Modules"],"summary":"Get module version aliases","operationId":"getModuleVersionAliases","parameters":[{"name":"moduleId","in":"path","description":"Module ID","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"query","description":"Version ID","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Amount of items to retrieve","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedModuleAliasesPaginatedResult"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"post":{"tags":["Modules"],"summary":"Create a module version alias","operationId":"createModuleVersionAlias","parameters":[{"name":"moduleId","in":"path","description":"Module ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Create module version alias input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVersionedModuleAliasInput"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedModuleAlias"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Versioned module alias not found"}},"security":[{"oauth2":["executor"]}]}},"/executions/{id}/rerun":{"post":{"tags":["Executions"],"summary":"Rerun execution","description":"Creates a new execution using the same parameters and configuration as the specified execution. This is useful for reproducing or retrying failed executions.","operationId":"rerunExecution","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the execution to rerun","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Execution not found"}},"security":[{"oauth2":["executor"]}]}},"/dependencies/{language}/install":{"post":{"tags":["Dependencies"],"summary":"Install team dependencies","description":"Triggers the installation of staged dependencies for the specified programming language. The manifest must have a pending installation before calling this endpoint.","operationId":"installTeamDependencies","parameters":[{"name":"language","in":"path","description":"Programming language identifier (JAVASCRIPT or PYTHON)","required":true,"schema":{"type":"string"},"example":"JAVASCRIPT"}],"responses":{"200":{"description":"successful operation"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Manifest not found"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Dependencies"],"summary":"Discard pending dependency installation","description":"Discards the staged dependency changes for the specified programming language, reverting to the last installed state.","operationId":"discardTeamDependenciesInstallation","parameters":[{"name":"language","in":"path","description":"Programming language identifier (JAVASCRIPT or PYTHON)","required":true,"schema":{"type":"string"},"example":"JAVASCRIPT"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgrammingLanguageManifest"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Manifest not found"}},"security":[{"oauth2":["executor"]}]}},"/auth/token":{"post":{"tags":["Auth"],"summary":"Get token","operationId":"getToken","parameters":[{"name":"x-api-token","in":"header","description":"API token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/variables/{id}":{"delete":{"tags":["Variables"],"summary":"Delete variable","description":"Permanently deletes a team variable. This action cannot be undone and may affect processes that depend on this variable.","operationId":"deleteVariable","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the team variable to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Team variable not found"}},"security":[{"oauth2":["executor"]}]},"patch":{"tags":["Variables"],"summary":"Update variable","description":"Updates an existing team variable with new value or configuration. Sensitive variables will have their values hidden in logs and UI.","operationId":"updateVariable","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the team variable to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTeamVariableInput"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamVariable"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Variable not found"}},"security":[{"oauth2":["executor"]}]}},"/team":{"get":{"tags":["Teams"],"summary":"Get team","description":"Retrieves the current team's information including parent team slugs.","operationId":"getTeam","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Team not found"}},"security":[{"oauth2":["executor"]}]},"patch":{"tags":["Teams"],"summary":"Update team","description":"Partially updates the current team. Only provided fields are updated. For parentTeamSlugs: omit to keep unchanged, pass an empty list to clear all parents.","operationId":"updateTeam","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTeamInput"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Team not found"}},"security":[{"oauth2":["executor"]}]}},"/schedules/{id}":{"get":{"tags":["Schedules"],"summary":"Get scheduled process","description":"Retrieves detailed information about a specific scheduled process including its configuration, schedule settings, and current status.","operationId":"getSchedule","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the scheduled process to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Scheduled process not found"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Schedules"],"summary":"Delete scheduled process","description":"Permanently deletes a scheduled process and cancels all future executions. This action cannot be undone.","operationId":"deleteSchedule","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the scheduled process to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"404":{"description":"Scheduled process not found"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"patch":{"tags":["Schedules"],"summary":"Update scheduled process","description":"Updates an existing scheduled process with new configuration, schedule settings, or parameters. All provided fields will replace the existing values.","operationId":"updateSchedule","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the scheduled process to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Scheduled process input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledProcessInput"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Scheduled process not found"}},"security":[{"oauth2":["executor"]}]}},"/processes/{identifier}":{"get":{"tags":["Processes"],"summary":"Get process","description":"Retrieves detailed information about a specific process including its configuration, source code, and metadata.","operationId":"getProcess","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process to retrieve (UUID or slug)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Process"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Process not found"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Processes"],"summary":"Delete a process","description":"Permanently deletes a process and all its associated data including executions and schedules. This action cannot be undone.","operationId":"deleteProcess","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process to delete (UUID or slug)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["executor"]}]},"patch":{"tags":["Processes"],"summary":"Update a process","description":"Updates an existing process with new configuration, source code, or metadata. All fields provided will replace the existing values.","operationId":"updateProcess","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process to update (UUID or slug)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Process input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProcessInput"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Process"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Process not found"}},"security":[{"oauth2":["executor"]}]}},"/processes/{identifier}/aliases/{aliasId}":{"get":{"tags":["Processes"],"summary":"Get a process version alias","operationId":"getProcessVersionAlias","parameters":[{"name":"identifier","in":"path","description":"Process ID (UUID) or slug (path segment for routing only)","required":true,"schema":{"type":"string"}},{"name":"aliasId","in":"path","description":"Alias ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcessAlias"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Versioned process alias not found"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Processes"],"summary":"Delete a process version alias","operationId":"deleteProcessVersionAlias","parameters":[{"name":"identifier","in":"path","description":"Process ID (UUID) or slug (path segment for routing only)","required":true,"schema":{"type":"string"}},{"name":"aliasId","in":"path","description":"Alias ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Versioned process alias not found"}},"security":[{"oauth2":["executor"]}]},"patch":{"tags":["Processes"],"summary":"Update a process version alias","operationId":"updateProcessVersionAlias","parameters":[{"name":"identifier","in":"path","description":"Process ID (UUID) or slug in the current team's scope","required":true,"schema":{"type":"string"}},{"name":"aliasId","in":"path","description":"Alias ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update process version alias input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcessAliasInput"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcessAlias"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Versioned process alias not found"}},"security":[{"oauth2":["executor"]}]}},"/modules/{moduleId}/aliases/{aliasId}":{"get":{"tags":["Modules"],"summary":"Get a module version alias","operationId":"getModuleVersionAlias","parameters":[{"name":"aliasId","in":"path","description":"Alias ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedModuleAlias"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Versioned module alias not found"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Modules"],"summary":"Delete a module version alias","operationId":"deleteModuleVersionAlias","parameters":[{"name":"aliasId","in":"path","description":"Alias ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Versioned module alias not found"}},"security":[{"oauth2":["executor"]}]},"patch":{"tags":["Modules"],"summary":"Update a module version alias","operationId":"updateModuleVersionAlias","parameters":[{"name":"moduleId","in":"path","description":"Module ID","required":true,"schema":{"type":"string"}},{"name":"aliasId","in":"path","description":"Alias ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update module version alias input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVersionedModuleAliasInput"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedModuleAlias"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Versioned module alias not found"}},"security":[{"oauth2":["executor"]}]}},"/modules/{id}":{"get":{"tags":["Modules"],"summary":"Get module","description":"Retrieves detailed information about a specific script library module including its source code, metadata, and version information.","operationId":"getModule","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the script library module to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Module"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Script library not found"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Modules"],"summary":"Delete a module","description":"Permanently deletes a script library module. This action cannot be undone and may affect processes that import this module.","operationId":"deleteModule","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the script library module to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Module not found"},"409":{"description":"Module in use"}},"security":[{"oauth2":["executor"]}]},"patch":{"tags":["Modules"],"summary":"Update a module","description":"Updates an existing script library module with new source code or metadata. All provided fields will replace the existing values.","operationId":"updateModule","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the script library module to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update module input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateModuleInput"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Module"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Module not found"},"409":{"description":"Module in use"}},"security":[{"oauth2":["executor"]}]}},"/storage/objects/{filename}":{"get":{"tags":["Storage"],"summary":"Download an object","description":"Downloads a file from the team's storage bucket. The file content is returned as binary data with appropriate headers.","operationId":"getStorageObject","parameters":[{"name":"filename","in":"path","description":"Object filename (can include slashes)","required":true}],"responses":{"200":{"description":"File found and returned","headers":{"Content-Disposition":{"description":"Attachment with filename","style":"simple"},"Content-Type":{"description":"MIME type of the file","style":"simple"}},"content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"File not found"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Storage"],"summary":"Delete an object","description":"Permanently deletes a file from the team's storage bucket. This action cannot be undone.","operationId":"deleteStorageObject","parameters":[{"name":"filename","in":"path","description":"Object filename (can include slashes)","required":true}],"responses":{"204":{"description":"File deleted successfully"},"404":{"description":"File not found"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/schedules":{"get":{"tags":["Schedules"],"summary":"Get scheduled processes","description":"Retrieves a paginated list of scheduled processes with optional filtering by process and keywords. Scheduled processes define when and how often processes should be executed automatically.","operationId":"getSchedules","parameters":[{"name":"page","in":"query","description":"Page number for pagination (0-based index)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of scheduled processes to retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"processId","in":"query","description":"Filter scheduled processes by process ID (UUID)","required":false,"schema":{"type":"string"}},{"name":"keywords","in":"query","description":"Keywords filter: applies to process name or schedule comment","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulesPaginatedResult"}}}}},"security":[{"oauth2":["executor"]}]}},"/processes/{identifier}/versions/{versionId}":{"get":{"tags":["Processes"],"summary":"Get a process version","operationId":"getProcessVersion","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process (UUID or slug)","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"path","description":"Version ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedProcess"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Versioned process not found"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Processes"],"summary":"Delete a process version","operationId":"deleteProcessVersion","parameters":[{"name":"identifier","in":"path","description":"Unique identifier of the process (UUID or slug)","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"path","description":"Version ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Versioned process not found"}},"security":[{"oauth2":["executor"]}]}},"/modules/{moduleId}/versions/{versionId}":{"get":{"tags":["Modules"],"summary":"Get a module version","operationId":"getModuleVersion","parameters":[{"name":"moduleId","in":"path","description":"Module ID","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"path","description":"Version ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedModule"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Versioned module not found"}},"security":[{"oauth2":["executor"]}]},"delete":{"tags":["Modules"],"summary":"Delete a module version","operationId":"deleteModuleVersion","parameters":[{"name":"moduleId","in":"path","description":"Module ID","required":true,"schema":{"type":"string"}},{"name":"versionId","in":"path","description":"Version ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Versioned module not found"}},"security":[{"oauth2":["executor"]}]}},"/executions":{"get":{"tags":["Executions"],"summary":"Get executions","description":"Retrieves a paginated list of process executions with optional filtering by keywords, process, status, and date range. Executions represent individual runs of processes.","operationId":"getExecutions","parameters":[{"name":"keywords","in":"query","description":"Search keywords that apply to process name or execution comment (case-insensitive)","required":false,"schema":{"type":"string"}},{"name":"processId","in":"query","description":"Filter executions by process ID (UUID)","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter executions by status (RUNNING, COMPLETED, FAILED, KILLED, etc.)","required":false,"schema":{"type":"string","enum":["CREATED","QUEUED","DEQUEUED","RUNNING","FINISHED","KILLED","REJECTED","ERROR"]}},{"name":"from","in":"query","description":"Filter executions created from this date and time (ISO 8601 format)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Filter executions created until this date and time (ISO 8601 format)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Page number for pagination (0-based index)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of executions to retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"comment","in":"query","description":"Filter executions by comment text (case-insensitive)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionsPaginatedResult"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}},"/executions/{id}":{"get":{"tags":["Executions"],"summary":"Get execution","description":"Retrieves detailed information about a specific execution including its status, parameters, results, and metadata.","operationId":"getExecution","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the execution to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Execution"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Execution not found"}},"security":[{"oauth2":["executor"]}]}},"/executions/{id}/logs":{"get":{"tags":["Executions"],"summary":"Get execution logs","description":"Retrieves the log entries for a specific execution, providing detailed information about the execution process and any output or errors.","operationId":"getExecutionLogs","parameters":[{"name":"id","in":"path","description":"Unique identifier (UUID) of the execution to get logs for","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number for pagination (0-based index)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of executions to retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionLogsPaginatedResult"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["executor"]}]}}},"components":{"schemas":{"UpdateTeamDependenciesInput":{"type":"object","properties":{"dependencies":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of dependency names to version specifiers (semver range or git URL). Replaces the full dependency list.","example":{"lodash":"^4.17.21","axios":"1.6.0"}}}},"ProgrammingLanguageManifest":{"type":"object","properties":{"id":{"type":"string","description":"Manifest identifier (programming language name)","example":"JAVASCRIPT"},"programmingLanguage":{"type":"string","description":"Programming language for these dependencies","enum":["JAVASCRIPT","PYTHON"],"example":"JAVASCRIPT"},"dependencies":{"type":"object","additionalProperties":{"type":"string"},"description":"Currently installed dependencies","example":{"lodash":"^4.17.21"}},"nextInstallation":{"$ref":"#/components/schemas/ProgrammingLanguageManifestInstallation","description":"Pending installation details, present when there are staged changes"}}},"ProgrammingLanguageManifestInstallation":{"type":"object","properties":{"status":{"type":"string","description":"Installation status","enum":["PENDING","INSTALLING","INSTALLED","FAILED"],"example":"PENDING"},"error":{"type":"string","description":"Error message if installation failed"},"dependencies":{"type":"object","additionalProperties":{"type":"string"},"example":{"lodash":"^4.17.21"}}}},"CreateTeamVariableInput":{"type":"object","properties":{"key":{"type":"string","description":"The unique key/name for the team variable. Used to reference the variable in processes and executions.","example":"MY_VARIABLE"},"value":{"type":"string","description":"The value of the team variable. Can be any string value that will be used by processes.","example":"my-variable-value"},"isSensitive":{"type":"boolean","description":"Whether the variable value should be treated as sensitive. Sensitive variables have their values hidden in logs and UI.","example":true}}},"TeamVariable":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the team variable","example":"138f7d70-7d13-430f-9f15-a66de3ce1852"},"key":{"type":"string","description":"The key/name of the team variable used to reference it in processes","example":"MY_VARIABLE"},"value":{"type":"string","description":"The value of the team variable. For sensitive variables, this may be masked in logs and UI","example":"MY_VALUE"},"isSensitive":{"type":"boolean","description":"Whether the variable value is marked as sensitive. Sensitive variables have their values hidden in logs and UI","example":true},"createdBy":{"type":"string","description":"Username of the user who created this team variable","example":"jane-doe"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the team variable was created","example":"2024-04-24T08:46:15.735"}}},"SignedUrlRequest":{"type":"object","properties":{"path":{"type":"string","description":"Path of the existing object in the team's storage bucket. Cross-team paths return 404.","example":"path/my-file.txt"},"expiresInSeconds":{"type":"integer","format":"int64","description":"Time-to-live for the generated signed URL, in seconds. Defaults to 3600 (1 hour). Maximum 604800 (7 days, GCS V4 cap).","example":3600}},"required":["path"]},"SignedUrl":{"type":"object","properties":{"url":{"type":"string","description":"Signed URL that can be used to download the object directly from GCS.","example":"https://storage.googleapis.com/yepcode-storage/path/my-file.txt?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=..."},"path":{"type":"string","description":"Path of the object the URL was signed for.","example":"path/my-file.txt"},"expiresAt":{"type":"string","format":"date-time","description":"Instant at which the signed URL expires.","example":"2024-04-24T18:00:54.608"}}},"CreateSandboxInput":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sandbox.","example":"My Sandbox"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional metadata as key-value pairs (strings)."},"timeout":{"type":"integer","format":"int64","description":"Timeout for the sandbox execution in milliseconds."},"imageId":{"type":"string","description":"Sandbox runtime image identifier."},"publicHttpPorts":{"type":"array","description":"List of public HTTP ports to expose.","items":{"type":"integer","format":"int32"}},"publicHttpPortsBasicAuth":{"type":"string","description":"HTTP basic authentication for exposed public ports: user:credential. You may pass a plain-text password as the credential; it will be hashed server-side. Alternatively, pass an already-hashed credential using one of these algorithms: bcrypt ($2a$, $2b$, $2x$, $2y$), MD5 via Apache apr1 ($apr1$...), MD5 via crypt ($1$...), or SHA-1 in htpasswd {SHA} form ({SHA} plus Base-64 digest)."}},"required":["imageId"]},"Sandbox":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the sandbox","example":"a4f0c6fd-0da8-4769-8ebb-6c0c030fdfb8"},"name":{"type":"string","description":"The name of the sandbox","example":"My Sandbox"},"grpcServerUrl":{"type":"string","description":"gRPC server endpoint for this sandbox","example":"https://grpc-sandbox-id.domain.com"},"grpcApiKey":{"type":"string","description":"API key for gRPC authentication"},"imageId":{"type":"string","description":"Container / VM image identifier for this sandbox"},"publicHttpPorts":{"type":"array","description":"HTTP ports exposed publicly by the sandbox","items":{"type":"integer","format":"int32"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary metadata attached to the sandbox"},"timeoutAt":{"type":"string","format":"date-time","description":"Instant after which the sandbox is considered timed out."}},"required":["imageId"]},"UpdateSandboxInput":{"type":"object","properties":{"timeout":{"type":"integer","format":"int64","description":"Additional time in milliseconds from now until timeout (timeout deadline = current time + timeout).","example":120000}},"required":["timeout"]},"CreateProcessInput":{"type":"object","properties":{"name":{"type":"string","description":"The name of the process. This will be displayed in the UI and used for identification.","example":"My Process"},"slug":{"type":"string","description":"A unique identifier for the process. Used in URLs and API calls. Must be URL-safe (lowercase, hyphens, no spaces).","example":"my-process"},"description":{"type":"string","description":"A detailed description of what the process does. This helps users understand the process purpose and functionality.","example":"My Process Description"},"readme":{"type":"string","description":"Markdown documentation for the process. This can include usage instructions, examples, and additional context.","example":"# My Process Readme"},"programmingLanguage":{"type":"string","description":"The programming language used for the process source code. Supported languages are JAVASCRIPT and PYTHON.","enum":["JAVASCRIPT","PYTHON"],"example":"JAVASCRIPT"},"sourceCode":{"type":"string","description":"The source code of the process. This is the executable code that will run when the process is executed.","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"parametersSchema":{"type":"string","description":"JSON Schema defining the input parameters for the process. This schema is used to generate forms in the UI and validate input data.","example":{"title":"Simple form sample","description":"This is a simple sample form specification","type":"object","properties":{"oneStringField":{"title":"One string field","type":"string"},"oneIntegerField":{"title":"One integer field with range","type":"integer"},"oneBooleanField":{"title":"One boolean field","type":"boolean"}},"required":["oneStringField"]}},"webhook":{"$ref":"#/components/schemas/WebhookInput","description":"Webhook configuration for the process. Defines how the process can be triggered via HTTP webhooks."},"manifest":{"$ref":"#/components/schemas/ProcessManifestInput","description":"Process manifest configuration. Contains metadata and configuration for the process deployment and execution."},"settings":{"$ref":"#/components/schemas/SettingsInput","description":"Process settings and configuration options. Includes publication settings, form configurations, and dependencies."},"script":{"$ref":"#/components/schemas/CreateScriptInput","deprecated":true,"description":"Legacy script configuration. Use sourceCode and programmingLanguage instead."},"tags":{"type":"array","description":"Tags for categorizing and organizing processes. Used for filtering and grouping in the UI.","example":["my-tag","my-second-tag"],"items":{"type":"string"}}}},"CreateScriptInput":{"type":"object","properties":{"programmingLanguage":{"type":"string","deprecated":true,"enum":["JAVASCRIPT","PYTHON"],"example":"JAVASCRIPT"},"sourceCode":{"type":"string","deprecated":true,"example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"parametersSchema":{"type":"string","deprecated":true,"example":{"title":"Simple form sample","description":"This is a simple sample form specification","type":"object","properties":{"oneStringField":{"title":"One string field","type":"string"},"oneIntegerField":{"title":"One integer field with range","type":"integer"},"oneBooleanField":{"title":"One boolean field","type":"boolean"}},"required":["oneStringField"]}}}},"DependenciesConfigInput":{"type":"object","properties":{"scopedToProcess":{"type":"boolean","description":"Indicates if the dependencies are scoped to this specific process","example":true},"autoDetect":{"type":"boolean","description":"Enables auto dependency detection from source code. If enabled, newly detected dependencies will be added while preserving existing ones.","example":true}}},"FormsConfigInput":{"type":"object","properties":{"enabled":{"type":"boolean","example":true}}},"ProcessManifestInput":{"type":"object","properties":{"dependencies":{"type":"object","additionalProperties":{"type":"string"},"example":{"@yepcode-sdk":"1.0.0"}}}},"PublicationConfigInput":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"token":{"type":"string","example":"my-public-token"}}},"SettingsInput":{"type":"object","properties":{"formsConfig":{"$ref":"#/components/schemas/FormsConfigInput"},"publicConfig":{"$ref":"#/components/schemas/PublicationConfigInput"},"dependencies":{"$ref":"#/components/schemas/DependenciesConfigInput"}}},"WebhookInput":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"username":{"type":"string","example":"username"},"password":{"type":"string","example":"password"}}},"DependenciesConfig":{"type":"object","properties":{"scopedToProcess":{"type":"boolean","description":"Indicates if the dependencies are scoped to this specific process","example":true},"autoDetect":{"type":"boolean","description":"Enables auto dependency detection from source code. If enabled, newly detected dependencies will be added while preserving existing ones.","example":true}}},"Process":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the process","example":"a4f0c6fd-0da8-4769-8ebb-6c0c030fdfb8"},"name":{"type":"string","description":"The name of the process displayed in the UI","example":"Hello World!"},"slug":{"type":"string","description":"URL-safe unique identifier used in API calls and URLs","example":"hello-world"},"description":{"type":"string","description":"Detailed description of what the process does","example":"A sample process to show how YepCode works"},"readme":{"type":"string","description":"Markdown documentation for the process including usage instructions and examples","example":"# Hello World!"},"manifest":{"$ref":"#/components/schemas/ProcessManifest","description":"Process manifest configuration containing metadata and deployment settings"},"createdBy":{"type":"string","description":"Username of the user who created this process","example":"jane-doe"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the process was created","example":"2024-04-24T08:46:15.735"},"updatedBy":{"type":"string","description":"Username of the user who last updated this process","example":"jane-doe"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the process was last updated","example":"2024-04-24T17:00:54.608"},"parametersSchema":{"type":"object","additionalProperties":{},"description":"JSON Schema defining the input parameters for the process","example":{"name":{"type":"string"}}},"programmingLanguage":{"type":"string","description":"The programming language used for the process source code (JAVASCRIPT or PYTHON)","enum":["JAVASCRIPT","PYTHON"]},"sourceCode":{"type":"string","description":"The source code of the process that will be executed","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"webhook":{"$ref":"#/components/schemas/ProcessWebhook","description":"Webhook configuration for triggering the process via HTTP"},"settings":{"$ref":"#/components/schemas/ProcessSettings","description":"Process settings including publication, forms, and dependencies configuration"},"tags":{"type":"array","description":"Tags for categorizing and organizing processes","example":["my-tag","my-second-tag"],"items":{"type":"string"},"uniqueItems":true},"resolvingTeamSlug":{"type":"string","description":"Slug of the team where this process was resolved (current or parent). When different from the requested team path, the process is inherited.","example":"acme-team"}}},"ProcessFormsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","example":true}}},"ProcessManifest":{"type":"object","properties":{"dependencies":{"type":"object","additionalProperties":{"type":"string"},"example":{"@yepcode-sdk":"1.0.0"}}}},"ProcessPublicationConfig":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"token":{"type":"string","example":"my-public-token"}}},"ProcessSettings":{"type":"object","properties":{"formsConfig":{"$ref":"#/components/schemas/ProcessFormsConfig"},"publicConfig":{"$ref":"#/components/schemas/ProcessPublicationConfig"},"dependencies":{"$ref":"#/components/schemas/DependenciesConfig"}}},"ProcessWebhook":{"type":"object","properties":{"enabled":{"type":"boolean","example":true},"username":{"type":"string","example":"username"},"password":{"type":"string","example":"password"}}},"PublishProcessInput":{"type":"object","properties":{"tag":{"type":"string","example":"1.0.0"},"readme":{"type":"string","example":"# My Versioned process Readme"},"comment":{"type":"string","example":"My Versioned Process Comment"},"sourceCode":{"type":"string","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"parametersSchema":{"type":"string","example":{"title":"Simple form sample","description":"This is a simple sample form specification","type":"object","properties":{"oneStringField":{"title":"One string field","type":"string"},"oneIntegerField":{"title":"One integer field with range","type":"integer"},"oneBooleanField":{"title":"One boolean field","type":"boolean"}},"required":["oneStringField"]}},"script":{"$ref":"#/components/schemas/PublishProcessScriptInput","deprecated":true}}},"PublishProcessScriptInput":{"type":"object","properties":{"sourceCode":{"type":"string","deprecated":true,"example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"parametersSchema":{"type":"string","deprecated":true,"example":{"title":"Simple form sample","description":"This is a simple sample form specification","type":"object","properties":{"oneStringField":{"title":"One string field","type":"string"},"oneIntegerField":{"title":"One integer field with range","type":"integer"},"oneBooleanField":{"title":"One boolean field","type":"boolean"}},"required":["oneStringField"]}}}},"VersionedProcess":{"type":"object","properties":{"id":{"type":"string","example":"v1.0.0"},"programmingLanguage":{"type":"string","enum":["JAVASCRIPT","PYTHON"],"example":"JAVASCRIPT"},"sourceCode":{"type":"string","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"parametersSchema":{"type":"object","additionalProperties":{},"example":{"title":"Simple form sample","description":"This is a simple sample form specification","type":"object","properties":{"oneStringField":{"title":"One string field","type":"string"},"oneIntegerField":{"title":"One integer field with range","type":"integer"},"oneBooleanField":{"title":"One boolean field","type":"boolean"}},"required":["oneStringField"]}},"readme":{"type":"string","example":"# Hello World! v1.0.0"},"comment":{"type":"string","example":"version 1.0.0"},"createdAt":{"type":"string","format":"date-time","example":"2024-04-24T08:46:15.735"},"updatedAt":{"type":"string","format":"date-time","example":"2024-04-24T17:00:54.608"},"createdBy":{"type":"string","example":"jane-doe"},"updatedBy":{"type":"string","example":"jane-doe"}}},"ExecuteProcessInput":{"type":"object","properties":{"parameters":{"type":"string","description":"JSON string containing the input parameters for the process execution. Must match the process parameter schema.","example":"{ \"name\": \"YepCode\" }"},"tag":{"type":"string","description":"A version tag or an alias of the version","example":"v1.0.0"},"comment":{"type":"string","description":"Optional comment or description for this execution. Useful for tracking and debugging purposes.","example":"YepCode execution test"},"settings":{"$ref":"#/components/schemas/ExecuteProcessSettingsInput","description":"Execution-specific settings and configuration options. Overrides default process settings for this execution."}}},"ExecuteProcessSettingsInput":{"type":"object","properties":{"agentPoolSlug":{"type":"string","description":"Agent pool where to execute","example":"aws-eu-west-1"},"callbackUrl":{"type":"string","description":"URL to receive execution results upon completion (success or failure)","example":"https://my-callback-url.com/executions/results"}}},"ScheduledProcessInput":{"type":"object","properties":{"cron":{"type":"string","description":"Cron expression defining when the process should be executed. Uses standard cron syntax (minute hour day month dayOfWeek).","example":0},"dateTime":{"type":"string","format":"date-time","description":"Specific date and time when the process should be executed. Used for one-time scheduled executions.","example":"2024-04-24T12:30:00.000"},"allowConcurrentExecutions":{"type":"boolean","description":"Whether multiple executions of the same process can run concurrently. If false, new executions will be queued if one is already running.","example":true},"input":{"$ref":"#/components/schemas/ExecuteProcessInput","description":"Input parameters and settings for the scheduled process execution. Defines what parameters will be passed to the process when it runs."}}},"Schedule":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the scheduled process","example":"138f7d70-7d13-430f-9f15-a66de3ce1852"},"createdBy":{"type":"string","description":"Username of the user who created this scheduled process","example":"jane-doe"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the scheduled process was created","example":"2024-04-24T08:46:15.735"},"updatedBy":{"type":"string","description":"Username of the user who last updated this scheduled process","example":"jane-doe"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the scheduled process was last updated","example":"2024-04-24T17:00:54.608"},"processId":{"type":"string","description":"Unique identifier (UUID) of the process that is scheduled","example":"a4f0c6fd-0da8-4769-8ebb-6c0c030fdfb8"},"versionId":{"type":"string","description":"Version tag or alias of the process version to execute","example":"v2.0.0"},"comment":{"type":"string","description":"Comment or description for this scheduled process","example":"Daily execution"},"parameters":{"type":"object","additionalProperties":{},"description":"Input parameters that will be passed to the process when it executes","example":{"message":"Hello YepCode!"}},"paused":{"type":"boolean","description":"Whether the scheduled process is currently paused","example":false},"type":{"type":"string","description":"Type of scheduled process (CRON or DATETIME)","enum":["PERIODIC","ONE_TIME"]},"cron":{"type":"string","description":"Cron expression defining when the process should be executed (for CRON type)","example":0},"dateTime":{"type":"string","format":"date-time","description":"Specific date and time when the process should be executed (for DATETIME type)","example":"2024-04-24T12:30:00.000"},"settings":{"$ref":"#/components/schemas/ScheduleSettings","description":"Settings and configuration for the scheduled process execution"}}},"ScheduleSettings":{"type":"object","properties":{"allowConcurrentExecutions":{"type":"boolean"},"agentPoolSlugs":{"type":"array","example":["aws-eu-west-1","azure-us-east-1"],"items":{"type":"string"}}}},"ExecutionId":{"type":"object","description":"Execution ID","properties":{"executionId":{"type":"string"}}},"VersionedProcessAliasInput":{"type":"object","properties":{"name":{"type":"string","example":"My Versioned Process Alias"},"versionId":{"type":"string","description":"The version id of the process being aliased","example":"v1.0.0"}}},"VersionedProcessAlias":{"type":"object","properties":{"id":{"type":"string","example":"a4f0c6fd-0da8-4769-8ebb-6c0c030fdfb8"},"name":{"type":"string","example":"production"},"versionId":{"type":"string","example":"v1.0.0"},"createdAt":{"type":"string","format":"date-time","example":"2024-04-24T08:46:15.735"},"updatedAt":{"type":"string","format":"date-time","example":"2024-04-24T17:00:54.608"},"createdBy":{"type":"string","example":"jane-doe"},"updatedBy":{"type":"string","example":"jane-doe"}}},"CreateBasicScriptInput":{"type":"object","properties":{"programmingLanguage":{"type":"string","deprecated":true,"enum":["JAVASCRIPT","PYTHON"],"example":"JAVASCRIPT"},"sourceCode":{"type":"string","deprecated":true,"example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"}}},"CreateModuleInput":{"type":"object","properties":{"name":{"type":"string","description":"The name of the script library module. This will be displayed in the UI and used for identification.","example":"my-module-name"},"programmingLanguage":{"type":"string","description":"The programming language used for the module source code. Supported languages are JAVASCRIPT and PYTHON.","enum":["JAVASCRIPT","PYTHON"],"example":"JAVASCRIPT"},"sourceCode":{"type":"string","description":"The source code of the script library module. This is the reusable code that can be imported by processes.","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"script":{"$ref":"#/components/schemas/CreateBasicScriptInput","deprecated":true,"description":"Legacy script configuration. Use sourceCode and programmingLanguage instead."}}},"Module":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the script library module","example":"a4f0c6fd-0da8-4769-8ebb-6c0c030fdfb8"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the script library module was created","example":"2024-04-24T08:46:15.735"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the script library module was last updated","example":"2024-04-24T17:00:54.608"},"createdBy":{"type":"string","description":"Username of the user who created this script library module","example":"jane-doe"},"updatedBy":{"type":"string","description":"Username of the user who last updated this script library module","example":"jane-doe"},"name":{"type":"string","description":"The name of the script library module","example":"my-module-name"},"programmingLanguage":{"type":"string","description":"The programming language used for the module source code (JAVASCRIPT or PYTHON)","enum":["JAVASCRIPT","PYTHON"],"example":"JAVASCRIPT"},"sourceCode":{"type":"string","description":"The source code of the script library module that can be imported by processes","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"}}},"CreateVersionedModuleInput":{"type":"object","properties":{"tag":{"type":"string","example":"1.0.0"},"comment":{"type":"string","example":"My Script Library Comment"},"sourceCode":{"type":"string","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"script":{"$ref":"#/components/schemas/CreateVersionedModuleScriptInput","deprecated":true}}},"CreateVersionedModuleScriptInput":{"type":"object","properties":{"sourceCode":{"type":"string","deprecated":true,"example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"}}},"VersionedModule":{"type":"object","properties":{"id":{"type":"string","example":"v1.0.0"},"programmingLanguage":{"type":"string","enum":["JAVASCRIPT","PYTHON"],"example":"JAVASCRIPT"},"sourceCode":{"type":"string","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"comment":{"type":"string","example":"version 1.0.0"},"createdAt":{"type":"string","format":"date-time","example":"2024-04-24T08:46:15.735"},"updatedAt":{"type":"string","format":"date-time","example":"2024-04-24T17:00:54.608"},"createdBy":{"type":"string","example":"jane-doe"},"updatedBy":{"type":"string","example":"jane-doe"}}},"CreateVersionedModuleAliasInput":{"type":"object","properties":{"name":{"type":"string","example":"My Script Library Alias"},"versionId":{"type":"string","description":"The version id of the script library being aliased","example":"v1.0.0"}}},"VersionedModuleAlias":{"type":"object","properties":{"id":{"type":"string","example":"a4f0c6fd-0da8-4769-8ebb-6c0c030fdfb8"},"name":{"type":"string","example":"production"},"versionId":{"type":"string","example":"v1.0.0"},"createdAt":{"type":"string","format":"date-time","example":"2024-04-24T08:46:15.735"},"updatedAt":{"type":"string","format":"date-time","example":"2024-04-24T17:00:54.608"},"createdBy":{"type":"string","example":"jane-doe"},"updatedBy":{"type":"string","example":"jane-doe"}}},"Token":{"type":"object","properties":{"access_token":{"type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"},"expires_in":{"type":"integer","format":"int64","example":3600},"token_type":{"type":"string","example":"Bearer"},"scope":{"type":"string","example":"email"}}},"UpdateTeamVariableInput":{"type":"object","properties":{"key":{"type":"string","description":"The updated key/name for the team variable. Used to reference the variable in processes and executions.","example":"MY_VARIABLE"},"value":{"type":"string","description":"The updated value of the team variable. Can be any string value that will be used by processes.","example":"my-variable-value"}}},"ErrorHandlerConfigInput":{"type":"object","properties":{"processIdentifier":{"type":"string","description":"UUID or slug of the process to use as execution error handler. Set to null to clear the handler."},"processId":{"type":"string","deprecated":true,"description":"Deprecated: use processIdentifier instead."},"tag":{"type":"string","description":"Optional version tag of the error handler process."}}},"UpdateTeamInput":{"type":"object","properties":{"name":{"type":"string","description":"New display name for the team."},"zoneId":{"type":"string","description":"IANA time zone identifier.","example":"Europe/Madrid"},"parentTeamSlugs":{"type":"array","description":"List of parent team slugs. null = no change; empty list = clear all parent teams. Maximum 5 parent teams allowed.","items":{"type":"string"}},"paramsSchemaValidationEnabled":{"type":"boolean","description":"Whether to enforce JSON schema validation on process parameters."},"errorHandlerConfig":{"$ref":"#/components/schemas/ErrorHandlerConfigInput","description":"Execution error handler configuration. null = no change; provide with null processId to clear the handler."}}},"ErrorHandlerConfig":{"type":"object","properties":{"processId":{"type":"string","description":"UUID of the process used as execution error handler."},"tag":{"type":"string","description":"Optional version tag of the error handler process."}}},"Team":{"type":"object","properties":{"slug":{"type":"string","description":"Unique slug identifier for the team."},"name":{"type":"string","description":"Display name of the team."},"zoneId":{"type":"string","description":"IANA time zone identifier for the team.","example":"Europe/Madrid"},"parentTeamSlugs":{"type":"array","description":"List of parent team slugs this team inherits processes and modules from.","items":{"type":"string"}},"paramsSchemaValidationEnabled":{"type":"boolean","description":"Whether JSON schema validation is enforced on process parameters."},"errorHandlerConfig":{"$ref":"#/components/schemas/ErrorHandlerConfig","description":"Configured execution error handler process, or null if not set."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the team was created."}}},"UpdateProcessInput":{"type":"object","properties":{"name":{"type":"string","description":"The updated name of the process. This will be displayed in the UI and used for identification.","example":"My Process"},"slug":{"type":"string","description":"The updated unique identifier for the process. Used in URLs and API calls. Must be URL-safe (lowercase, hyphens, no spaces).","example":"my-process"},"description":{"type":"string","description":"The updated detailed description of what the process does. This helps users understand the process purpose and functionality.","example":"My Process Description"},"readme":{"type":"string","description":"The updated markdown documentation for the process. This can include usage instructions, examples, and additional context.","example":"# My Process Readme"},"sourceCode":{"type":"string","description":"The updated source code of the process. This is the executable code that will run when the process is executed.","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"parametersSchema":{"type":"string","description":"The updated JSON Schema defining the input parameters for the process. This schema is used to generate forms in the UI and validate input data.","example":{"title":"Simple form sample","description":"This is a simple sample form specification","type":"object","properties":{"oneStringField":{"title":"One string field","type":"string"},"oneIntegerField":{"title":"One integer field with range","type":"integer"},"oneBooleanField":{"title":"One boolean field","type":"boolean"}},"required":["oneStringField"]}},"script":{"$ref":"#/components/schemas/UpdateScriptInput","deprecated":true,"description":"Legacy script configuration. Use sourceCode instead."},"webhook":{"$ref":"#/components/schemas/WebhookInput","description":"Updated webhook configuration for the process. Defines how the process can be triggered via HTTP webhooks."},"settings":{"$ref":"#/components/schemas/SettingsInput","description":"Updated process settings and configuration options. Includes publication settings, form configurations, and dependencies."},"manifest":{"$ref":"#/components/schemas/ProcessManifestInput","description":"Updated process manifest configuration. Contains metadata and configuration for the process deployment and execution."},"tags":{"type":"array","description":"Updated tags for categorizing and organizing processes. Used for filtering and grouping in the UI.","example":["my-tag","my-second-tag"],"items":{"type":"string"}}}},"UpdateScriptInput":{"type":"object","properties":{"sourceCode":{"type":"string","deprecated":true,"example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"parametersSchema":{"type":"string","deprecated":true,"example":{"title":"Simple form sample","description":"This is a simple sample form specification","type":"object","properties":{"oneStringField":{"title":"One string field","type":"string"},"oneIntegerField":{"title":"One integer field with range","type":"integer"},"oneBooleanField":{"title":"One boolean field","type":"boolean"}},"required":["oneStringField"]}}}},"UpdateBasicScriptInput":{"type":"object","properties":{"sourceCode":{"type":"string","deprecated":true,"example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"}}},"UpdateModuleInput":{"type":"object","properties":{"name":{"type":"string","description":"The name of the script library. Must not have spaces, dashes and dots are allowed","example":"my-module-name"},"sourceCode":{"type":"string","description":"The updated source code of the script library module. This is the reusable code that can be imported by processes.","example":"const {\\n  context: { parameters },\\n} = yepcode;\\n\\nconst message = `Hello ${parameters.name}`\\n\\nconsole.log(message);\\n\\nreturn {\\n  theMessage: message\\n}"},"script":{"$ref":"#/components/schemas/UpdateBasicScriptInput","deprecated":true,"description":"Legacy script configuration. Use sourceCode instead."}}},"TeamVariablesPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/TeamVariable"}}}},"StorageObject":{"type":"object","properties":{"name":{"type":"string","example":"path/my-file.txt"},"size":{"type":"integer","format":"int64","example":1024},"md5Hash":{"type":"string","example":"a4f0c6fd-0da8-4769-8ebb-6c0c030fdfb8"},"contentType":{"type":"string","example":"text/plain"},"createdAt":{"type":"string","format":"date-time","example":"2024-04-24T17:00:54.608"},"updatedAt":{"type":"string","format":"date-time","example":"2024-04-24T17:00:54.608"},"link":{"type":"string","example":"https://cloud.yepcode.io/api/your-team/rest/storage/objects/path/my-file.txt"}}},"SchedulesPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/Schedule"}}}},"ProcessesPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/Process"}}}},"VersionedProcessesPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/VersionedProcess"}}}},"VersionedProcessAliasesPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/VersionedProcessAlias"}}}},"ModulesPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/Module"}}}},"VersionedModulesPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/VersionedModule"}}}},"VersionedModuleAliasesPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/VersionedModuleAlias"}}}},"Execution":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the execution","example":"138f7d70-7d13-430f-9f15-a66de3ce1892"},"processId":{"type":"string","description":"Unique identifier (UUID) of the process that was executed","example":"a4f0c6fd-0da8-4769-8ebb-6c0c030fdfb8"},"scheduledId":{"type":"string","description":"Unique identifier (UUID) of the scheduled process that triggered this execution (if applicable)","example":"74c679c4-4df8-4a9c-9d06-4d62ab69ed49"},"status":{"type":"string","description":"Current status of the execution (RUNNING, COMPLETED, FAILED, KILLED, etc.)","enum":["CREATED","QUEUED","DEQUEUED","RUNNING","FINISHED","KILLED","REJECTED","ERROR"]},"timeline":{"$ref":"#/components/schemas/ExecutionTimeline","description":"Timeline of execution events showing start, end, and status changes"},"parameters":{"type":"object","additionalProperties":{},"description":"Input parameters that were passed to the process during execution","example":{"name":"YepCode"}},"createdBy":{"type":"string","description":"Username of the user who initiated this execution","example":"jane-doe"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the execution was started","example":"2024-04-24T08:46:15.735"},"comment":{"type":"string","description":"Optional comment or description for this execution","example":"Say hello to YepCode"},"returnValue":{"type":"string","description":"The return value from the process execution (if completed successfully)","example":"Hello YepCode!"},"settings":{"$ref":"#/components/schemas/ExecutionSettings","description":"Execution-specific settings and configuration used for this run"}}},"ExecutionSettings":{"type":"object","properties":{"timeout":{"type":"integer","format":"int64","description":"Timeout in milliseconds","example":10000},"agentPoolSlug":{"type":"string","description":"Agent pool where the execution was executed","example":"aws-eu-west-1"}}},"ExecutionTimeline":{"type":"object","properties":{"explanation":{"type":"string"},"events":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionTimelineEvent"}}}},"ExecutionTimelineEvent":{"type":"object","properties":{"status":{"type":"string","enum":["CREATED","QUEUED","DEQUEUED","RUNNING","FINISHED","KILLED","REJECTED","ERROR"]},"timestamp":{"type":"string","format":"date-time"}}},"ExecutionsPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/Execution"}}}},"ExecutionLogsPaginatedResult":{"type":"object","properties":{"hasNextPage":{"type":"boolean","example":false},"page":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int64","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/LogEntry"}}}},"LogEntry":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2024-04-24T08:46:15.735"},"level":{"type":"string","example":"INFO"},"message":{"type":"string","example":"Hello YepCode!"}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://cloud.yepcode.io/auth/realms/yepcode/protocol/openid-connect/token","scopes":{}}}}}}}