shared/api/endpoints/image/
tag.rs

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
//! Routes to manage image tags

use super::super::ApiEndpoint;
use crate::{
    api::Method,
    domain::image::tag::{
        ImageTagCreatePath, ImageTagCreateRequest, ImageTagDeletePath, ImageTagListPath,
        ImageTagListResponse, ImageTagResponse, ImageTagUpdatePath, ImageTagUpdateRequest,
    },
    error::EmptyError,
};

/// List all image tags.
///
/// # Authorization
/// Standard + [`UserScope::Admin`](crate::domain::user::UserScope)
///
/// # Errors
/// [`Unauthorized`](http::StatusCode::UNAUTHORIZED) if authorization is not valid.
///
/// [`Forbidden`](http::StatusCode::FORBIDDEN) if the user does not have sufficient permission to perform the action.
pub struct List;

impl ApiEndpoint for List {
    type Path = ImageTagListPath;
    type Req = ();
    type Res = ImageTagListResponse;
    type Err = EmptyError;
    const METHOD: Method = Method::Get;
}

/// Create an image tag.
///
/// # Authorization
/// Standard + [`UserScope::Admin`](crate::domain::user::UserScope)
///
/// # Errors
/// [`Unauthorized`](http::StatusCode::UNAUTHORIZED) if authorization is not valid.
///
/// [`Forbidden`](http::StatusCode::FORBIDDEN) if the user does not have sufficient permission to perform the action.
///
/// [`BadRequest`](http::StatusCode::BAD_REQUEST) if the request is missing/invalid.
///
/// [`Conflict`](http::StatusCode::CONFLICT) if the requested `index` is already occupied.
pub struct Create;

impl ApiEndpoint for Create {
    type Path = ImageTagCreatePath;
    type Req = ImageTagCreateRequest;
    type Res = ImageTagResponse;
    type Err = EmptyError;
    const METHOD: Method = Method::Post;
}

/// Update an image tag by index.
///
/// # Authorization
/// Standard + [`UserScope::Admin`](crate::domain::user::UserScope)
///
/// # Errors
///
/// * [`Unauthorized`](http::StatusCode::UNAUTHORIZED) if authorization is not valid.
/// * [`Forbidden`](http::StatusCode::FORBIDDEN) if the user does not have sufficient permission to perform the action.
/// * [`BadRequest`](http::StatusCode::BAD_REQUEST) if the request is missing/invalid.
/// * [`NotFound`](http::StatusCode::NOT_FOUND) if the image tag does not exist.
/// * [`Conflict`](http::StatusCode::CONFLICT) if the requested `index` is already occupied.
pub struct Update;

impl ApiEndpoint for Update {
    type Path = ImageTagUpdatePath;
    type Req = ImageTagUpdateRequest;
    type Res = ();
    type Err = EmptyError;
    const METHOD: Method = Method::Patch;
}

/// Delete an image tag by index.
///
/// # Authorization
/// Standard + [`UserScope::Admin`](crate::domain::user::UserScope)
///
/// # Errors
///
/// * [`Unauthorized`](http::StatusCode::UNAUTHORIZED) if authorization is not valid.
/// * [`Forbidden`](http::StatusCode::FORBIDDEN) if the user does not have sufficient permission to perform the action.
/// * [`BadRequest`](http::StatusCode::BAD_REQUEST) if the given `id` is not a [`Uuid`](uuid::Uuid) or the request is missing/invalid.
/// * [`NotFound`](http::StatusCode::NOT_FOUND) if the image tag does not exist.
pub struct Delete;

impl ApiEndpoint for Delete {
    type Path = ImageTagDeletePath;
    type Req = ();
    type Res = ();
    type Err = EmptyError;
    const METHOD: Method = Method::Delete;
}