wist-api 0.5.1

Cross-process API seam messages for the wist control plane (edge <-> gateway <-> center).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

//! `gateway` 面 agent seam 报文（action-plan / action-results / facts / discovery-policies）。
//!
//! 报文引用的**领域类型**（`ActionPlan` / `ActionResult` / `FinalStatus` /
//! `DiscoveryAspectPolicy(Set)`）仍留在 `wist-contracts`；这里 re-export，调用方从
//! `wist_api::gateway` 一处取齐。版本并存约定同 [`crate::enrollment`]
//! （见 `wist-design/doc/design/foundation/api-seam-inventory.md` §7）。

pub use wist_contracts::action_plan::ActionPlan;
pub use wist_contracts::action_result::{ActionResult, FinalStatus};
pub use wist_contracts::discovery_policy::{DiscoveryAspectPolicy, DiscoveryAspectPolicySet};

pub mod v1;
pub use v1::*;

/// 当前线上版本。新代码从这里取版本口径；并存期由路由/协商决定。
pub const CURRENT: &str = v1::API_VERSION;

#[cfg(test)]
mod tests {
    use super::*;

    /// `CURRENT` 必须钉在 `v1`（与路由 `/api/v1/…` 一致），并与版本子模块同源。
    #[test]
    fn current_matches_the_live_wire_version() {
        assert_eq!(CURRENT, "v1");
        assert_eq!(CURRENT, v1::API_VERSION);
    }

    /// 编译期身份断言：本模块 re-export 的领域类型**就是** `wist-contracts` 的那几个
    /// （若有人另抄一份，下面的函数体将类型不匹配而编译失败）。
    #[test]
    fn domain_types_are_the_contracts_ones() {
        #[allow(dead_code)]
        fn assert_identity() {
            fn plan(v: wist_contracts::action_plan::ActionPlan) -> ActionPlan {
                v
            }
            fn result(v: wist_contracts::action_result::ActionResult) -> ActionResult {
                v
            }
            fn final_status(v: wist_contracts::action_result::FinalStatus) -> FinalStatus {
                v
            }
            fn policy(
                v: wist_contracts::discovery_policy::DiscoveryAspectPolicy,
            ) -> DiscoveryAspectPolicy {
                v
            }
            fn policy_set(
                v: wist_contracts::discovery_policy::DiscoveryAspectPolicySet,
            ) -> DiscoveryAspectPolicySet {
                v
            }
            let _ = (plan, result, final_status, policy, policy_set);
        }
        assert_identity();
    }

    /// `AgentStatusAck` 归属 `agent/status` seam：本模块只是 **re-export**，
    /// 不是第二份定义（同 crate 里两份同名报文 = 漂移源）。
    #[test]
    fn agent_status_ack_is_the_agent_status_seam_one() {
        #[allow(dead_code)]
        fn assert_identity() {
            fn ack(v: crate::agent_status::AgentStatusAck) -> AgentStatusAck {
                v
            }
            let _ = ack;
        }
        assert_identity();
    }
}