runx-contracts 0.6.19

Shared Rust contract types for runx JSON and host protocol boundaries.
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! Act algebra: intents, governed acts, success criteria, and verification details.
pub mod assignment;
pub mod result;

use serde::{Deserialize, Serialize};

use crate::schema::{IsoDateTime, NonEmptyString, RunxSchema};
use crate::{ActRef, Closure, Reference, Verification};

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
pub enum ActSchema {
    #[serde(rename = "runx.act.v1")]
    V1,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct SuccessCriterion {
    pub criterion_id: NonEmptyString,
    pub statement: NonEmptyString,
    pub required: bool,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct Intent {
    pub purpose: NonEmptyString,
    pub legitimacy: NonEmptyString,
    #[serde(default)]
    pub success_criteria: Vec<SuccessCriterion>,
    #[serde(default)]
    pub constraints: Vec<NonEmptyString>,
    #[serde(default)]
    pub derived_from: Vec<Reference>,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(rename_all = "snake_case")]
pub enum CriterionStatus {
    Verified,
    Failed,
    Pending,
    NotApplicable,
    Unknown,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(rename_all = "snake_case")]
pub enum ActForm {
    Revision,
    Reply,
    Review,
    Observation,
    Verification,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct CriterionBinding {
    pub criterion_id: NonEmptyString,
    pub status: CriterionStatus,
    #[serde(default)]
    pub evidence_refs: Vec<Reference>,
    #[serde(default)]
    pub verification_refs: Vec<Reference>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub summary: Option<NonEmptyString>,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct TargetSurface {
    pub surface_ref: Reference,
    pub mutating: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rationale: Option<NonEmptyString>,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct ChangeRequest {
    pub request_id: NonEmptyString,
    pub summary: NonEmptyString,
    #[serde(default)]
    pub target_surfaces: Vec<TargetSurface>,
    #[serde(default)]
    pub success_criteria: Vec<SuccessCriterion>,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct ChangePlan {
    pub plan_id: NonEmptyString,
    pub summary: NonEmptyString,
    #[serde(default)]
    pub steps: Vec<NonEmptyString>,
    #[serde(default)]
    pub risks: Vec<NonEmptyString>,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct RevisionDetails {
    pub change_request: ChangeRequest,
    pub change_plan: ChangePlan,
    #[serde(default)]
    pub target_surfaces: Vec<TargetSurface>,
    #[serde(default)]
    pub invariants: Vec<NonEmptyString>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub verification: Option<Verification>,
    #[serde(default)]
    pub handoff_refs: Vec<Reference>,
    #[serde(default)]
    pub revision_refs: Vec<Reference>,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct VerificationDetails {
    pub criterion_ids: Vec<NonEmptyString>,
    pub verification: Verification,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deployment_ref: Option<Reference>,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
#[runx_schema(id = "runx.act.v1")]
pub struct Act {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub schema: Option<ActSchema>,
    pub act_id: NonEmptyString,
    pub form: ActForm,
    pub intent: Intent,
    pub summary: NonEmptyString,
    pub closure: Closure,
    #[serde(default)]
    pub criterion_bindings: Vec<CriterionBinding>,
    #[serde(default)]
    pub source_refs: Vec<Reference>,
    #[serde(default)]
    pub target_refs: Vec<Reference>,
    #[serde(default)]
    pub surface_refs: Vec<Reference>,
    #[serde(default)]
    pub artifact_refs: Vec<Reference>,
    #[serde(default)]
    pub verification_refs: Vec<Reference>,
    #[serde(default)]
    pub harness_refs: Vec<Reference>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub revision: Option<RevisionDetails>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub verification: Option<VerificationDetails>,
    pub performed_at: IsoDateTime,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct GovernedActRef {
    pub act_ref: ActRef,
}