vta-sdk 0.49.0

SDK for Verifiable Trust Agents operating in Verifiable Trust Communities
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

//! `config/show/0.1` — read the VTA's runtime configuration.
//!
//! Folded onto the canonical `config/*` family (#840 phase A). The VTA
//! previously exposed three named, typed fields (`vta_did`, `vta_name`,
//! `public_url`); canonical `config/show` returns a **registry** of keys, each
//! carrying where its effective value came from and whether a restart is
//! needed for a change to take effect. Same information, one shape shared with
//! every other agent.

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// `config/show/0.1` request. `keys` narrows the result; omitted returns every
/// registered key.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[non_exhaustive]
pub struct GetConfigBody {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub keys: Option<Vec<String>>,
    /// Ecosystem-defined extension members (SPEC §4.5.1).
    ///
    /// Carried explicitly rather than swept up by relaxing
    /// `deny_unknown_fields`: the published payload schemas declare an `ext`
    /// slot, so a conforming producer may send one, and rejecting the whole
    /// document over it would break interop with a peer doing exactly what the
    /// spec allows. Keeping `deny_unknown_fields` alongside it means a *typo*
    /// is still refused rather than silently ignored — which is the guard that
    /// clause was there for.
    ///
    /// The VTA does not interpret the contents.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ext: Option<Value>,
}

impl GetConfigBody {
    /// Build a [`GetConfigBody`] from the members the schema requires.
    ///
    /// This type is `#[non_exhaustive]`, so it cannot be built with a struct
    /// literal from outside this crate — a new member added by a later revision
    /// of the schema would break every such literal, which is exactly what
    /// happened when `ext` arrived. The optional members stay public: set them
    /// on the value this returns.
    ///
    /// Every member is optional, so this takes no arguments; set the ones
    /// you want on the returned value.
    pub fn new() -> Self {
        Self {
            keys: None,
            ext: None,
        }
    }
}

/// One configuration key as the operator currently sees it — canonical
/// `config/_shared/0.1/config#ConfigField`.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct ConfigField {
    /// The configuration key, e.g. `vta_name`.
    pub key: String,
    /// The effective value. `null` when the key is unset.
    #[cfg_attr(feature = "openapi", schema(value_type = Object))]
    pub value: serde_json::Value,
    /// Which layer supplied the effective value — `setup`, `toml`, `default`.
    pub source: String,
    /// True when a change to this key takes effect only after a restart.
    pub requires_restart: bool,
}

/// `config/show/0.1` response.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct GetConfigResultBody {
    pub fields: Vec<ConfigField>,
}

impl GetConfigResultBody {
    /// Value of `key`, if the registry carries it and it is set.
    ///
    /// Convenience for callers that want one key out of the registry — most
    /// commonly `vta_did`, which is read far more often than the rest and used
    /// to have a named field of its own.
    pub fn get(&self, key: &str) -> Option<&serde_json::Value> {
        self.fields
            .iter()
            .find(|f| f.key == key)
            .map(|f| &f.value)
            .filter(|v| !v.is_null())
    }

    /// `vta_did` as a string, if set. The VTA's own identity is read-only —
    /// see `update_config` for why it cannot be patched.
    pub fn vta_did(&self) -> Option<&str> {
        self.get("vta_did").and_then(|v| v.as_str())
    }
}