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

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

use crate::entities::terminal::{Terminal, TerminalTarget};

use super::KomodoReadRequest;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ListTerminals",
  description = "List Terminals.",
  request_body(content = ListTerminals),
  responses(
    (status = 200, description = "The list of terminals", body = ListTerminalsResponse),
  ),
)]
pub fn list_terminals() {}

/// List Terminals.
/// Response: [ListTerminalsResponse].
#[typeshare]
#[derive(Debug, Clone, Default, Serialize, Deserialize, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ListTerminalsResponse)]
#[error(mogh_error::Error)]
pub struct ListTerminals {
  /// Filter the Terminals returned by the Target.
  pub target: Option<TerminalTarget>,
  /// Return results with resource names instead of ids.
  #[serde(default)]
  pub use_names: bool,
}

#[typeshare]
pub type ListTerminalsResponse = Vec<Terminal>;