komodo_client 2.1.1

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

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

use crate::entities::alerter::{
  Alerter, AlerterListItem, AlerterQuery,
};

use super::KomodoReadRequest;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/GetAlerter",
  description = "Get a specific alerter.",
  request_body(content = GetAlerter),
  responses(
    (status = 200, description = "The alerter", body = crate::entities::alerter::AlerterSchema),
  ),
)]
pub fn get_alerter() {}

/// Get a specific alerter. Response: [Alerter].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(GetAlerterResponse)]
#[error(mogh_error::Error)]
pub struct GetAlerter {
  /// Id or name
  #[serde(alias = "id", alias = "name")]
  pub alerter: String,
}

#[typeshare]
pub type GetAlerterResponse = Alerter;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ListAlerters",
  description = "List alerters matching optional query.",
  request_body(content = ListAlerters),
  responses(
    (status = 200, description = "The list of alerters", body = ListAlertersResponse),
  ),
)]
pub fn list_alerters() {}

/// List alerters matching optional query. Response: [ListAlertersResponse].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Default, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ListAlertersResponse)]
#[error(mogh_error::Error)]
pub struct ListAlerters {
  /// Structured query to filter alerters.
  #[serde(default)]
  pub query: AlerterQuery,
}

#[typeshare]
pub type ListAlertersResponse = Vec<AlerterListItem>;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ListFullAlerters",
  description = "List full alerters matching optional query.",
  request_body(content = ListFullAlerters),
  responses(
    (status = 200, description = "The list of alerters", body = ListFullAlertersResponse),
  ),
)]
pub fn list_full_alerters() {}

/// List full alerters matching optional query. Response: [ListFullAlertersResponse].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Default, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ListFullAlertersResponse)]
#[error(mogh_error::Error)]
pub struct ListFullAlerters {
  /// Structured query to filter alerters.
  #[serde(default)]
  pub query: AlerterQuery,
}

#[typeshare]
pub type ListFullAlertersResponse = Vec<Alerter>;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/GetAlertersSummary",
  description = "Gets a summary of data relating to all alerters.",
  request_body(content = GetAlertersSummary),
  responses(
    (status = 200, description = "The alerters summary", body = GetAlertersSummaryResponse),
  ),
)]
pub fn get_alerters_summary() {}

/// Gets a summary of data relating to all alerters.
/// Response: [GetAlertersSummaryResponse].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(GetAlertersSummaryResponse)]
#[error(mogh_error::Error)]
pub struct GetAlertersSummary {}

/// Response for [GetAlertersSummary].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct GetAlertersSummaryResponse {
  pub total: u32,
}