Module
x/windmill/windmill-api/FlowApi.md
Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Very Popular
.FlowApi
All URIs are relative to /api
Method | HTTP request | Description |
---|---|---|
archiveFlowByPath | POST /w/{workspace}/flows/archive/{path} | archive flow by path |
createFlow | POST /w/{workspace}/flows/create | create flow |
getFlowByPath | GET /w/{workspace}/flows/get/{path} | get flow by path |
listFlows | GET /w/{workspace}/flows/list | list all available flows |
updateFlow | POST /w/{workspace}/flows/update/{path} | update flow |
archiveFlowByPath
string archiveFlowByPath()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);
let body:.FlowApiArchiveFlowByPathRequest = {
// string
workspace: "workspace_example",
// string
path: "path_example",
};
apiInstance.archiveFlowByPath(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
workspace | [string] | defaults to undefined | |
path | [string] | defaults to undefined |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | flow archived | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
createFlow
string createFlow(inlineObject11)
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);
let body:.FlowApiCreateFlowRequest = {
// string
workspace: "workspace_example",
// InlineObject11
inlineObject11: {
path: "path_example",
summary: "summary_example",
description: "description_example",
value: {
modules: [
{
inputTransform: {
"key": {
type: "static",
step: 3.14,
value: null,
expr: "expr_example",
},
},
value: {
path: "path_example",
type: "script",
},
},
],
failureModule: {
inputTransform: {
"key": {
type: "static",
step: 3.14,
value: null,
expr: "expr_example",
},
},
value: {
path: "path_example",
type: "script",
},
},
},
schema: {},
},
};
apiInstance.createFlow(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inlineObject11 | InlineObject11 | ||
workspace | [string] | defaults to undefined |
Return type
string
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | flow created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getFlowByPath
Flow getFlowByPath()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);
let body:.FlowApiGetFlowByPathRequest = {
// string
workspace: "workspace_example",
// string
path: "path_example",
};
apiInstance.getFlowByPath(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
workspace | [string] | defaults to undefined | |
path | [string] | defaults to undefined |
Return type
Flow
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | flow details | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
listFlows
Array listFlows()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);
let body:.FlowApiListFlowsRequest = {
// string
workspace: "workspace_example",
// number | which page to return (start at 1, default 1) (optional)
page: 1,
// number | number of items to return for a given page (default 30, max 100) (optional)
perPage: 1,
// boolean | order by desc order (default true) (optional)
orderDesc: true,
// string | mask to filter exact matching user creator (optional)
createdBy: "created_by_example",
// string | mask to filter matching starting parh (optional)
pathStart: "path_start_example",
// string | mask to filter exact matching path (optional)
pathExact: "path_exact_example",
// boolean | (default false) show also the archived files. when multiple archived hash share the same path, only the ones with the latest create_at are displayed. (optional)
showArchived: true,
};
apiInstance.listFlows(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
workspace | [string] | defaults to undefined | |
page | [number] | which page to return (start at 1, default 1) | (optional) defaults to undefined |
perPage | [number] | number of items to return for a given page (default 30, max 100) | (optional) defaults to undefined |
orderDesc | [boolean] | order by desc order (default true) | (optional) defaults to undefined |
createdBy | [string] | mask to filter exact matching user creator | (optional) defaults to undefined |
pathStart | [string] | mask to filter matching starting parh | (optional) defaults to undefined |
pathExact | [string] | mask to filter exact matching path | (optional) defaults to undefined |
showArchived | [boolean] | (default false) show also the archived files. when multiple archived hash share the same path, only the ones with the latest create_at are displayed. | (optional) defaults to undefined |
Return type
Array
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | All available flow | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateFlow
string updateFlow(inlineObject12)
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);
let body:.FlowApiUpdateFlowRequest = {
// string
workspace: "workspace_example",
// string
path: "path_example",
// InlineObject12
inlineObject12: {
path: "path_example",
summary: "summary_example",
description: "description_example",
value: {
modules: [
{
inputTransform: {
"key": {
type: "static",
step: 3.14,
value: null,
expr: "expr_example",
},
},
value: {
path: "path_example",
type: "script",
},
},
],
failureModule: {
inputTransform: {
"key": {
type: "static",
step: 3.14,
value: null,
expr: "expr_example",
},
},
value: {
path: "path_example",
type: "script",
},
},
},
schema: {},
},
};
apiInstance.updateFlow(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inlineObject12 | InlineObject12 | ||
workspace | [string] | defaults to undefined | |
path | [string] | defaults to undefined |
Return type
string
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | flow updated | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]