windmill_api/models/
flow.rs

1/*
2 * Windmill API
3 *
4 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5 *
6 * The version of the OpenAPI document: 1.824.1
7 * Contact: contact@windmill.dev
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct Flow {
16    /// Short description of what this flow does
17    #[serde(rename = "summary")]
18    pub summary: String,
19    /// Detailed documentation for this flow
20    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
21    pub description: Option<String>,
22    #[serde(rename = "value")]
23    pub value: Box<models::FlowValue>,
24    /// JSON Schema for flow inputs. Use this to define input parameters, their types, defaults, and validation. For resource inputs, set type to 'object' and format to 'resource-<type>' (e.g., 'resource-stripe')
25    #[serde(rename = "schema", skip_serializing_if = "Option::is_none")]
26    pub schema: Option<serde_json::Value>,
27    #[serde(rename = "on_behalf_of_email", skip_serializing_if = "Option::is_none")]
28    pub on_behalf_of_email: Option<String>,
29    /// Authorization identity the runnable runs as: u/{username}, g/{group}, or a bare email when the username is itself email-shaped. The only stored half of the identity; on_behalf_of_email is derived from it.
30    #[serde(rename = "on_behalf_of", skip_serializing_if = "Option::is_none")]
31    pub on_behalf_of: Option<String>,
32    #[serde(rename = "workspace_id", skip_serializing_if = "Option::is_none")]
33    pub workspace_id: Option<String>,
34    #[serde(rename = "path")]
35    pub path: String,
36    #[serde(rename = "edited_by")]
37    pub edited_by: String,
38    #[serde(rename = "edited_at")]
39    pub edited_at: String,
40    #[serde(rename = "archived")]
41    pub archived: bool,
42    #[serde(rename = "extra_perms")]
43    pub extra_perms: std::collections::HashMap<String, bool>,
44    #[serde(rename = "starred", skip_serializing_if = "Option::is_none")]
45    pub starred: Option<bool>,
46    #[serde(rename = "draft_only", skip_serializing_if = "Option::is_none")]
47    pub draft_only: Option<bool>,
48    #[serde(rename = "tag", skip_serializing_if = "Option::is_none")]
49    pub tag: Option<String>,
50    #[serde(rename = "ws_error_handler_muted", skip_serializing_if = "Option::is_none")]
51    pub ws_error_handler_muted: Option<bool>,
52    #[serde(rename = "priority", skip_serializing_if = "Option::is_none")]
53    pub priority: Option<i32>,
54    #[serde(rename = "dedicated_worker", skip_serializing_if = "Option::is_none")]
55    pub dedicated_worker: Option<bool>,
56    #[serde(rename = "timeout", skip_serializing_if = "Option::is_none")]
57    pub timeout: Option<f64>,
58    #[serde(rename = "visible_to_runner_only", skip_serializing_if = "Option::is_none")]
59    pub visible_to_runner_only: Option<bool>,
60    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
61    pub labels: Option<Vec<String>>,
62    /// Scopes the token of every job of this runnable is restricted to (domain:action[:resource], e.g. oidc:write). Jobs it starts, flow steps and AI agent tools inherit the restriction. Unset, the job token carries the full permissions of the identity the job runs as; an empty list leaves it no API access beyond its own job.
63    #[serde(rename = "job_token_scopes", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
64    pub job_token_scopes: Option<Option<Vec<String>>>,
65    /// Labels inherited from the parent folder, computed at read time. Read-only — edit them on the folder. 
66    #[serde(rename = "inherited_labels", skip_serializing_if = "Option::is_none")]
67    pub inherited_labels: Option<Vec<String>>,
68    #[serde(rename = "lock_error_logs", skip_serializing_if = "Option::is_none")]
69    pub lock_error_logs: Option<String>,
70    #[serde(rename = "version_id", skip_serializing_if = "Option::is_none")]
71    pub version_id: Option<f64>,
72}
73
74impl Flow {
75    pub fn new(summary: String, value: models::FlowValue, path: String, edited_by: String, edited_at: String, archived: bool, extra_perms: std::collections::HashMap<String, bool>) -> Flow {
76        Flow {
77            summary,
78            description: None,
79            value: Box::new(value),
80            schema: None,
81            on_behalf_of_email: None,
82            on_behalf_of: None,
83            workspace_id: None,
84            path,
85            edited_by,
86            edited_at,
87            archived,
88            extra_perms,
89            starred: None,
90            draft_only: None,
91            tag: None,
92            ws_error_handler_muted: None,
93            priority: None,
94            dedicated_worker: None,
95            timeout: None,
96            visible_to_runner_only: None,
97            labels: None,
98            job_token_scopes: None,
99            inherited_labels: None,
100            lock_error_logs: None,
101            version_id: None,
102        }
103    }
104}
105
windmill_api/models/flow.rs

windmill_api/models/
flow.rs
