Skip to main content

conductor/models/
integration.rs

1// Copyright {{.Year}} Conductor OSS
2// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
3
4use serde::{Deserialize, Serialize};
5use std::collections::HashMap;
6
7/// Integration with an external system.
8#[derive(Debug, Clone, Default, Serialize, Deserialize)]
9#[serde(rename_all = "camelCase")]
10pub struct Integration {
11    /// Integration name.
12    pub name: String,
13
14    /// Integration type/category.
15    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
16    pub integration_type: Option<String>,
17
18    /// Provider category.
19    #[serde(skip_serializing_if = "Option::is_none")]
20    pub category: Option<String>,
21
22    /// Whether the integration is enabled.
23    #[serde(default)]
24    pub enabled: bool,
25
26    /// Description.
27    #[serde(skip_serializing_if = "Option::is_none")]
28    pub description: Option<String>,
29
30    /// Configuration.
31    #[serde(default)]
32    pub configuration: HashMap<String, serde_json::Value>,
33
34    /// Create time.
35    #[serde(skip_serializing_if = "Option::is_none")]
36    pub create_time: Option<i64>,
37
38    /// Created by.
39    #[serde(skip_serializing_if = "Option::is_none")]
40    pub created_by: Option<String>,
41
42    /// Update time.
43    #[serde(skip_serializing_if = "Option::is_none")]
44    pub update_time: Option<i64>,
45
46    /// Updated by.
47    #[serde(skip_serializing_if = "Option::is_none")]
48    pub updated_by: Option<String>,
49}
50
51/// Integration API (model, index, topic, etc.)
52#[derive(Debug, Clone, Default, Serialize, Deserialize)]
53#[serde(rename_all = "camelCase")]
54pub struct IntegrationApi {
55    /// API name.
56    pub name: String,
57
58    /// Integration name this API belongs to.
59    pub integration_name: String,
60
61    /// API configuration.
62    #[serde(default)]
63    pub configuration: HashMap<String, serde_json::Value>,
64
65    /// Whether the API is enabled.
66    #[serde(default)]
67    pub enabled: bool,
68
69    /// Description.
70    #[serde(skip_serializing_if = "Option::is_none")]
71    pub description: Option<String>,
72
73    /// Create time.
74    #[serde(skip_serializing_if = "Option::is_none")]
75    pub create_time: Option<i64>,
76
77    /// Created by.
78    #[serde(skip_serializing_if = "Option::is_none")]
79    pub created_by: Option<String>,
80
81    /// Update time.
82    #[serde(skip_serializing_if = "Option::is_none")]
83    pub update_time: Option<i64>,
84
85    /// Updated by.
86    #[serde(skip_serializing_if = "Option::is_none")]
87    pub updated_by: Option<String>,
88}
89
90/// Request to update an integration.
91#[derive(Debug, Clone, Default, Serialize, Deserialize)]
92#[serde(rename_all = "camelCase")]
93pub struct IntegrationUpdate {
94    /// Integration type/category.
95    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
96    pub integration_type: Option<String>,
97
98    /// Category.
99    #[serde(skip_serializing_if = "Option::is_none")]
100    pub category: Option<String>,
101
102    /// Whether enabled.
103    #[serde(skip_serializing_if = "Option::is_none")]
104    pub enabled: Option<bool>,
105
106    /// Description.
107    #[serde(skip_serializing_if = "Option::is_none")]
108    pub description: Option<String>,
109
110    /// Configuration.
111    #[serde(default)]
112    pub configuration: HashMap<String, serde_json::Value>,
113}
114
115/// Request to update an integration API.
116#[derive(Debug, Clone, Default, Serialize, Deserialize)]
117#[serde(rename_all = "camelCase")]
118pub struct IntegrationApiUpdate {
119    /// Configuration.
120    #[serde(default)]
121    pub configuration: HashMap<String, serde_json::Value>,
122
123    /// Whether enabled.
124    #[serde(skip_serializing_if = "Option::is_none")]
125    pub enabled: Option<bool>,
126
127    /// Description.
128    #[serde(skip_serializing_if = "Option::is_none")]
129    pub description: Option<String>,
130}