stately-files 0.5.0

File upload and relative path management for stately
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

#![expect(clippy::needless_for_each)]
//! `OpenAPI` documentation for stately-files endpoints.

use super::path::{RelativePath, UserDefinedPath};
use super::request::{FileDownloadQuery, FileListQuery, FileSaveRequest};
use super::response::{FileInfo, FileListResponse, FileUploadResponse, FileVersion};
use crate::path::VersionedPath;

/// `OpenAPI` documentation for file management endpoints.
#[derive(utoipa::OpenApi, Clone, Copy)]
#[openapi(
    paths(
        super::handlers::upload,
        super::handlers::save_file,
        super::handlers::list_files,
        super::handlers::download_cache,
        super::handlers::download_data,
        super::handlers::download_upload,
    ),
    components(
        responses(
            FileListResponse,
            FileUploadResponse,
            stately::ApiError,
        ),
        schemas(
            FileListResponse,
            FileUploadResponse,
            FileInfo,
            FileListQuery,
            FileDownloadQuery,
            FileSaveRequest,
            FileVersion,
            UserDefinedPath,
            RelativePath,
            VersionedPath,
        )
    ),
    tags((name = "files", description = "File management endpoints"))
)]
pub struct OpenApiDoc;