cf-file-parser 0.1.26

File Parser module
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use crate::api::rest::handlers;
use crate::domain::service::FileParserService;
use axum::{Extension, Router};
use modkit::api::{OpenApiRegistry, OperationBuilder, operation_builder::LicenseFeature};
use std::sync::Arc;

struct License;

impl AsRef<str> for License {
    fn as_ref(&self) -> &'static str {
        "gts.cf.core.lic.feat.v1~cf.core.global.base.v1"
    }
}

impl LicenseFeature for License {}

#[allow(clippy::needless_pass_by_value)] // Arc is intentionally passed by value for Extension layer
pub fn register_routes(
    mut router: Router,
    openapi: &dyn OpenApiRegistry,
    service: Arc<FileParserService>,
) -> Router {
    // Explicitly register nested schemas that are only transitively referenced
    // These are used within ParsedBlockDto but not directly in any endpoint
    use modkit::api::ensure_schema;
    let _ = ensure_schema::<crate::api::rest::dto::TableBlockDto>(openapi);
    let _ = ensure_schema::<crate::api::rest::dto::TableRowDto>(openapi);
    let _ = ensure_schema::<crate::api::rest::dto::TableCellDto>(openapi);
    let _ = ensure_schema::<crate::api::rest::dto::InlineStyleDto>(openapi);
    let _ = ensure_schema::<crate::api::rest::dto::InlineDto>(openapi);

    // GET /file-parser/v1/info - Get information about available file parsers
    router = OperationBuilder::get("/file-parser/v1/info")
        .operation_id("file_parser.get_parser_info")
        .summary("Get information about available file parsers")
        .tag("File Parser")
        .authenticated()
        .require_license_features::<License>([])
        .handler(handlers::get_parser_info)
        .json_response_with_schema::<crate::api::rest::dto::FileParserInfoDto>(
            openapi,
            http::StatusCode::OK,
            "Information about available parsers",
        )
        .standard_errors(openapi)
        .register(router, openapi);

    // POST /file-parser/v1/parse-local - Parse a file from a local path
    router = OperationBuilder::post("/file-parser/v1/parse-local")
        .operation_id("file_parser.parse_local")
        .summary("Parse a file from a local path")
        .tag("File Parser")
        .authenticated()
        .require_license_features::<License>([])
        .query_param_typed(
            "render_markdown",
            false,
            "Render Markdown output if true (optional, default false)",
            "boolean",
        )
        .json_request::<crate::api::rest::dto::ParseLocalFileRequest>(openapi, "Local file path")
        .allow_content_types(&["application/json"])
        .handler(handlers::parse_local)
        .json_response_with_schema::<crate::api::rest::dto::ParsedDocResponseDto>(
            openapi,
            http::StatusCode::OK,
            "Parsed document with optional markdown",
        )
        .standard_errors(openapi)
        .error_415(openapi)
        .register(router, openapi);

    // POST /file-parser/v1/upload - Upload and parse a file
    router = OperationBuilder::post("/file-parser/v1/upload")
        .operation_id("file_parser.upload")
        .summary("Upload and parse a file")
        .tag("File Parser")
        .authenticated()
        .require_license_features::<License>([])
        .query_param_typed(
            "render_markdown",
            false,
            "Render Markdown output if true (optional, default false)",
            "boolean",
        )
        .query_param_typed(
            "filename",
            false,
            "Optional original filename (used to determine file type if Content-Type is ambiguous)",
            "string",
        )
        .octet_stream_request(Some("Raw file bytes to parse"))
        .handler(handlers::upload_and_parse)
        .json_response_with_schema::<crate::api::rest::dto::ParsedDocResponseDto>(
            openapi,
            http::StatusCode::OK,
            "Parsed document with optional markdown",
        )
        .standard_errors(openapi)
        .error_415(openapi)
        .register(router, openapi);

    // POST /file-parser/v1/parse-local/markdown - Parse a local file and stream Markdown
    router = OperationBuilder::post("/file-parser/v1/parse-local/markdown")
        .operation_id("file_parser.parse_local_markdown")
        .summary("Parse a local file and stream Markdown")
        .tag("File Parser")
        .authenticated()
        .require_license_features::<License>([])
        .json_request::<crate::api::rest::dto::ParseLocalFileRequest>(openapi, "Local file path")
        .allow_content_types(&["application/json"])
        .handler(handlers::parse_local_markdown)
        .text_response(http::StatusCode::OK, "Markdown stream", "text/markdown")
        .standard_errors(openapi)
        .register(router, openapi);

    // POST /file-parser/v1/upload/markdown - Upload and parse a file, streaming Markdown
    router = OperationBuilder::post("/file-parser/v1/upload/markdown")
        .operation_id("file_parser.upload_markdown")
        .summary("Upload and parse a file, streaming Markdown")
        .tag("File Parser")
        .authenticated()
        .require_license_features::<License>([])
        .multipart_file_request("file", Some("File to parse and stream as Markdown"))
        .handler(handlers::upload_and_parse_markdown)
        .text_response(http::StatusCode::OK, "Markdown stream", "text/markdown")
        .standard_errors(openapi)
        .error_415(openapi)
        .register(router, openapi);

    router = router.layer(Extension(service));

    router
}