ares-api 0.1.0

HTTP server for Ares AI scraper
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

use utoipa::OpenApi;

#[derive(OpenApi)]
#[openapi(
    info(
        title = "Ares API",
        version = "0.1.0",
        description = "Web scraper with LLM-powered structured data extraction."
    ),
    paths(
        crate::routes::scrape,
        crate::routes::create_job,
        crate::routes::list_jobs,
        crate::routes::get_job,
        crate::routes::cancel_job,
        crate::routes::retry_job,
        crate::routes::get_extractions,
        crate::routes::list_schemas,
        crate::routes::get_schema,
        crate::routes::create_schema,
        crate::routes::update_schema_version,
        crate::routes::delete_schema_version,
        crate::routes::health,
    ),
    components(schemas(
        crate::dto::ScrapeRequest,
        crate::dto::ScrapeResponse,
        crate::dto::CreateJobRequest,
        crate::dto::CreateJobResponse,
        crate::dto::JobResponse,
        crate::dto::JobListResponse,
        crate::dto::ExtractionResponse,
        crate::dto::ExtractionHistoryResponse,
        crate::dto::SchemaListResponse,
        crate::dto::SchemaEntryResponse,
        crate::dto::SchemaDetailResponse,
        crate::dto::CreateSchemaRequest,
        crate::dto::CreateSchemaResponse,
        crate::dto::UpdateSchemaRequest,
        crate::dto::HealthResponse,
        crate::dto::ErrorResponse,
    )),
    tags(
        (name = "scrape", description = "One-shot data extraction"),
        (name = "jobs", description = "Scrape job management"),
        (name = "extractions", description = "Extraction history"),
        (name = "schemas", description = "Schema management"),
        (name = "system", description = "Health and system status"),
    ),
    modifiers(&SecurityAddon)
)]
pub struct ApiDoc;

/// Adds Bearer token security scheme to the OpenAPI spec.
struct SecurityAddon;

impl utoipa::Modify for SecurityAddon {
    fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
        if let Some(components) = openapi.components.as_mut() {
            components.add_security_scheme(
                "bearer",
                utoipa::openapi::security::SecurityScheme::Http(
                    utoipa::openapi::security::HttpBuilder::new()
                        .scheme(utoipa::openapi::security::HttpAuthScheme::Bearer)
                        .bearer_format("token")
                        .description(Some(
                            "Admin API key. Set via ARES_ADMIN_TOKEN environment variable.",
                        ))
                        .build(),
                ),
            );
        }
    }
}