Skip to main content

canic_core/api/
mod.rs

1//! Module: api
2//!
3//! Responsibility: public API facades for macro-generated canister endpoints.
4//! Does not own: orchestration, business logic, policy, or storage invariants.
5//! Boundary: maps endpoint calls into workflow calls and public errors.
6
7pub mod auth;
8pub mod authority_restore;
9#[cfg(feature = "blob-storage")]
10pub mod blob_storage;
11pub mod call;
12pub mod cascade;
13pub mod component_deployment;
14pub mod component_runtime;
15pub mod config;
16pub mod error;
17pub mod fleet_activation;
18pub mod ic;
19pub mod icp_refill;
20pub mod intent;
21pub mod lifecycle;
22pub mod memory;
23pub mod metadata;
24pub mod placement;
25pub mod ready;
26pub mod role;
27pub mod rpc;
28pub mod runtime;
29pub mod state;
30pub mod timer;
31pub mod topology;
32
33///
34/// Read-only query re-exports
35///
36/// Only queries that satisfy ALL of the following may be re-exported directly:
37///
38/// - Read-only
39/// - No orchestration or side effects
40/// - No policy or invariant enforcement
41/// - No internal `InternalError` in public signatures
42/// - Return DTOs or primitives only
43///
44/// Queries that can fail with internal errors or enforce invariants
45/// MUST be wrapped in an API façade instead.
46///
47
48pub mod cycles {
49    pub use crate::workflow::runtime::cycles::query::CycleTrackerQuery;
50}
51pub mod env {
52    pub use crate::workflow::env::query::EnvQuery;
53}
54pub mod icrc {
55    pub use crate::workflow::icrc::query::{Icrc10Query, Icrc21Query};
56}
57pub mod log {
58    pub use crate::workflow::log::query::LogQuery;
59}
60pub mod metrics {
61    pub use crate::workflow::metrics::query::MetricsQuery;
62}