windmill_api/models/
new_script.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.864.0
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 NewScript {
16    #[serde(rename = "path")]
17    pub path: String,
18    /// The hash of the version this one supersedes: deploying with it archives that version and chains the new one onto its history, and a `path` differing from the superseded version's moves the script there.
19    #[serde(rename = "parent_hash", skip_serializing_if = "Option::is_none")]
20    pub parent_hash: Option<String>,
21    /// When true, the backend resolves the parent to the current deployed head for this path within the transaction (ignoring parent_hash), instead of failing with a \"lineage must be linear\" error when the supplied parent_hash is stale.
22    #[serde(rename = "auto_parent", skip_serializing_if = "Option::is_none")]
23    pub auto_parent: Option<bool>,
24    #[serde(rename = "summary")]
25    pub summary: String,
26    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
27    pub description: Option<String>,
28    #[serde(rename = "content")]
29    pub content: String,
30    /// JSON Schema of the arguments of `main`, which is what a run form and an MCP tool offer. Omitted (or `{}`), it is inferred from `content` for TypeScript, Python, Go, Bash, PowerShell, SQL, GraphQL and Ansible scripts. For other languages, or code that does not parse, a new script gets none. A new version of an existing script also keeps what the previous version's schema says about each argument, or that whole schema when nothing can be inferred. A dbt script always takes its schema from its descriptor, whatever is sent.
31    #[serde(rename = "schema", skip_serializing_if = "Option::is_none")]
32    pub schema: Option<serde_json::Value>,
33    #[serde(rename = "is_template", skip_serializing_if = "Option::is_none")]
34    pub is_template: Option<bool>,
35    #[serde(rename = "lock", skip_serializing_if = "Option::is_none")]
36    pub lock: Option<String>,
37    #[serde(rename = "language")]
38    pub language: models::ScriptLang,
39    #[serde(rename = "kind", skip_serializing_if = "Option::is_none")]
40    pub kind: Option<Kind>,
41    #[serde(rename = "tag", skip_serializing_if = "Option::is_none")]
42    pub tag: Option<String>,
43    #[serde(rename = "envs", skip_serializing_if = "Option::is_none")]
44    pub envs: Option<Vec<String>>,
45    #[serde(rename = "concurrent_limit", skip_serializing_if = "Option::is_none")]
46    pub concurrent_limit: Option<i32>,
47    #[serde(rename = "concurrency_time_window_s", skip_serializing_if = "Option::is_none")]
48    pub concurrency_time_window_s: Option<i32>,
49    /// What a run does when its concurrency limit is reached when a worker picks it up. `queue` (default) re-queues it to a later slot, `fail` ends it immediately as failed.
50    #[serde(rename = "on_concurrency_limit", skip_serializing_if = "Option::is_none")]
51    pub on_concurrency_limit: Option<OnConcurrencyLimit>,
52    #[serde(rename = "cache_ttl", skip_serializing_if = "Option::is_none")]
53    pub cache_ttl: Option<f64>,
54    #[serde(rename = "cache_ignore_s3_path", skip_serializing_if = "Option::is_none")]
55    pub cache_ignore_s3_path: Option<bool>,
56    #[serde(rename = "dedicated_worker", skip_serializing_if = "Option::is_none")]
57    pub dedicated_worker: Option<bool>,
58    #[serde(rename = "ws_error_handler_muted", skip_serializing_if = "Option::is_none")]
59    pub ws_error_handler_muted: Option<bool>,
60    #[serde(rename = "priority", skip_serializing_if = "Option::is_none")]
61    pub priority: Option<i32>,
62    #[serde(rename = "restart_unless_cancelled", skip_serializing_if = "Option::is_none")]
63    pub restart_unless_cancelled: Option<bool>,
64    #[serde(rename = "timeout", skip_serializing_if = "Option::is_none")]
65    pub timeout: Option<i32>,
66    /// If set, delete the job's args, result and logs after this many seconds following job completion
67    #[serde(rename = "delete_after_secs", skip_serializing_if = "Option::is_none")]
68    pub delete_after_secs: Option<i32>,
69    #[serde(rename = "deployment_message", skip_serializing_if = "Option::is_none")]
70    pub deployment_message: Option<String>,
71    #[serde(rename = "concurrency_key", skip_serializing_if = "Option::is_none")]
72    pub concurrency_key: Option<String>,
73    #[serde(rename = "debounce_key", skip_serializing_if = "Option::is_none")]
74    pub debounce_key: Option<String>,
75    #[serde(rename = "debounce_delay_s", skip_serializing_if = "Option::is_none")]
76    pub debounce_delay_s: Option<i32>,
77    #[serde(rename = "debounce_args_to_accumulate", skip_serializing_if = "Option::is_none")]
78    pub debounce_args_to_accumulate: Option<Vec<String>>,
79    #[serde(rename = "max_total_debouncing_time", skip_serializing_if = "Option::is_none")]
80    pub max_total_debouncing_time: Option<i32>,
81    #[serde(rename = "max_total_debounces_amount", skip_serializing_if = "Option::is_none")]
82    pub max_total_debounces_amount: Option<i32>,
83    #[serde(rename = "visible_to_runner_only", skip_serializing_if = "Option::is_none")]
84    pub visible_to_runner_only: Option<bool>,
85    #[serde(rename = "auto_kind", skip_serializing_if = "Option::is_none")]
86    pub auto_kind: Option<String>,
87    #[serde(rename = "codebase", skip_serializing_if = "Option::is_none")]
88    pub codebase: Option<String>,
89    #[serde(rename = "has_preprocessor", skip_serializing_if = "Option::is_none")]
90    pub has_preprocessor: Option<bool>,
91    #[serde(rename = "on_behalf_of_email", skip_serializing_if = "Option::is_none")]
92    pub on_behalf_of_email: Option<String>,
93    /// Authorization identity to run as: u/{username}, g/{group}, or a bare email when the username is itself email-shaped. Supply this or on_behalf_of_email; when only the address is given it is resolved to the account it names, and an address naming nobody is rejected. A pair that disagrees is rejected.
94    #[serde(rename = "on_behalf_of", skip_serializing_if = "Option::is_none")]
95    pub on_behalf_of: Option<String>,
96    /// When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of_email / on_behalf_of pair instead of overwriting it with the caller's own identity.
97    #[serde(rename = "preserve_on_behalf_of", skip_serializing_if = "Option::is_none")]
98    pub preserve_on_behalf_of: Option<bool>,
99    #[serde(rename = "assets", skip_serializing_if = "Option::is_none")]
100    pub assets: Option<Vec<models::NewScriptAssetsInner>>,
101    /// Additional script modules keyed by relative file path
102    #[serde(rename = "modules", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
103    pub modules: Option<Option<std::collections::HashMap<String, models::ScriptModule>>>,
104    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
105    pub labels: Option<Vec<String>>,
106    /// 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. Omitting the field keeps the deployed value; null clears it.
107    #[serde(rename = "job_token_scopes", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
108    pub job_token_scopes: Option<Option<Vec<String>>>,
109    /// When true (set by the CLI / git sync), deploying this script does not delete an existing user draft at the same path.
110    #[serde(rename = "skip_draft_deletion", skip_serializing_if = "Option::is_none")]
111    pub skip_draft_deletion: Option<bool>,
112}
113
114impl NewScript {
115    pub fn new(path: String, summary: String, content: String, language: models::ScriptLang) -> NewScript {
116        NewScript {
117            path,
118            parent_hash: None,
119            auto_parent: None,
120            summary,
121            description: None,
122            content,
123            schema: None,
124            is_template: None,
125            lock: None,
126            language,
127            kind: None,
128            tag: None,
129            envs: None,
130            concurrent_limit: None,
131            concurrency_time_window_s: None,
132            on_concurrency_limit: None,
133            cache_ttl: None,
134            cache_ignore_s3_path: None,
135            dedicated_worker: None,
136            ws_error_handler_muted: None,
137            priority: None,
138            restart_unless_cancelled: None,
139            timeout: None,
140            delete_after_secs: None,
141            deployment_message: None,
142            concurrency_key: None,
143            debounce_key: None,
144            debounce_delay_s: None,
145            debounce_args_to_accumulate: None,
146            max_total_debouncing_time: None,
147            max_total_debounces_amount: None,
148            visible_to_runner_only: None,
149            auto_kind: None,
150            codebase: None,
151            has_preprocessor: None,
152            on_behalf_of_email: None,
153            on_behalf_of: None,
154            preserve_on_behalf_of: None,
155            assets: None,
156            modules: None,
157            labels: None,
158            job_token_scopes: None,
159            skip_draft_deletion: None,
160        }
161    }
162}
163/// 
164#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
165pub enum Kind {
166    #[serde(rename = "script")]
167    Script,
168    #[serde(rename = "failure")]
169    Failure,
170    #[serde(rename = "trigger")]
171    Trigger,
172    #[serde(rename = "command")]
173    Command,
174    #[serde(rename = "approval")]
175    Approval,
176    #[serde(rename = "preprocessor")]
177    Preprocessor,
178}
179
180impl Default for Kind {
181    fn default() -> Kind {
182        Self::Script
183    }
184}
185/// What a run does when its concurrency limit is reached when a worker picks it up. `queue` (default) re-queues it to a later slot, `fail` ends it immediately as failed.
186#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
187pub enum OnConcurrencyLimit {
188    #[serde(rename = "queue")]
189    Queue,
190    #[serde(rename = "fail")]
191    Fail,
192}
193
194impl Default for OnConcurrencyLimit {
195    fn default() -> OnConcurrencyLimit {
196        Self::Queue
197    }
198}
199
windmill_api/models/new_script.rs

windmill_api/models/
new_script.rs
