gitlab/api/projects/issues/notes/
delete.rs

1// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
2// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
3// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
4// option. This file may not be copied, modified, or distributed
5// except according to those terms.
6
7use derive_builder::Builder;
8
9use crate::api::common::NameOrId;
10use crate::api::endpoint_prelude::*;
11
12/// Delete an issue note on a project.
13#[derive(Debug, Builder, Clone)]
14pub struct DeleteIssueNote<'a> {
15    /// The project the issue belongs to.
16    #[builder(setter(into))]
17    project: NameOrId<'a>,
18    /// The ID of the issue.
19    issue: u64,
20    /// The ID of the note.
21    note: u64,
22}
23
24impl<'a> DeleteIssueNote<'a> {
25    /// Create a builder for the endpoint.
26    pub fn builder() -> DeleteIssueNoteBuilder<'a> {
27        DeleteIssueNoteBuilder::default()
28    }
29}
30
31impl Endpoint for DeleteIssueNote<'_> {
32    fn method(&self) -> Method {
33        Method::DELETE
34    }
35
36    fn endpoint(&self) -> Cow<'static, str> {
37        format!(
38            "projects/{}/issues/{}/notes/{}",
39            self.project, self.issue, self.note,
40        )
41        .into()
42    }
43}
44
45#[cfg(test)]
46mod tests {
47    use http::Method;
48
49    use crate::api::projects::issues::notes::{DeleteIssueNote, DeleteIssueNoteBuilderError};
50    use crate::api::{self, Query};
51    use crate::test::client::{ExpectedUrl, SingleTestClient};
52
53    #[test]
54    fn project_issue_and_note_are_necessary() {
55        let err = DeleteIssueNote::builder().build().unwrap_err();
56        crate::test::assert_missing_field!(err, DeleteIssueNoteBuilderError, "project");
57    }
58
59    #[test]
60    fn project_is_necessary() {
61        let err = DeleteIssueNote::builder()
62            .issue(1)
63            .note(1)
64            .build()
65            .unwrap_err();
66        crate::test::assert_missing_field!(err, DeleteIssueNoteBuilderError, "project");
67    }
68
69    #[test]
70    fn issue_is_necessary() {
71        let err = DeleteIssueNote::builder()
72            .project(1)
73            .note(1)
74            .build()
75            .unwrap_err();
76        crate::test::assert_missing_field!(err, DeleteIssueNoteBuilderError, "issue");
77    }
78
79    #[test]
80    fn note_is_necessary() {
81        let err = DeleteIssueNote::builder()
82            .project(1)
83            .issue(1)
84            .build()
85            .unwrap_err();
86        crate::test::assert_missing_field!(err, DeleteIssueNoteBuilderError, "note");
87    }
88
89    #[test]
90    fn project_issue_and_note_are_sufficient() {
91        DeleteIssueNote::builder()
92            .project(1)
93            .issue(1)
94            .note(1)
95            .build()
96            .unwrap();
97    }
98
99    #[test]
100    fn endpoint() {
101        let endpoint = ExpectedUrl::builder()
102            .method(Method::DELETE)
103            .endpoint("projects/simple%2Fproject/issues/1/notes/1")
104            .build()
105            .unwrap();
106        let client = SingleTestClient::new_raw(endpoint, "");
107
108        let endpoint = DeleteIssueNote::builder()
109            .project("simple/project")
110            .issue(1)
111            .note(1)
112            .build()
113            .unwrap();
114        api::ignore(endpoint).query(&client).unwrap();
115    }
116}
gitlab/api/projects/issues/notes/delete.rs

gitlab/api/projects/issues/notes/
delete.rs
