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

//! Signal contracts: trust-tagged events that enter the act lifecycle.
use serde::{Deserialize, Serialize};

use crate::schema::{IsoDateTime, NonEmptyString, RunxSchema};
use crate::{Fingerprint, JsonObject, Links, Reference};

pub const SIGNAL_SCHEMA: &str = "runx.signal.v1";

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

/// Canonical signal type identifiers. The wire form is an open
/// `NonEmptyString` so adapters that observe a new event category can publish
/// their own identifier without a contract edit.
pub mod signal_type {
    pub const ISSUE_OPENED: &str = "issue_opened";
    pub const ISSUE_COMMENT: &str = "issue_comment";
    pub const PULL_REQUEST_EVENT: &str = "pull_request_event";
    pub const REVIEW_EVENT: &str = "review_event";
    pub const CHAT_MESSAGE: &str = "chat_message";
    pub const ALERT: &str = "alert";
    pub const DEPLOYMENT_EVENT: &str = "deployment_event";
    pub const EFFECT_REQUIRED: &str = "effect_required";
    pub const SCHEDULE_TICK: &str = "schedule_tick";
    pub const OPERATOR_NOTE: &str = "operator_note";
    pub const SYSTEM_EVENT: &str = "system_event";
    /// Customer-facing support ticket from a help desk or inbox.
    pub const SUPPORT_TICKET: &str = "support_ticket";
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(rename_all = "snake_case")]
pub enum SignalTrustLevel {
    Unverified,
    Observed,
    VerifiedDelivery,
    VerifiedSignature,
    OperatorAttested,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
pub struct SignalAuthenticity {
    pub host_ref: Reference,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub principal_ref: Option<Reference>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub verified_by_ref: Option<Reference>,
    pub trust_level: SignalTrustLevel,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub verified_at: Option<IsoDateTime>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub signature_refs: Vec<Reference>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub evidence_refs: Vec<Reference>,
}

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, RunxSchema)]
#[serde(deny_unknown_fields)]
#[runx_schema(id = "runx.signal.v1")]
pub struct Signal {
    pub schema: SignalSchema,
    pub signal_id: NonEmptyString,
    pub source_ref: Reference,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub authenticity: Option<SignalAuthenticity>,
    /// Open signal type identifier (e.g. `signal_type::ISSUE_OPENED`). Adapters
    /// can publish their own identifier without a contract edit.
    pub signal_type: NonEmptyString,
    pub title: NonEmptyString,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub body_preview: Option<NonEmptyString>,
    pub observed_at: IsoDateTime,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub evidence_refs: Vec<Reference>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fingerprint: Option<Fingerprint>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub links: Option<Links>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<JsonObject>,
}