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
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
103
104
105

use utoipa::OpenApi;

use crate::{
    models::document_box::DocumentBoxScope,
    routes::{
        admin::{self, ADMIN_TAG},
        document_box::{self, DOCUMENT_BOX_TAG},
        file::{self, FILE_TAG},
        folder::{self, FOLDER_TAG},
        link::{self, LINK_TAG},
        task::{self, TASK_TAG},
        utils::{self, UTILS_TAG},
    },
};

#[derive(OpenApi)]
#[openapi(
    info(
        title = "Docbox API",
        description = "Docbox HTTP API",
        license(
            name = "MIT",
            url = "https://raw.githubusercontent.com/docbox-nz/docbox/refs/heads/main/LICENSE.md",
        )
    ),
    tags(
        (name = DOCUMENT_BOX_TAG, description = "Document box related APIs"),
        (name = FILE_TAG, description = "File related APIs"),
        (name = LINK_TAG, description = "Link related APIs"),
        (name = FOLDER_TAG, description = "Folder related APIs"),
        (name = TASK_TAG, description = "Background task related APIs"),
        (name = ADMIN_TAG, description = "Administrator and higher privilege APIs"),
        (name = UTILS_TAG, description = "Utility APIs")
    ),
    components(
        schemas(DocumentBoxScope)
    ),
    paths(
        // Admin routes
        admin::tenant_stats,
        admin::tenant_boxes,
        admin::search_tenant,
        admin::reprocess_octet_stream_files_tenant,
        admin::rebuild_search_index_tenant,
        admin::flush_database_pool_cache,
        admin::flush_tenant_cache,
        admin::http_purge_expired_presigned_tasks,
        admin::list_users,
        admin::delete_user,
        // Document box routes
        document_box::create,
        document_box::get,
        document_box::stats,
        document_box::delete,
        document_box::search,
        // File routes
        file::upload,
        file::create_presigned,
        file::get_presigned,
        file::get,
        file::get_children,
        file::get_edit_history,
        file::update,
        file::get_raw,
        file::get_raw_presigned,
        file::get_raw_named,
        file::delete,
        file::get_generated,
        file::get_generated_raw,
        file::get_generated_raw_presigned,
        file::get_generated_raw_named,
        file::search,
        // Folder routes
        folder::create,
        folder::get,
        folder::get_edit_history,
        folder::update,
        folder::delete,
        folder::create_zip,
        // Link routes
        link::create,
        link::get,
        link::get_metadata,
        link::get_favicon,
        link::get_image,
        link::get_edit_history,
        link::update,
        link::delete,
        // Task routes
        task::get,
        // Utils routes
        utils::get_options,
        utils::health,
        utils::server_details,
    )
)]
#[allow(unused)]
pub struct ApiDoc;

#[test]
#[ignore = "generates api documentation"]
fn generate_api_docs() {
    let docs = ApiDoc::openapi().to_pretty_json().unwrap();
    std::fs::write("docbox.json", docs).unwrap();
}