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

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

use crate::entities::builder::{
  Builder, BuilderListItem, BuilderQuery,
};

use super::KomodoReadRequest;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/GetBuilder",
  description = "Get a specific builder by id or name.",
  request_body(content = GetBuilder),
  responses(
    (status = 200, description = "The builder", body = crate::entities::builder::BuilderSchema),
  ),
)]
pub fn get_builder() {}

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

#[typeshare]
pub type GetBuilderResponse = Builder;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ListBuilders",
  description = "List builders matching structured query.",
  request_body(content = ListBuilders),
  responses(
    (status = 200, description = "The list of builders", body = ListBuildersResponse),
  ),
)]
pub fn list_builders() {}

/// List builders matching structured query. Response: [ListBuildersResponse].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Default, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ListBuildersResponse)]
#[error(mogh_error::Error)]
pub struct ListBuilders {
  #[serde(default)]
  pub query: BuilderQuery,
}

#[typeshare]
pub type ListBuildersResponse = Vec<BuilderListItem>;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ListFullBuilders",
  description = "List builders matching structured query.",
  request_body(content = ListFullBuilders),
  responses(
    (status = 200, description = "The list of builders", body = ListFullBuildersResponse),
  ),
)]
pub fn list_full_builders() {}

/// List builders matching structured query. Response: [ListFullBuildersResponse].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Default, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ListFullBuildersResponse)]
#[error(mogh_error::Error)]
pub struct ListFullBuilders {
  #[serde(default)]
  pub query: BuilderQuery,
}

#[typeshare]
pub type ListFullBuildersResponse = Vec<Builder>;

//

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

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

/// Response for [GetBuildersSummary].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct GetBuildersSummaryResponse {
  /// The total number of builders.
  pub total: u32,
}