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 fleet_admission_projection;
19pub mod ic;
20pub mod icp_refill;
21pub mod intent;
22pub mod lifecycle;
23pub mod memory;
24pub mod metadata;
25pub mod observability;
26pub mod placement;
27pub mod ready;
28pub mod role;
29pub mod rpc;
30pub mod runtime;
31pub mod state;
32pub mod timer;
33pub mod topology;
34
35///
36/// Read-only query re-exports
37///
38/// Only queries that satisfy ALL of the following may be re-exported directly:
39///
40/// - Read-only
41/// - No orchestration or side effects
42/// - No policy or invariant enforcement
43/// - No internal `InternalError` in public signatures
44/// - Return DTOs or primitives only
45///
46/// Queries that can fail with internal errors or enforce invariants
47/// MUST be wrapped in an API façade instead.
48///
49
50pub mod cycles {
51    pub use crate::workflow::runtime::cycles::query::CycleTrackerQuery;
52}
53pub mod env {
54    pub use crate::workflow::env::query::EnvQuery;
55}
56pub mod icrc {
57    pub use crate::workflow::icrc::query::{Icrc10Query, Icrc21Query};
58}
59pub mod log {
60    pub use crate::workflow::log::query::LogQuery;
61}
62pub mod metrics {
63    pub use crate::workflow::metrics::query::MetricsQuery;
64}