summaryrefslogtreecommitdiff
path: root/server/src/api_model.rs
blob: b08ad5c649c1afafb30a44f4e7f720780a17e5d1 (plain)
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
use rocket::serde::{Deserialize, Serialize};
use utoipa::ToSchema;

#[derive(Copy, Clone, Deserialize, Serialize, ToSchema)]
pub enum ReviewState {
    Draft,
    Open,
    Dropped,
    Closed,
}

#[derive(Copy, Clone, Debug, Deserialize, PartialEq, Serialize, ToSchema)]
pub enum UserReviewRole {
    Reviewer,
    Watcher,
    None,
}

#[derive(Debug, Deserialize, Serialize, PartialEq, ToSchema)]
pub struct User {
    #[schema(example = 1337u64)]
    pub id: u64,
    #[schema(example = "jsmith")]
    pub username: String,
    #[schema(example = "John Smith")]
    pub name: String,
    #[schema(example = true)]
    pub active: bool,
}

#[derive(Deserialize, Serialize, ToSchema)]
pub struct Users {
    #[schema(example = 0u32)]
    pub offset: u32,
    #[schema(example = 10u32)]
    pub limit: u32,
    #[schema(example = 42u32)]
    pub total_count: u32,
    #[schema(example = true)]
    pub more: bool,
    pub users: Vec<User>,
}

#[derive(Serialize, ToSchema)]
pub struct ReviewUserEntry {
    pub user: User,
    #[schema(example = UserReviewRole::Reviewer)]
    pub role: UserReviewRole,
}

#[derive(Serialize, ToSchema)]
pub struct Review {
    #[schema(example = 1000u64)]
    pub id: u64,
    #[schema(example = "FAKE-512: Add more features")]
    pub title: String,
    #[schema(example = "We're adding more features because features are what we want.")]
    pub description: String,
    pub owner: User,
    pub users: Vec<ReviewUserEntry>,
    #[schema(example = ReviewState::Open)]
    pub state: ReviewState,
    #[schema(example = 37.5)]
    pub progress: f32,
}

#[derive(Serialize, ToSchema)]
pub struct ReviewEntry {
    #[schema(example = 1000u64)]
    pub id: u64,
    #[schema(example = "FAKE-512: Add more features")]
    pub title: String,
    pub owner: User,
    #[schema(example = ReviewState::Open)]
    pub state: ReviewState,
    #[schema(example = 37.5)]
    pub progress: f32,
}

#[derive(Serialize, ToSchema)]
pub struct Reviews {
    #[schema(example = 0u32)]
    pub offset: u32,
    #[schema(example = 10u32)]
    pub limit: u32,
    #[schema(example = 42u32)]
    pub total_count: u32,
    #[schema(example = true)]
    pub more: bool,
    pub reviews: Vec<ReviewEntry>,
}

#[derive(Debug, Deserialize, PartialEq, Serialize, ToSchema)]
pub struct ProjectUserEntry {
    pub user: User,
    #[schema(example = UserReviewRole::Reviewer)]
    pub default_role: UserReviewRole,
    #[schema(example = false)]
    pub maintainer: bool,
}

#[derive(Deserialize, Serialize, ToSchema)]
pub struct ProjectUserEntryData {
    #[schema(example = UserReviewRole::Reviewer)]
    pub default_role: Option<UserReviewRole>,
    #[schema(example = false)]
    pub maintainer: Option<bool>,
}

#[derive(Debug, Deserialize, PartialEq, Serialize, ToSchema)]
pub struct Project {
    #[schema(example = 1u64)]
    pub id: u64,
    #[schema(example = "FAKE: Features All Kids Erase")]
    pub title: String,
    #[schema(example = "Example project")]
    pub description: String,
    pub users: Vec<ProjectUserEntry>,
}

#[derive(Deserialize, Serialize, ToSchema)]
pub struct ProjectData<'r> {
    #[schema(example = "FAKE: Features All Kids Erase")]
    pub title: Option<&'r str>,
    #[schema(example = "Example project")]
    pub description: Option<&'r str>,
}

#[derive(Deserialize, Serialize, ToSchema)]
pub struct ProjectEntry {
    #[schema(example = 1u64)]
    pub id: u64,
    #[schema(example = "FAKE: Features All Kids Erase")]
    pub title: String,
}

#[derive(Deserialize, Serialize, ToSchema)]
pub struct Projects {
    #[schema(example = 0u32)]
    pub offset: u32,
    #[schema(example = 10u32)]
    pub limit: u32,
    #[schema(example = 1u32)]
    pub total_count: u32,
    #[schema(example = false)]
    pub more: bool,
    pub projects: Vec<ProjectEntry>,
}

#[derive(Deserialize, Serialize, ToSchema)]
pub struct StatusResponse {
    pub ok: bool,
    #[serde(
        skip_serializing_if = "Option::is_none",
        // &'static str is problematic for serde, only used in tests anyway.
        skip_deserializing,
    )]
    pub error: Option<&'static str>,
}