oxios-web 0.1.1

Web dashboard channel for Oxios
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

//! OpenAPI specification and Swagger UI setup.
//!
//! Provides a minimal OpenAPI 3.0 spec that can be populated
//! incrementally as routes are documented with utoipa annotations.

use utoipa::openapi::security::{HttpAuthScheme, HttpBuilder, SecurityScheme};

/// Build the OpenAPI specification for the Oxios web API.
pub fn build_openapi() -> utoipa::openapi::OpenApi {
    utoipa::openapi::OpenApiBuilder::new()
        .info(
            utoipa::openapi::InfoBuilder::new()
                .title("Oxios API")
                .version(env!("CARGO_PKG_VERSION"))
                .description(Some("Oxios agent orchestration platform API"))
                .build(),
        )
        .paths(utoipa::openapi::PathsBuilder::new().build())
        .components(Some(
            utoipa::openapi::ComponentsBuilder::new()
                .security_scheme(
                    "bearer_auth",
                    SecurityScheme::Http(
                        HttpBuilder::new()
                            .scheme(HttpAuthScheme::Bearer)
                            .bearer_format("JWT")
                            .build(),
                    ),
                )
                .build(),
        ))
        .build()
}