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

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

use crate::entities::{ResourceTarget, toml::ResourcesToml};

use super::KomodoReadRequest;

/// Response containing pretty formatted toml contents.
#[typeshare]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct TomlResponse {
  pub toml: String,
}

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ExportAllResourcesToToml",
  description = "Get sync toml for all resources which the user has permissions to view.",
  request_body(content = ExportAllResourcesToToml),
  responses(
    (status = 200, description = "The toml response", body = ExportAllResourcesToTomlResponse),
  ),
)]
pub fn export_all_resources_to_toml() {}

/// Get sync toml for all resources which the user has permissions to view.
/// Response: [TomlResponse].
#[typeshare]
#[derive(Debug, Clone, Default, Serialize, Deserialize, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ExportAllResourcesToTomlResponse)]
#[error(mogh_error::Error)]
pub struct ExportAllResourcesToToml {
  /// Whether to include any resources (servers, stacks, etc.)
  /// in the exported contents.
  /// Default: `true`
  #[serde(default = "default_include_resources")]
  pub include_resources: bool,
  /// Filter resources by tag.
  /// Accepts tag name or id. Empty array will not filter by tag.
  #[serde(default)]
  pub tags: Vec<String>,
  /// Whether to include variables in the exported contents.
  /// Default: false
  #[serde(default)]
  pub include_variables: bool,
  /// Whether to include user groups in the exported contents.
  /// Default: false
  #[serde(default)]
  pub include_user_groups: bool,
  /// Pass an existing [ResourcesToml] to preserve
  /// the meta configuration.
  pub existing: Option<ResourcesToml>,
}

fn default_include_resources() -> bool {
  true
}

#[typeshare]
pub type ExportAllResourcesToTomlResponse = TomlResponse;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ExportResourcesToToml",
  description = "Get sync toml for specific resources, variables, and user groups.",
  request_body(content = ExportResourcesToToml),
  responses(
    (status = 200, description = "The toml response", body = ExportResourcesToTomlResponse),
  ),
)]
pub fn export_resources_to_toml() {}

/// Get sync toml for specific resources, variables, and user groups.
/// Response: [TomlResponse].
#[typeshare]
#[derive(Debug, Clone, Default, Serialize, Deserialize, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ExportResourcesToTomlResponse)]
#[error(mogh_error::Error)]
pub struct ExportResourcesToToml {
  /// The targets to include in the export.
  #[serde(default)]
  pub targets: Vec<ResourceTarget>,
  /// The user group names or ids to include in the export.
  #[serde(default)]
  pub user_groups: Vec<String>,
  /// Whether to include variables
  #[serde(default)]
  pub include_variables: bool,
  /// Pass an existing [ResourcesToml] to preserve
  /// the meta configuration.
  pub existing: Option<ResourcesToml>,
}

#[typeshare]
pub type ExportResourcesToTomlResponse = TomlResponse;