openkind-api 0.1.0

Phase 1: HTTP (axum) and gRPC (tonic) protocol layer for openkind.
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

//! `openkind-api`: HTTP and gRPC transport protocols, middleware, and SDK compatibility surface.
//!
//! # Architecture & Responsibilities
//! `openkind-api` provides dual transport interfaces for `openkind`:
//! - **HTTP/REST Transport** ([`http`]): Axum 0.8 router serving `POST /v1/systemone` (canonical),
//!   `POST /v1/system_one` (SDK alias), `GET /v1/models`, `GET /health`, and `GET /metrics`.
//!   `GET /playground` ([`playground`]) serves an embedded web UI when the daemon opts in.
//! - **gRPC Transport** ([`grpc`]): Tonic 0.14 service implementing `openkind.SystemOne/Evaluate`.
//!
//! Both transports route evaluation requests through `openkind_engine::dispatch`, decoupling transport
//! encoding from inference backend execution.
//!
//! # Middleware & Wire Compatibility
//! As specified in `docs/ARCHITECTURE.md`:
//! - Outermost Request ID layer stamps `x-typesafe-request-id` on every response, including errors and 401s.
//! - Constant-time Bearer token gate on `/v1/*` routes when `OPENKIND_API_KEY` (or `TYPESAFE_API_KEY`) is configured.
//! - Error mapping with `Retry-After` and `retry-after-ms` headers on rate limits (429) and overload (529).

#![warn(missing_docs)]

/// Unofficial bulk Arrow IPC endpoint (`POST /v1/arrow`, opt-in).
pub mod arrow;
/// HTTP error mapping and Axum response conversion.
pub mod error;
/// Tonic gRPC service implementation for `openkind.SystemOne`.
pub mod grpc;
/// Axum HTTP router and endpoint handlers.
pub mod http;
/// Request ID, authentication, and rate limiting middleware.
pub mod middleware;
/// Model metadata structures and descriptors.
pub mod models;
/// Embedded web playground served at `GET /playground` (opt-in).
pub mod playground;
/// Optional proxy-cache hook consulted by the evaluation handlers.
pub mod proxy;

pub use arrow::{arrow_batch, ArrowBatchRequest, ARROW_CONTENT_TYPE};
pub use error::ApiError;
pub use http::{
    router, router_daemon, router_daemon_with_arrow, router_with_auth, router_with_state,
};
pub use middleware::{AuthConfig, RateLimitConfig, RateLimiter, REQUEST_ID_HEADER};
pub use models::{ModelInfo, ModelsResponse};
pub use proxy::{ProxyOutcome, ProxySource, SystemProxy};

use std::sync::Arc;

use openkind_engine::EngineRegistry;

/// Shared application state passed to every axum handler and tonic method.
#[derive(Clone)]
pub struct AppState {
    /// Thread-safe registry mapping model aliases to their decision engine instances.
    pub registry: Arc<EngineRegistry>,
    /// Optional daemon-owned local model lifecycle for the playground.
    pub playground_models: Option<Arc<dyn playground::PlaygroundModels>>,
    /// Optional proxy-cache hook (installed by the daemon in proxy mode).
    pub proxy: Option<Arc<dyn proxy::SystemProxy>>,
    /// Process-local weighted admission gate for Arrow batch work.
    pub(crate) arrow_admission: Arc<tokio::sync::Semaphore>,
}

impl AppState {
    /// Construct a new `AppState` wrapping the given engine registry.
    pub fn new(registry: EngineRegistry) -> Self {
        Self {
            registry: Arc::new(registry),
            playground_models: None,
            proxy: None,
            arrow_admission: Arc::new(tokio::sync::Semaphore::new(arrow::ARROW_ADMISSION_UNITS)),
        }
    }
}