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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

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

use crate::entities::user_group::UserGroup;

use super::KomodoWriteRequest;
//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/CreateUserGroup",
  description = "**Admin only.** Create a user group.",
  request_body(content = CreateUserGroup),
  responses(
    (status = 200, description = "The new user group", body = UserGroup),
  ),
)]
pub fn create_user_group() {}

/// **Admin only.** Create a user group. Response: [UserGroup]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UserGroup)]
#[error(mogh_error::Error)]
pub struct CreateUserGroup {
  /// The name to assign to the new UserGroup
  pub name: String,
}

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/RenameUserGroup",
  description = "**Admin only.** Rename a user group.",
  request_body(content = RenameUserGroup),
  responses(
    (status = 200, description = "The renamed user group", body = UserGroup),
  ),
)]
pub fn rename_user_group() {}

/// **Admin only.** Rename a user group. Response: [UserGroup]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UserGroup)]
#[error(mogh_error::Error)]
pub struct RenameUserGroup {
  /// The id of the UserGroup
  pub id: String,
  /// The new name for the UserGroup
  pub name: String,
}

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/DeleteUserGroup",
  description = "**Admin only.** Delete a user group.",
  request_body(content = DeleteUserGroup),
  responses(
    (status = 200, description = "The deleted user group", body = UserGroup),
  ),
)]
pub fn delete_user_group() {}

/// **Admin only.** Delete a user group. Response: [UserGroup]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UserGroup)]
#[error(mogh_error::Error)]
pub struct DeleteUserGroup {
  /// The id of the UserGroup
  pub id: String,
}

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/AddUserToUserGroup",
  description = "**Admin only.** Add a user to a user group.",
  request_body(content = AddUserToUserGroup),
  responses(
    (status = 200, description = "The updated user group", body = UserGroup),
  ),
)]
pub fn add_user_to_user_group() {}

/// **Admin only.** Add a user to a user group. Response: [UserGroup]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UserGroup)]
#[error(mogh_error::Error)]
pub struct AddUserToUserGroup {
  /// The name or id of UserGroup that user should be added to.
  pub user_group: String,
  /// The id or username of the user to add
  pub user: String,
}

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/RemoveUserFromUserGroup",
  description = "**Admin only.** Remove a user from a user group.",
  request_body(content = RemoveUserFromUserGroup),
  responses(
    (status = 200, description = "The updated user group", body = UserGroup),
  ),
)]
pub fn remove_user_from_user_group() {}

/// **Admin only.** Remove a user from a user group. Response: [UserGroup]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UserGroup)]
#[error(mogh_error::Error)]
pub struct RemoveUserFromUserGroup {
  /// The name or id of UserGroup that user should be removed from.
  pub user_group: String,
  /// The id or username of the user to remove
  pub user: String,
}

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/SetUsersInUserGroup",
  description = "**Admin only.** Set users in a user group.",
  request_body(content = SetUsersInUserGroup),
  responses(
    (status = 200, description = "The updated user group", body = UserGroup),
  ),
)]
pub fn set_users_in_user_group() {}

/// **Admin only.** Completely override the users in the group.
/// Response: [UserGroup]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UserGroup)]
#[error(mogh_error::Error)]
pub struct SetUsersInUserGroup {
  /// Id or name.
  pub user_group: String,
  /// The user ids or usernames to hard set as the group's users.
  pub users: Vec<String>,
}

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/SetEveryoneUserGroup",
  description = "**Admin only.** Set everyone property of user group.",
  request_body(content = SetEveryoneUserGroup),
  responses(
    (status = 200, description = "The updated user group", body = UserGroup),
  ),
)]
pub fn set_everyone_user_group() {}

/// **Admin only.** Set `everyone` property of User Group.
/// Response: [UserGroup]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(UserGroup)]
#[error(mogh_error::Error)]
pub struct SetEveryoneUserGroup {
  /// Id or name.
  pub user_group: String,
  /// Whether this user group applies to everyone.
  pub everyone: bool,
}