windmill-api 1.681.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

/*
 * Windmill API
 *
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.681.0
 * Contact: contact@windmill.dev
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct HttpTrigger {
    /// The URL route path that will trigger this endpoint (e.g., 'api/myendpoint'). Must NOT start with a /.
    #[serde(rename = "route_path")]
    pub route_path: String,
    /// Configuration for serving static assets (s3 bucket, storage path, filename)
    #[serde(rename = "static_asset_config", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
    pub static_asset_config: Option<Option<Box<serde_json::Value>>>,
    #[serde(rename = "http_method")]
    pub http_method: models::HttpMethod,
    /// Path to the resource containing authentication configuration (for api_key, basic_http, custom_script, signature methods)
    #[serde(rename = "authentication_resource_path", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
    pub authentication_resource_path: Option<Option<String>>,
    /// Short summary describing the purpose of this trigger
    #[serde(rename = "summary", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
    pub summary: Option<Option<String>>,
    /// Detailed description of what this trigger does
    #[serde(rename = "description", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
    pub description: Option<Option<String>>,
    #[serde(rename = "request_type")]
    pub request_type: models::HttpRequestType,
    #[serde(rename = "authentication_method")]
    pub authentication_method: models::AuthenticationMethod,
    /// If true, serves static files from S3/storage instead of running a script
    #[serde(rename = "is_static_website")]
    pub is_static_website: bool,
    /// If true, the route includes the workspace ID in the path
    #[serde(rename = "workspaced_route")]
    pub workspaced_route: bool,
    /// If true, wraps the request body in a 'body' parameter
    #[serde(rename = "wrap_body")]
    pub wrap_body: bool,
    /// If true, passes the request body as a raw string instead of parsing as JSON
    #[serde(rename = "raw_string")]
    pub raw_string: bool,
    /// Path to a script or flow to run when the triggered job fails
    #[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
    pub error_handler_path: Option<String>,
    /// The arguments to pass to the script or flow
    #[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
    pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
    pub retry: Option<Box<models::Retry>>,
    /// The unique path identifier for this trigger
    #[serde(rename = "path")]
    pub path: String,
    /// Path to the script or flow to execute when triggered
    #[serde(rename = "script_path")]
    pub script_path: String,
    /// The user or group this trigger runs as (permissioned_as)
    #[serde(rename = "permissioned_as")]
    pub permissioned_as: String,
    /// Additional permissions for this trigger
    #[serde(rename = "extra_perms")]
    pub extra_perms: std::collections::HashMap<String, bool>,
    /// The workspace this trigger belongs to
    #[serde(rename = "workspace_id")]
    pub workspace_id: String,
    /// Username of the last person who edited this trigger
    #[serde(rename = "edited_by")]
    pub edited_by: String,
    /// Timestamp of the last edit
    #[serde(rename = "edited_at")]
    pub edited_at: String,
    /// True if script_path points to a flow, false if it points to a script
    #[serde(rename = "is_flow")]
    pub is_flow: bool,
    #[serde(rename = "mode")]
    pub mode: models::TriggerMode,
    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
    pub labels: Option<Vec<String>>,
}

impl HttpTrigger {
    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 {
        HttpTrigger {
            route_path,
            static_asset_config: None,
            http_method,
            authentication_resource_path: None,
            summary: None,
            description: None,
            request_type,
            authentication_method,
            is_static_website,
            workspaced_route,
            wrap_body,
            raw_string,
            error_handler_path: None,
            error_handler_args: None,
            retry: None,
            path,
            script_path,
            permissioned_as,
            extra_perms,
            workspace_id,
            edited_by,
            edited_at,
            is_flow,
            mode,
            labels: None,
        }
    }
}