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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use derive_builder::Builder;
use partial_derive2::Partial;
use serde::{Deserialize, Serialize};
use strum::AsRefStr;
use typeshare::typeshare;

use crate::entities::MongoId;

#[typeshare(serialized_as = "Partial<Tag>")]
pub type _PartialTag = PartialTag;

#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Builder, Partial)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[partial_derive(Serialize, Deserialize, Debug, Clone, Default)]
#[cfg_attr(
  feature = "mongo",
  derive(mongo_indexed::derive::MongoIndexed)
)]
pub struct Tag {
  /// The Mongo ID of the tag.
  /// This field is de/serialized from/to JSON as
  /// `{ "_id": { "$oid": "..." }, ...(rest of serialized Tag) }`
  #[serde(
    default,
    rename = "_id",
    skip_serializing_if = "String::is_empty",
    with = "bson::serde_helpers::hex_string_as_object_id"
  )]
  #[builder(setter(skip))]
  pub id: MongoId,

  #[cfg_attr(feature = "mongo", unique_index)]
  pub name: String,

  #[serde(default)]
  #[builder(default)]
  #[cfg_attr(feature = "mongo", index)]
  pub owner: String,

  /// Hex color code with alpha for UI display
  #[serde(default)]
  #[builder(default)]
  pub color: TagColor,
  // /// This field is not stored on database,
  // /// but rather populated at query time based on results from the other resources.
  // #[serde(default, skip_serializing_if = "is_false")]
  // #[builder(default)]
  // pub unused: bool,
}

// fn is_false(b: &bool) -> bool {
//   !b
// }

impl Tag {
  pub fn builder() -> TagBuilder {
    TagBuilder::default()
  }
}

#[typeshare]
#[derive(Serialize, Deserialize, Default, Debug, Clone, AsRefStr)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub enum TagColor {
  LightSlate,
  #[default]
  Slate,
  DarkSlate,

  LightRed,
  Red,
  DarkRed,

  LightOrange,
  Orange,
  DarkOrange,

  LightAmber,
  Amber,
  DarkAmber,

  LightYellow,
  Yellow,
  DarkYellow,

  LightLime,
  Lime,
  DarkLime,

  LightGreen,
  Green,
  DarkGreen,

  LightEmerald,
  Emerald,
  DarkEmerald,

  LightTeal,
  Teal,
  DarkTeal,

  LightCyan,
  Cyan,
  DarkCyan,

  LightSky,
  Sky,
  DarkSky,

  LightBlue,
  Blue,
  DarkBlue,

  LightIndigo,
  Indigo,
  DarkIndigo,

  LightViolet,
  Violet,
  DarkViolet,

  LightPurple,
  Purple,
  DarkPurple,

  LightFuchsia,
  Fuchsia,
  DarkFuchsia,

  LightPink,
  Pink,
  DarkPink,

  LightRose,
  Rose,
  DarkRose,
}