sos-server 0.17.2

Server for the Save Our Secrets sync protocol.
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

use crate::handlers::{account, files};
use utoipa::{openapi::security::*, Modify, OpenApi};

#[derive(OpenApi)]
#[openapi(
    info(
        title = "Save Our Secrets API",
        description = "Sever backend for self-hosted Save Our Secrets accounts.",
        version = "v1",
        contact(
            name = "Save Our Secrets",
            url = "https://saveoursecrets.com",
        ),
    ),
    servers(
        (
            url = "http://localhost:5053/api/v1",
            description = "Local server"
        )
    ),
    paths(
        account::account_exists,
        account::create_account,
        account::fetch_account,
        account::sync_status,
        account::sync_account,
        account::update_account,
        account::event_scan,
        account::event_diff,
        account::event_patch,
        account::delete_account,
        files::receive_file,
        files::send_file,
        files::move_file,
        files::delete_file,
    ),
    components(
        schemas(),
    ),
)]
pub struct ApiDoc;

/// Get the OpenApi schema.
pub fn openapi() -> utoipa::openapi::OpenApi {
    // NOTE: using `modifiers(&SecurityAddon)` directly to ApiDoc
    // NOTE: causes RapidDoc to show recursive schemas for examples.
    //
    // NOTE: By merging like this we avoid this bug.
    let mut api = ApiDoc::openapi();
    let security = SecurityApi::openapi();
    api.merge(security);
    api
}

#[derive(OpenApi)]
#[openapi(
    modifiers(&SecurityAddon),
)]
pub struct SecurityApi;

struct SecurityAddon;

impl Modify for SecurityAddon {
    fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
        openapi.components = Some(
            utoipa::openapi::ComponentsBuilder::new()
                .security_scheme(
                    "bearer_token",
                    SecurityScheme::Http(
                        HttpBuilder::new()
                            .scheme(HttpAuthScheme::Bearer)
                            .bearer_format("SOS")
                            .build(),
                    ),
                )
                .build(),
        )
    }
}