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