docbox-http 0.9.1

Docbox HTTP layer, routes, types, and middleware
Documentation 
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

use axum::http::StatusCode;
use docbox_core::database::models::document_box::DocumentBox;
use garde::Validate;
use serde::{Deserialize, Serialize};
use thiserror::Error;
use utoipa::ToSchema;

use crate::error::HttpError;

#[derive(Default, Debug, Validate, Deserialize, Serialize, ToSchema)]
#[serde(default)]
pub struct TenantDocumentBoxesRequest {
    /// Optional query to search document boxes by
    #[garde(skip)]
    pub query: Option<String>,

    /// Number of items to include in the response
    #[garde(skip)]
    pub size: Option<u16>,

    /// Offset to start results from
    #[garde(skip)]
    pub offset: Option<u64>,
}

#[derive(Debug, Serialize, ToSchema)]
pub struct TenantDocumentBoxesResponse {
    /// The document boxes
    pub results: Vec<DocumentBox>,
    /// The total number of document boxes available to query
    pub total: i64,
}

#[derive(Debug, Serialize, ToSchema)]
pub struct TenantStatsResponse {
    /// Total number of files within the document box
    pub total_files: i64,
    /// Total number of links within the document box
    pub total_links: i64,
    /// Total number of folders within the document box
    pub total_folders: i64,
    /// Total size of all files within the tenant
    pub file_size: i64,
}

#[derive(Debug, Error)]
pub enum HttpAdminError {
    #[error("user not found")]
    UnknownUser,
    #[error(
        "user is attached to resources, all resources must be deleted or detached before the user can be deleted"
    )]
    UserResourcesAttached,
}

impl HttpError for HttpAdminError {
    fn status(&self) -> axum::http::StatusCode {
        match self {
            HttpAdminError::UnknownUser => StatusCode::NOT_FOUND,
            HttpAdminError::UserResourcesAttached => StatusCode::BAD_REQUEST,
        }
    }
}