{"info":{"title":"Kodosumi API","version":"0.9.3","description":"API documentation for the Kodosumi Panel API."},"openapi":"3.1.0","servers":[{"url":"/"}],"paths":{"/login":{"get":{"tags":["Authorization"],"summary":"Login with query params","description":"Login with name and password.","operationId":"01_login_get","parameters":[{"name":"name","in":"query","schema":{"type":"string"},"required":true,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"password","in":"query","schema":{"type":"string"},"required":true,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"post":{"tags":["Authorization"],"summary":"Login with form","description":"Login with name and password using form data.","operationId":"02_login_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/RoleLogin"}}},"required":true},"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/api/login":{"post":{"tags":["Authorization"],"summary":"Login with JSON","description":"Login with name and password using JSON body.","operationId":"03_login_json","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleLogin"}}},"required":true},"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/logout":{"get":{"tags":["Authorization"],"summary":"Logout (GET)","description":"Logout and remove session cookie via GET.","operationId":"04_logout_get","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false},"post":{"tags":["Authorization"],"summary":"Logout (POST)","description":"Logout and remove session cookie via POST.","operationId":"04_logout_post","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false}},"/role":{"get":{"tags":["Access Management"],"summary":"List Roles","description":"List all roles in the system.","operationId":"21_list_roles","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleResponse"},"type":"array"}}}}},"deprecated":false},"post":{"tags":["Access Management"],"summary":"Add Role","description":"Add a new role to the system.","operationId":"20_add_role","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleCreate"}}},"required":true},"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleResponse"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/role/{rid}":{"put":{"tags":["Access Management"],"summary":"Update Role by ID","description":"Update a role by ID.","operationId":"24_edit_role","parameters":[{"name":"rid","in":"path","schema":{"type":"string","format":"uuid"},"required":true,"deprecated":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleEdit"}}},"required":true},"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleResponse"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"delete":{"tags":["Access Management"],"summary":"Delete Role by ID","description":"Delete a role by ID.","operationId":"23_delete_role","parameters":[{"name":"rid","in":"path","schema":{"type":"string","format":"uuid"},"required":true,"deprecated":false}],"responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/role/{name}":{"get":{"tags":["Access Management"],"summary":"Get Role by Name or ID","description":"Get a role by name or ID.","operationId":"22_get_role","parameters":[{"name":"name","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleResponse"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/lock/{fid}/{lid}":{"get":{"tags":["Lock Control"],"summary":"Retrieve lock","description":"Get lock input schema.","operationId":"40_get_lock","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"lid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"post":{"tags":["Lock Control"],"summary":"Provide lock input","description":"Post lock input and release the lock.","operationId":"41_post_lock","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"lid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/flow":{"get":{"tags":["Flow Control"],"summary":"Retrieve registered Flows","description":"Paginated list of Flows which did register.","operationId":"11_list_flows","parameters":[{"name":"q","in":"query","schema":{"oneOf":[{"type":"string"},{"type":"null"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"pp","in":"query","schema":{"type":"integer","default":10},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"offset","in":"query","schema":{"oneOf":[{"type":"string"},{"type":"null"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/flow/register":{"get":{"tags":["Flow Control"],"summary":"Retrieve Flow Register","description":"Retrieve list of Flow sources.","operationId":"14_list_register","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false},"put":{"tags":["Flow Operations"],"summary":"Refresh registered Flows","description":"Reconnect to the OpenAPI specification of all registered Flow sources.","operationId":"15_update_flows","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false},"post":{"tags":["Flow Operations"],"summary":"Register Flows","description":"Register one or multiple flow.","operationId":"10_register_flow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterFlow"}}},"required":true},"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EndpointResponse"},"type":"array"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/flow/tags":{"get":{"tags":["Flow Control"],"summary":"Retrieve Tag List","description":"Retrieve Tag List of registered Flows.","operationId":"12_list_tags","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"additionalProperties":{"type":"integer"},"type":"object"}}}}},"deprecated":false}},"/flow/unregister":{"post":{"tags":["Flow Operations"],"summary":"Unregister Flows","description":"Remove previoiusly registered flow sources.","operationId":"13_unregister_flow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterFlow"}}},"required":true},"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/outputs/{fid}":{"delete":{"tags":["Execution Control"],"summary":"Delete or Kill Execution","description":"Kills an active and deletes a completed execution.","operationId":"51_delete_execution","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/outputs":{"delete":{"tags":["Execution Control"],"summary":"Delete or Kill list of Executions","description":"Kills active and deletes selected executions.","operationId":"55_delete_list","responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}}},"deprecated":false}},"/outputs/html/{fid}":{"get":{"tags":["Execution Control"],"summary":"Render HTML of Final Result","description":"Render Final Result in HTML.","operationId":"56_final_html","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"text/html":{"schema":{"type":"string"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/outputs/raw/{fid}":{"get":{"tags":["Execution Control"],"summary":"Render Raw of Final Result","description":"Render Final Result in raw format.","operationId":"57_final_raw","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/outputs/main/{fid}":{"get":{"tags":["Execution Control"],"summary":"Stream Main Execution Events","description":"Stream the main events of an execution including the meta data, user input, agent information, status, errors, action, results, final results, locks and leases.","operationId":"53_get_main_stream","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"extended","in":"query","schema":{"type":"boolean","default":true},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{"content-length":{"schema":{"type":"string"},"description":"File size in bytes","required":false,"deprecated":false},"last-modified":{"schema":{"type":"string","format":"date-time"},"description":"Last modified data-time in RFC 2822 format","required":false,"deprecated":false},"etag":{"schema":{"type":"string"},"description":"Entity tag","required":false,"deprecated":false}},"content":{"":{"schema":{"type":"string","contentMediaType":"application/octet-stream"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/outputs/status/{fid}":{"get":{"tags":["Execution Control"],"summary":"Get Execution Status","description":"Retrieve the status of an execution including the final result if available and existing locks.","operationId":"50_get_status","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"extended","in":"query","schema":{"type":"boolean","default":false},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/outputs/stdio/{fid}":{"get":{"tags":["Execution Control"],"summary":"Stream Standard IO Execution Events","description":"Stream the standard IO events including `STDOUT`, `STDERR`, debug messages, errors and file upload information.","operationId":"54_get_stdio_stream","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"extended","in":"query","schema":{"type":"boolean","default":false},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{"content-length":{"schema":{"type":"string"},"description":"File size in bytes","required":false,"deprecated":false},"last-modified":{"schema":{"type":"string","format":"date-time"},"description":"Last modified data-time in RFC 2822 format","required":false,"deprecated":false},"etag":{"schema":{"type":"string"},"description":"Entity tag","required":false,"deprecated":false}},"content":{"":{"schema":{"type":"string","contentMediaType":"application/octet-stream"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/outputs/stream/{fid}":{"get":{"tags":["Execution Control"],"summary":"Stream Execution Events","description":"Full Event Stream of an execution.","operationId":"52_get_stream","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"extended","in":"query","schema":{"type":"boolean","default":false},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{"content-length":{"schema":{"type":"string"},"description":"File size in bytes","required":false,"deprecated":false},"last-modified":{"schema":{"type":"string","format":"date-time"},"description":"Last modified data-time in RFC 2822 format","required":false,"deprecated":false},"etag":{"schema":{"type":"string"},"description":"Entity tag","required":false,"deprecated":false}},"content":{"":{"schema":{"type":"string","contentMediaType":"application/octet-stream"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/timeline/changes":{"get":{"tags":["Execution Timeline"],"summary":"Get Timeline Changes","description":"Retrieve changes to timeline items since a given timestamp.","operationId":"62_get_changes","parameters":[{"name":"since","in":"query","schema":{"oneOf":[{"type":"number"},{"type":"null"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"q","in":"query","schema":{"oneOf":[{"type":"string"},{"type":"null"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/timeline/list":{"get":{"tags":["Execution Timeline"],"summary":"Get Paginated Timeline","description":"Retrieve paginated timeline results sorted from fid offset.","operationId":"61_get_list","parameters":[{"name":"pp","in":"query","schema":{"type":"integer","default":10},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"q","in":"query","schema":{"oneOf":[{"type":"string"},{"type":"null"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"offset","in":"query","schema":{"oneOf":[{"type":"string"},{"type":"null"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/deploy/{name}":{"get":{"tags":["Deployment"],"summary":"Read a deployment","description":"Reads the content of a YAML configuration","operationId":"31_read_deployment","parameters":[{"name":"name","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"post":{"tags":["Deployment"],"summary":"Create deployment","description":"Creates a new YAML configuration","operationId":"30_create_deployment","parameters":[{"name":"name","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"delete":{"tags":["Deployment"],"summary":"Delete a deployment","description":"Removes a YAML configuration","operationId":"33_delete_deployment","parameters":[{"name":"name","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/deploy":{"get":{"tags":["Deployment"],"summary":"List all deployments","description":"Returns a list of all YAML configurations","operationId":"32_list_deployments","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false}},"/serve":{"post":{"tags":["Deployment"],"summary":"Re-deploy all","description":"Redeploys all active deployment configurations","operationId":"34_deploy_all","responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false},"delete":{"tags":["Deployment"],"summary":"Shutdown all","description":"Shutdown all active deployments","operationId":"35_shutdown_all","responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}}},"deprecated":false}},"/files/cancel/{upload_id}":{"delete":{"tags":["Files Management"],"summary":"Cancel a single File Upload","description":"Cancel a single file upload session.","operationId":"75_cancel_upload","parameters":[{"name":"upload_id","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/files/complete/{fid}/{batch_id}/{dir_type}":{"post":{"tags":["Files Management"],"summary":"Complete Batch Upload","description":"Complete the upload of a batch of files with `dir_type` as `in` or `out`.","operationId":"74_complete_batch","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"batch_id","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"dir_type","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"type":"array"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/files/complete/{dir_type}":{"post":{"tags":["Files Management"],"summary":"Complete Single File Upload","description":"Complete the upload of a single file with `dir_type` as `in` or `out`.","operationId":"73_complete_upload","parameters":[{"name":"dir_type","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadComplete"}}},"required":true},"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/files/{fid}/{path}":{"get":{"tags":["Files Management"],"summary":"Retrieve a single File","description":"Retrieve a single file from the execution `in` or `out` directory.","operationId":"76_get_files","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"path","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"items":{"additionalProperties":{},"type":"object"},"type":"array"},{}]}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"delete":{"tags":["Files Management"],"summary":"Delete a file or directory","description":"Delete a file or directory from the execution `in` or `out` directory.","operationId":"77_delete_file","parameters":[{"name":"fid","in":"path","schema":{"type":"string"},"required":true,"deprecated":false},{"name":"path","in":"path","schema":{"type":"string"},"required":true,"deprecated":false}],"responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/files/init_batch":{"post":{"tags":["Files Management"],"summary":"Initialize Batch Upload","description":"Initialize a new batch upload session.","operationId":"70_init_batch","responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false}},"/files/init":{"post":{"tags":["Files Management"],"summary":"Initialize Single Upload","description":"Initialize a new single upload session.","operationId":"71_init_upload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadInit"}}},"required":true},"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/files/chunk":{"post":{"tags":["Files Management"],"summary":"Upload File Chunk","description":"Upload a chunk of a file.","operationId":"72_upload_chunk","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ChunkUpload"}}},"required":true},"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/health":{"get":{"tags":["Health Check"],"summary":"Provide kodosumi Health Check","description":"Info of Ray, Serve, Spooler, Services and Version.","operationId":"01_health_get","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false}}},"components":{"schemas":{"ChunkUpload":{"properties":{"upload_id":{"type":"string"},"chunk_number":{"type":"integer"},"chunk":{"type":"string","format":"binary","contentMediaType":"application/octet-stream"}},"type":"object","required":["chunk","chunk_number","upload_id"],"title":"ChunkUpload"},"EndpointResponse":{"properties":{"uid":{"type":"string"},"method":{"type":"string","enum":["GET","POST","PUT","DELETE"]},"url":{"type":"string"},"source":{"type":"string"},"summary":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"deprecated":{"type":"boolean","default":false},"author":{"oneOf":[{"type":"string"},{"type":"null"}]},"organization":{"oneOf":[{"type":"string"},{"type":"null"}]},"tags":{"items":{"type":"string"},"type":"array"},"base_url":{"type":"string"}},"type":"object","required":["base_url","method","source","tags","uid","url"],"title":"EndpointResponse"},"RegisterFlow":{"properties":{"url":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]}},"type":"object","required":["url"],"title":"RegisterFlow"},"RoleCreate":{"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"password":{"type":"string"},"operator":{"type":"boolean","default":false}},"type":"object","required":["email","name","password"],"title":"RoleCreate"},"RoleEdit":{"properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"email":{"oneOf":[{"type":"string","format":"email"},{"type":"null"}]},"active":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"password":{"oneOf":[{"type":"string"},{"type":"null"}]},"operator":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"type":"object","required":[],"title":"RoleEdit"},"RoleLogin":{"properties":{"name":{"type":"string"},"password":{"type":"string"},"redirect":{"oneOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["name","password"],"title":"RoleLogin"},"RoleResponse":{"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"active":{"type":"boolean"}},"type":"object","required":["active","email","id","name"],"title":"RoleResponse"},"UploadComplete":{"properties":{"upload_id":{"type":"string"},"filename":{"type":"string"},"total_chunks":{"type":"integer"},"batch_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"fid":{"oneOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["filename","total_chunks","upload_id"],"title":"UploadComplete"},"UploadInit":{"properties":{"filename":{"type":"string"},"total_chunks":{"type":"integer"},"batch_id":{"oneOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["filename","total_chunks"],"title":"UploadInit"}}}}