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