vta-sdk 0.40.0

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

//! `acl/revoke/0.1` — remove a subject, or withdraw some of its scopes.

use serde::{Deserialize, Serialize};

use super::entry::AclEntry;
use serde_json::Value;

/// `acl/revoke/0.1` request.
///
/// Canonical revoke has two modes: **full removal** (omit `scopes`) and
/// **scope reduction** (list the scopes to withdraw; the entry survives with
/// the rest).
///
/// This maintainer implements full removal only. A request carrying `scopes`
/// is **refused**, not silently treated as a full removal — quietly removing
/// an entire entry when the caller asked to withdraw one scope would take away
/// far more authority than was requested, which is the wrong direction for an
/// operation to guess in.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[non_exhaustive]
pub struct DeleteAclBody {
    /// VID of the subject being revoked. Was `did` before the canonical fold.
    pub subject: String,
    /// Scopes to withdraw instead of removing the entry. Unsupported here.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub scopes: Option<Vec<String>>,
    /// Optional human-readable rationale, recorded with the revocation.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<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 DeleteAclBody {
    /// Build a [`DeleteAclBody`] 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.
    pub fn new(subject: String) -> Self {
        Self {
            subject,
            scopes: None,
            reason: None,
            ext: None,
        }
    }
}

/// `acl/revoke/0.1` response — the entry as it stood when revoked.
///
/// Returning it rather than a bare `{ deleted: true }` means the audit record
/// and the caller both retain what was actually withdrawn, which a boolean
/// cannot express.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct DeleteAclResultBody {
    pub entry: AclEntry,
}