shared/api/endpoints/
module.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
97
98
99
100
101
102
use super::ApiEndpoint;
use crate::{
    api::Method,
    domain::module::{
        LiteModule, ModuleCreatePath, ModuleCreateRequest, ModuleDeletePath, ModuleDeleteRequest,
        ModuleGetDraftPath, ModuleGetLivePath, ModuleResponse, ModuleUpdateRequest,
        ModuleUploadPath,
    },
    error::EmptyError,
};

/// Get a Module by it's concrete ID.
///
/// # Authorization
/// No authorization required.
///
/// # Errors
/// * [`NotFound`](http::StatusCode::NOT_FOUND) if the module does not exist, or the parent jig doesn't exist.
pub struct GetLive;
impl ApiEndpoint for GetLive {
    type Path = ModuleGetLivePath;
    type Req = ();
    type Res = ModuleResponse;
    type Err = EmptyError;
    const METHOD: Method = Method::Get;
}

/// Get a Module by it's concrete ID.
///
/// # Authorization
/// * One of `Admin`, `AdminJig`,, or `ManageSelfAsset` for owned JIGs or Playlists
///
/// # Errors
/// * [`Unauthorized`](http::StatusCode::UNAUTHORIZED) if authorization is not valid.
/// * [`NotFound`](http::StatusCode::NOT_FOUND) if the module does not exist, or the parent jig doesn't exist.
pub struct GetDraft;
impl ApiEndpoint for GetDraft {
    type Path = ModuleGetDraftPath;
    type Req = ();
    type Res = ModuleResponse;
    type Err = EmptyError;
    const METHOD: Method = Method::Get;
}

/// Create a Module.
///
/// # Authorization
/// Standard + [`UserScope::ManageJig`](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.
pub struct Create;
impl ApiEndpoint for Create {
    type Path = ModuleCreatePath;
    type Req = ModuleCreateRequest;
    type Res = LiteModule;
    type Err = EmptyError;
    const METHOD: Method = Method::Post;
}

/// Update a Module.
///
/// # Authorization
/// Standard + [`UserScope::ManageJig`](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 jig or module does not exist.
pub struct Update;
impl ApiEndpoint for Update {
    type Path = ModuleUploadPath;
    type Req = ModuleUpdateRequest;
    type Res = ();
    type Err = EmptyError;
    const METHOD: Method = Method::Patch;
}

/// Delete a Module.
///
/// # Authorization
/// Standard + [`UserScope::ManageJig`](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.
/// * [`NotFound`](http::StatusCode::NOT_FOUND) if the jig or module does not exist.
/// * [`BadRequest`](http::StatusCode::BAD_REQUEST) if the given `id` is not a [`Uuid`](uuid::Uuid).
pub struct Delete;
impl ApiEndpoint for Delete {
    type Path = ModuleDeletePath;
    type Req = ModuleDeleteRequest;
    type Res = ();
    type Err = EmptyError;
    const METHOD: Method = Method::Delete;
}