komodo_client 2.1.0

Client for the Komodo build and deployment system
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use mogh_resolver::Resolve;
use serde::{Deserialize, Serialize};
use typeshare::typeshare;

use crate::entities::variable::Variable;

use super::KomodoWriteRequest;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/CreateVariable",
  description = "**Admin only.** Create variable.",
  request_body(content = CreateVariable),
  responses(
    (status = 200, description = "The created variable", body = CreateVariableResponse),
  ),
)]
pub fn create_variable() {}

/// **Admin only.** Create variable. Response: [Variable].
#[typeshare]
#[derive(Debug, Clone, Serialize, Deserialize, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(CreateVariableResponse)]
#[error(mogh_error::Error)]
pub struct CreateVariable {
  /// The name of the variable to create.
  pub name: String,
  /// The initial value of the variable. defualt: "".
  #[serde(default)]
  pub value: String,
  /// The initial value of the description. default: "".
  #[serde(default)]
  pub description: String,
  /// Whether to make this a secret variable.
  #[serde(default)]
  pub is_secret: bool,
}

#[typeshare]
pub type CreateVariableResponse = Variable;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/UpdateVariableValue",
  description = "**Admin only.** Update variable value.",
  request_body(content = UpdateVariableValue),
  responses(
    (status = 200, description = "The updated variable", body = UpdateVariableValueResponse),
  ),
)]
pub fn update_variable_value() {}

/// **Admin only.** Update variable value. Response: [Variable].
#[typeshare]
#[derive(Debug, Clone, Serialize, Deserialize, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UpdateVariableValueResponse)]
#[error(mogh_error::Error)]
pub struct UpdateVariableValue {
  /// The name of the variable to update.
  pub name: String,
  /// The value to set.
  pub value: String,
}

#[typeshare]
pub type UpdateVariableValueResponse = Variable;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/UpdateVariableDescription",
  description = "**Admin only.** Update variable description.",
  request_body(content = UpdateVariableDescription),
  responses(
    (status = 200, description = "The updated variable", body = UpdateVariableDescriptionResponse),
  ),
)]
pub fn update_variable_description() {}

/// **Admin only.** Update variable description. Response: [Variable].
#[typeshare]
#[derive(Debug, Clone, Serialize, Deserialize, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UpdateVariableDescriptionResponse)]
#[error(mogh_error::Error)]
pub struct UpdateVariableDescription {
  /// The name of the variable to update.
  pub name: String,
  /// The description to set.
  pub description: String,
}

#[typeshare]
pub type UpdateVariableDescriptionResponse = Variable;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/UpdateVariableIsSecret",
  description = "**Admin only.** Update whether variable is secret.",
  request_body(content = UpdateVariableIsSecret),
  responses(
    (status = 200, description = "The updated variable", body = UpdateVariableIsSecretResponse),
  ),
)]
pub fn update_variable_is_secret() {}

/// **Admin only.** Update whether variable is secret. Response: [Variable].
#[typeshare]
#[derive(Debug, Clone, Serialize, Deserialize, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UpdateVariableIsSecretResponse)]
#[error(mogh_error::Error)]
pub struct UpdateVariableIsSecret {
  /// The name of the variable to update.
  pub name: String,
  /// Whether variable is secret.
  pub is_secret: bool,
}

#[typeshare]
pub type UpdateVariableIsSecretResponse = Variable;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/DeleteVariable",
  description = "**Admin only.** Delete a variable.",
  request_body(content = DeleteVariable),
  responses(
    (status = 200, description = "The deleted variable", body = DeleteVariableResponse),
  ),
)]
pub fn delete_variable() {}

/// **Admin only.** Delete a variable. Response: [Variable].
#[typeshare]
#[derive(Debug, Clone, Serialize, Deserialize, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(DeleteVariableResponse)]
#[error(mogh_error::Error)]
pub struct DeleteVariable {
  pub name: String,
}

#[typeshare]
pub type DeleteVariableResponse = Variable;