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

/*
 * Copyright (C) 2023  Aravinth Manivannan <realaravinth@batsense.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
//! Issues associated to a repository within a forge (Gitea, GitLab, etc.).
use serde::{Deserialize, Serialize};

use crate::{OpenCloseState, Reaction};

/// Issues associated to a repository within a forge (Gitea, GitLab, etc.).
#[derive(Clone, Debug, Serialize, Deserialize, Default, Eq, PartialEq)]
pub struct Issue {
    /// Unique identifier, relative to the repository
    pub index: usize,

    /// Unique identifier of the user who authored the issue.
    pub poster_id: usize,

    /// Short description displayed as the title.
    pub title: String,

    /// Long, multiline, description
    pub content: String,

    /// Target branch in the repository.
    ///
    /// NOTE: Actual property is called "ref" but it is a keyword in Rust so we are using
    /// "reference". However, "reference" will automatically be renamed to "ref" while serializing
    /// and vice versa
    #[serde(rename(serialize = "ref", deserialize = "ref"))]
    pub reference: Option<String>,

    /// Name of the milestone
    pub milestone: Option<String>,

    /// state of the issue
    pub state: OpenCloseState,

    /// A locked issue can only be modified by privileged users
    pub is_locked: bool,

    // TODO: add validation for format "date-time"
    /// Creation time
    pub created: String,

    // TODO: add validation for format "date-time"
    /// Last update time
    pub updated: String,

    // TODO: add validation for format "date-time"
    /// The last time 'state' changed to 'closed'
    pub closed: Option<String>,

    ///  List of labels.
    pub labels: Option<Vec<String>>,

    /// List of reactions
    pub reactions: Option<Vec<Reaction>>,

    ///  List of assignees.
    pub assignees: Option<Vec<String>>,
}