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

use mogh_auth_client::api::manage::CreateApiKeyResponse;
use mogh_resolver::Resolve;
use serde::{Deserialize, Serialize};
use typeshare::typeshare;

use crate::entities::{I64, NoData};

use super::KomodoWriteRequest;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/CreateApiKeyForServiceUser",
  description = "**Admin only**. Create an api key for a service user.",
  request_body(content = CreateApiKeyForServiceUser),
  responses(
    (status = 200, description = "The new alerter", body = crate::entities::alerter::AlerterSchema),
  ),
)]
pub fn create_api_key_for_service_user() {}

/// **Admin only**. Create an api key for a service user.
/// Response: [CreateApiKeyResponse].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(CreateApiKeyForServiceUserResponse)]
#[error(mogh_error::Error)]
pub struct CreateApiKeyForServiceUser {
  /// Must be service user
  pub user_id: String,
  /// The name for the api key
  pub name: String,
  /// A unix timestamp in millseconds specifying api key expire time.
  /// Default is 0, which means no expiry.
  #[serde(default)]
  pub expires: I64,
}

#[typeshare]
pub type CreateApiKeyForServiceUserResponse = CreateApiKeyResponse;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/DeleteApiKeyForServiceUser",
  description = "**Admin only.** Delete an api key for a service user.",
  request_body(content = DeleteApiKeyForServiceUser),
  responses(
    (status = 200, description = "The new alerter", body = crate::entities::alerter::AlerterSchema),
  ),
)]
pub fn delete_api_key_for_service_user() {}

/// **Admin only.** Delete an api key for a service user.
/// Response: [NoData].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoWriteRequest)]
#[response(DeleteApiKeyForServiceUserResponse)]
#[error(mogh_error::Error)]
pub struct DeleteApiKeyForServiceUser {
  pub key: String,
}

#[typeshare]
pub type DeleteApiKeyForServiceUserResponse = NoData;