assay-workflow 0.1.4

Durable workflow engine with REST+SSE API, PostgreSQL/SQLite backends. Embeddable library or standalone server.
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
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

use axum::http::{header, StatusCode};
use axum::response::{Html, IntoResponse};
use axum::routing::get;
use axum::Router;
use std::sync::Arc;
use utoipa::OpenApi;

use crate::api::AppState;
use crate::store::WorkflowStore;

/// Build the OpenAPI specification for the workflow engine.
#[derive(OpenApi)]
#[openapi(
    info(
        title = "assay-workflow API",
        version = "0.1.0",
        description = "Durable workflow engine with REST+SSE API. Language-agnostic — any HTTP client can start workflows, execute activities, send signals.",
        license(name = "Apache-2.0"),
    ),
    paths(
        crate::api::workflows::start_workflow,
        crate::api::workflows::list_workflows,
        crate::api::workflows::describe_workflow,
        crate::api::workflows::get_events,
        crate::api::workflows::send_signal,
        crate::api::workflows::cancel_workflow,
        crate::api::workflows::terminate_workflow,
        crate::api::tasks::register_worker,
        crate::api::tasks::poll_task,
        crate::api::tasks::complete_task,
        crate::api::tasks::fail_task,
        crate::api::tasks::heartbeat_task,
        crate::api::tasks::worker_heartbeat,
        crate::api::schedules::create_schedule,
        crate::api::schedules::list_schedules,
        crate::api::schedules::get_schedule,
        crate::api::schedules::delete_schedule,
        crate::api::schedules::patch_schedule,
        crate::api::schedules::pause_schedule,
        crate::api::schedules::resume_schedule,
        crate::api::workflows::list_children,
        crate::api::workflows::continue_as_new,
        crate::api::workflows::get_workflow_state,
        crate::api::workflows::get_workflow_state_by_name,
        crate::api::workers::list_workers,
        crate::api::workers::health_check,
        crate::api::meta::version,
    ),
    components(schemas(
        crate::types::WorkflowRecord,
        crate::types::WorkflowEvent,
        crate::types::WorkflowActivity,
        crate::types::WorkflowTimer,
        crate::types::WorkflowSignal,
        crate::types::WorkflowSchedule,
        crate::types::WorkflowWorker,
        crate::types::WorkflowStatus,
        crate::types::ActivityStatus,
        crate::api::workflows::StartWorkflowRequest,
        crate::api::workflows::WorkflowResponse,
        crate::api::tasks::RegisterWorkerRequest,
        crate::api::tasks::RegisterWorkerResponse,
        crate::api::tasks::PollRequest,
        crate::api::tasks::CompleteTaskBody,
        crate::api::tasks::FailTaskBody,
        crate::api::schedules::CreateScheduleRequest,
        crate::api::schedules::PatchScheduleRequest,
        crate::api::workflows::ContinueAsNewBody,
        crate::api::meta::VersionInfo,
    )),
    tags(
        (name = "workflows", description = "Workflow lifecycle management"),
        (name = "tasks", description = "Task execution for worker apps"),
        (name = "schedules", description = "Cron schedule management"),
        (name = "workers", description = "Worker registry and health"),
        (name = "events", description = "Real-time event streams (SSE)"),
        (name = "meta", description = "Engine metadata (version, build info)"),
    ),
    servers(
        (url = "/", description = "Current server"),
    ),
)]
pub struct ApiDoc;

pub fn router<S: WorkflowStore + 'static>() -> Router<Arc<AppState<S>>> {
    Router::new()
        .route("/api/v1/openapi.json", get(openapi_json))
        .route("/api/v1/docs", get(docs_page))
}

async fn openapi_json() -> impl IntoResponse {
    let spec = ApiDoc::openapi().to_json().unwrap_or_default();
    (
        StatusCode::OK,
        [(header::CONTENT_TYPE, "application/json")],
        spec,
    )
}

/// Lightweight API docs page using Scalar (loaded from CDN, ~50KB).
async fn docs_page() -> Html<String> {
    let html = r#"<!DOCTYPE html>
<html>
<head>
    <title>assay-workflow API</title>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
    <script id="api-reference" data-url="/api/v1/openapi.json"></script>
    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
</body>
</html>"#;
    Html(html.to_string())
}