mdcast-api 0.5.0

Shared data types and HTTP wire protocol for mdcast — serde-only, no engine dependencies
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

//! HTTP wire protocol: the request and response bodies `mdcast-server` and
//! `mdcast-client` exchange. Types only — no transport, no handler logic.
//!
//! The shape of the exchange:
//!
//! 1. The client posts a render request ([`RenderMarkdownRequest`] or
//!    [`RenderTemplateRequest`]) whose [`crate::AssetManifest`] names the
//!    assets the render needs, by digest — never inline bytes.
//! 2. If the server holds every digest, it renders and answers with the
//!    artifact bytes.
//! 3. If it does not, it answers `409 Conflict` with a
//!    [`MissingBlobsError`]; the client uploads those blobs and retries.
//!    [`BlobCheckRequest`]/[`BlobCheckResponse`] let a client skip a doomed
//!    render round-trip and ask up front.
//! 4. Any other failure answers with an [`ErrorResponse`].
//!
//! Separately, `GET /v1/capabilities` ([`CapabilitiesResponse`]) is an
//! unauthenticated, cacheable read of deployment shape — which targets and
//! template formats this instance can actually produce, and its upload size
//! ceiling — so a client can feature-gate its UI before attempting any of
//! the above.

pub mod blob;
pub mod capabilities;
pub mod error;
pub mod generated;
pub mod render;

pub use blob::{BlobCheckRequest, BlobCheckResponse, MissingBlob, MissingBlobsError};
pub use capabilities::CapabilitiesResponse;
pub use error::{ErrorCode, ErrorResponse};
pub use generated::{
    BoardOptions, BoardTheme, GeneratedAsset, GeneratedSpec, Generator, QrEcLevel,
};
pub use render::{RenderMarkdownRequest, RenderOptions, RenderTemplateRequest, TemplateFormat};