made_api/lib.rs
1//! The published contract of the embedded MADE.
2//!
3//! This crate is what a consuming product is allowed to know. It holds plain
4//! views, a capability report, an error vocabulary and one trait — and no
5//! domain types, no adapters, no storage. A consumer that compiles against this
6//! crate alone can be tested with a stub and swapped onto any implementation
7//! that honours the same contract.
8//!
9//! Versioned deliberately. [`CONTRACT_VERSION`] moves when the meaning of this
10//! surface changes, independently of the library's own release number: two
11//! builds of the same release can differ in features, and a consumer that
12//! guessed capabilities from a version string would find out mid-run. Consumers
13//! check [`ApiCapabilities`] at startup instead.
14//!
15//! Vocabulary note (ADR-001): these types speak the engine's own language —
16//! ceremonies. A consuming product maps them to its own terms at its own
17//! boundary; nothing of that product's vocabulary appears here.
18
19mod api_capabilities;
20mod api_error;
21mod authoring_views;
22mod ceremony_engine_api;
23mod ceremony_summary;
24mod intervention_views;
25mod start_ceremony_request;
26
27pub use api_capabilities::ApiCapabilities;
28pub use api_error::ApiError;
29pub use authoring_views::{DefinitionAnalysisView, DefinitionDefectView, PublishedDefinitionView};
30pub use ceremony_engine_api::CeremonyEngineApi;
31pub use ceremony_summary::{CeremonyParticipant, CeremonySummary};
32pub use intervention_views::{
33 InterventionResponseView, InterventionView, RaiseInterventionRequest,
34 RespondToInterventionRequest,
35};
36pub use start_ceremony_request::StartCeremonyRequest;
37
38/// The revision of this contract.
39///
40/// Moves on meaning, not on release: adding a capability keeps the version,
41/// changing what an existing field or method means raises it.
42pub const CONTRACT_VERSION: u32 = 3;