windmill_api/models/
http_trigger.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.812.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 HttpTrigger {
16    /// The URL route path that will trigger this endpoint (e.g., 'api/myendpoint'). Must NOT start with a /.
17    #[serde(rename = "route_path")]
18    pub route_path: String,
19    /// Configuration for serving static assets (s3 bucket, storage path, filename)
20    #[serde(rename = "static_asset_config", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
21    pub static_asset_config: Option<Option<Box<serde_json::Value>>>,
22    #[serde(rename = "http_method")]
23    pub http_method: models::HttpMethod,
24    /// Path to the resource containing authentication configuration (for api_key, basic_http, custom_script, signature methods)
25    #[serde(rename = "authentication_resource_path", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
26    pub authentication_resource_path: Option<Option<String>>,
27    /// Short summary describing the purpose of this trigger
28    #[serde(rename = "summary", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
29    pub summary: Option<Option<String>>,
30    /// Detailed description of what this trigger does
31    #[serde(rename = "description", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
32    pub description: Option<Option<String>>,
33    #[serde(rename = "request_type")]
34    pub request_type: models::HttpRequestType,
35    #[serde(rename = "authentication_method")]
36    pub authentication_method: models::AuthenticationMethod,
37    /// If true, serves static files from S3/storage instead of running a script
38    #[serde(rename = "is_static_website")]
39    pub is_static_website: bool,
40    /// If true, the route includes the workspace ID in the path
41    #[serde(rename = "workspaced_route")]
42    pub workspaced_route: bool,
43    /// If true, wraps the request body in a 'body' parameter
44    #[serde(rename = "wrap_body")]
45    pub wrap_body: bool,
46    /// If true, passes the request body as a raw string instead of parsing as JSON
47    #[serde(rename = "raw_string")]
48    pub raw_string: bool,
49    /// Origins allowed to call this route cross-origin, matched against the request's Origin header (ignoring case) and echoed back on a match. When set, the list governs both the preflight and the response, overriding any Access-Control-Allow-Origin the runnable returns via wm_headers. Use ['*'] to opt out of any restriction, including the http_route_default_allowed_origins instance setting. An empty list is not a configuration and resolves exactly as null does. When null, the instance setting applies, or Access-Control-Allow-Origin: * if it is unset. Ignored on a static website, which has no authentication of its own and so hands out public files: restricting which browsers may read them protects nothing while breaking cross-origin webfonts and fetches. A single-file static asset is not exempt, since it can carry an authentication_method.
50    #[serde(rename = "allowed_origins", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
51    pub allowed_origins: Option<Option<Vec<String>>>,
52    /// Path to a script to run when the triggered job fails. A bare path, without the script/ or flow/ prefix a schedule error handler takes; it cannot be a flow.
53    #[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
54    pub error_handler_path: Option<String>,
55    /// The arguments to pass to the script or flow
56    #[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
57    pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
58    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
59    pub retry: Option<Box<models::Retry>>,
60    /// The unique Windmill path for this trigger. Must be of the form `u/<user>/<path>` or `f/<folder>/<path>`. This is the trigger object path, not the HTTP route path.
61    #[serde(rename = "path")]
62    pub path: String,
63    /// Path to the script or flow to execute when triggered
64    #[serde(rename = "script_path")]
65    pub script_path: String,
66    /// The user or group this trigger runs as (permissioned_as)
67    #[serde(rename = "permissioned_as")]
68    pub permissioned_as: String,
69    /// Additional permissions for this trigger
70    #[serde(rename = "extra_perms")]
71    pub extra_perms: std::collections::HashMap<String, bool>,
72    /// The workspace this trigger belongs to
73    #[serde(rename = "workspace_id")]
74    pub workspace_id: String,
75    /// Username of the last person who edited this trigger
76    #[serde(rename = "edited_by")]
77    pub edited_by: String,
78    /// Timestamp of the last edit
79    #[serde(rename = "edited_at")]
80    pub edited_at: String,
81    /// True if script_path points to a flow, false if it points to a script
82    #[serde(rename = "is_flow")]
83    pub is_flow: bool,
84    #[serde(rename = "mode")]
85    pub mode: models::TriggerMode,
86    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
87    pub labels: Option<Vec<String>>,
88    /// True when this row is a per-user draft with no deployed trigger at the same path. Set by list endpoints when `include_draft_only=true` synthesizes the row from the draft. Frontend renders a \"Draft\" badge. 
89    #[serde(rename = "draft_only", skip_serializing_if = "Option::is_none")]
90    pub draft_only: Option<bool>,
91    /// True when the authed user has a per-user draft at this path (over a deployed row or a synthesized draft-only row). Frontend appends a `*` to the displayed name. 
92    #[serde(rename = "is_draft", skip_serializing_if = "Option::is_none")]
93    pub is_draft: Option<bool>,
94}
95
96impl HttpTrigger {
97    pub fn new(route_path: String, http_method: models::HttpMethod, request_type: models::HttpRequestType, authentication_method: models::AuthenticationMethod, is_static_website: bool, workspaced_route: bool, wrap_body: bool, raw_string: bool, path: String, script_path: String, permissioned_as: String, extra_perms: std::collections::HashMap<String, bool>, workspace_id: String, edited_by: String, edited_at: String, is_flow: bool, mode: models::TriggerMode) -> HttpTrigger {
98        HttpTrigger {
99            route_path,
100            static_asset_config: None,
101            http_method,
102            authentication_resource_path: None,
103            summary: None,
104            description: None,
105            request_type,
106            authentication_method,
107            is_static_website,
108            workspaced_route,
109            wrap_body,
110            raw_string,
111            allowed_origins: None,
112            error_handler_path: None,
113            error_handler_args: None,
114            retry: None,
115            path,
116            script_path,
117            permissioned_as,
118            extra_perms,
119            workspace_id,
120            edited_by,
121            edited_at,
122            is_flow,
123            mode,
124            labels: None,
125            draft_only: None,
126            is_draft: None,
127        }
128    }
129}
130
windmill_api/models/http_trigger.rs

windmill_api/models/
http_trigger.rs
