oversync-api

Type-safe HTTP API for the shared oversync control-plane surface.

Part of oversync.

What this crate provides

CRUD endpoints for pipes, saved recipes, and sinks -- create, read, update, delete via REST
Pipe-first control plane -- runtime onboarding, resolve, dry-run, and import/export all flow through pipes
Operational controls -- trigger sync, pause/resume, view sync status and cycle history
OpenAPI spec -- auto-generated via utoipa, served at /openapi.json
API key auth middleware -- optional authentication on protected routes

Engine vs crate routes

oversync-api::router(...) serves the shared control-plane routes and its base OpenAPI document.

OversyncEngine::api_router() in the root oversync crate merges this base spec with engine-owned routes such as:

/pipes/dry-run
/pipes/{name}/resolve
/credentials
/config/versions

That merged router is the recommended surface for standalone and embedded API servers.

Endpoints

Method	Path	Description
GET	`/health`	Health check
GET/POST	`/pipes`	List / create pipes
GET/PUT/DELETE	`/pipes/{name}`	Get / update / delete pipe
GET/POST	`/pipe-presets`	List / create saved recipes
GET/PUT/DELETE	`/pipe-presets/{name}`	Get / update / delete saved recipe
GET/POST	`/sinks`	List / create sinks
GET/POST	`/config/export`, `/config/import`	Export / replace control-plane config
POST	`/sync/pause`	Pause sync
POST	`/sync/resume`	Resume sync
GET	`/sync/status`	Current sync status
GET	`/history`	Cycle history

There are no legacy /sources routes in the control plane anymore. Pipe CRUD is the only runtime onboarding surface.

Usage

use oversync_api::{router, ApiDoc};
use std::sync::Arc;

let state = Arc::new(api_state);
let app = router(state);
let listener = tokio::net::TcpListener::bind("0.0.0.0:4300").await?;
axum::serve(listener, app).await?;

License