converge-runtime 0.1.0

Converge HTTP/gRPC/TUI runtime server
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

// Copyright 2024-2025 Aprio One AB, Sweden
// Author: Kenneth Pernyer, kenneth@aprio.one
// SPDX-License-Identifier: MIT
// See LICENSE file in the project root for full license information.

//! `OpenAPI` schema definitions for Converge Runtime.

use utoipa::OpenApi;

use crate::error::RuntimeErrorResponse;
use crate::handlers::{ContextSummary, JobMetadata, JobRequest, JobResponse};

/// `OpenAPI` schema for Converge Runtime API.
#[derive(OpenApi)]
#[openapi(
    paths(
        crate::handlers::health,
        crate::handlers::ready,
        crate::handlers::handle_job,
    ),
    components(schemas(
        JobRequest,
        JobResponse,
        JobMetadata,
        ContextSummary,
        RuntimeErrorResponse,
    )),
    tags(
        (name = "health", description = "Health check endpoints"),
        (name = "jobs", description = "Job execution endpoints"),
    ),
    info(
        title = "Converge Runtime API",
        description = "HTTP API for the Converge Agent OS",
        version = "0.1.0",
        contact(
            name = "Converge",
            url = "https://github.com/converge",
        ),
    ),
    servers(
        (url = "http://localhost:8080", description = "Local development server"),
    ),
)]
pub struct ApiDoc;