//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vta/services/update`. Version: `1.0`.
#![allow(deprecated)]
/// Why this specification version is deprecated (SPEC "Superseded and
/// Withdrawn Versions"), or `None` while it is current.
pub const DEPRECATION: Option<&str> = Some("superseded by vta/services/update/1.2");
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
/// Error types.
pub mod error {
/// Error from a `TryFrom` or `FromStr` implementation.
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
///Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Ext(pub ::std::collections::HashMap<ExtKey, ::serde_json::Value>);
impl ::std::ops::Deref for Ext {
type Target = ::std::collections::HashMap<ExtKey, ::serde_json::Value>;
fn deref(&self) -> &::std::collections::HashMap<ExtKey, ::serde_json::Value> {
&self.0
}
}
impl ::std::convert::From<Ext> for ::std::collections::HashMap<ExtKey, ::serde_json::Value> {
fn from(value: Ext) -> Self {
value.0
}
}
impl ::std::convert::From<::std::collections::HashMap<ExtKey, ::serde_json::Value>> for Ext {
fn from(value: ::std::collections::HashMap<ExtKey, ::serde_json::Value>) -> Self {
Self(value)
}
}
///`ExtKey`
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ExtKey(::std::string::String);
impl ::std::ops::Deref for ExtKey {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ExtKey> for ::std::string::String {
fn from(value: ExtKey) -> Self {
value.0
}
}
impl ::std::str::FromStr for ExtKey {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for ExtKey {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Request payload for vta/services/update. Replaces the settings on a transport that is already advertised. Refused when the transport is not currently enabled — that case is `enable`, and conflating the two would let a typo silently advertise a service the operator meant to change.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
#[deprecated(note = "superseded by vta/services/update/1.2")]
pub struct Payload {
pub config: PayloadConfig,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
pub service: ServiceKind,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///Kind-specific settings. Which member applies is decided by `service`, and the two must agree — a `rest` request carrying `mediatorDid` is malformed, not a request with an ignored field. `didcomm` and `tsp` take `mediatorDid`; `rest` and `webauthn` take `url`.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct PayloadConfig {
///`didcomm` only: skip the mediator handshake except for DID resolution. Absent means the handshake runs, which is the safe reading — this carries no schema-level default on purpose, because a default would materialise the field into a `rest` or `webauthn` config where it has no meaning. The handshake is what proves the mediator is reachable and willing, so forcing past it can advertise a mediator that cannot actually deliver.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub force: ::std::option::Option<bool>,
///`didcomm` only: trust-ping round-trip budget. Default 10.
#[serde(
rename = "handshakeTimeoutSecs",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub handshake_timeout_secs: ::std::option::Option<::std::num::NonZeroU64>,
///Mediator to route through. Applies to `didcomm` and `tsp`.
#[serde(
rename = "mediatorDid",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub mediator_did: ::std::option::Option<PayloadConfigMediatorDid>,
///Endpoint to advertise. Applies to `rest` and `webauthn`. MUST be `https://`, with no fragment and no userinfo — the agent refuses anything else, because this value ends up in a signed DID document that clients will fetch.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub url: ::std::option::Option<PayloadConfigUrl>,
}
impl ::std::default::Default for PayloadConfig {
fn default() -> Self {
Self {
force: Default::default(),
handshake_timeout_secs: Default::default(),
mediator_did: Default::default(),
url: Default::default(),
}
}
}
impl PayloadConfig {
pub fn builder() -> builder::PayloadConfig {
Default::default()
}
}
///Mediator to route through. Applies to `didcomm` and `tsp`.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadConfigMediatorDid(::std::string::String);
impl ::std::ops::Deref for PayloadConfigMediatorDid {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadConfigMediatorDid> for ::std::string::String {
fn from(value: PayloadConfigMediatorDid) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadConfigMediatorDid {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadConfigMediatorDid {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for PayloadConfigMediatorDid {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for PayloadConfigMediatorDid {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for PayloadConfigMediatorDid {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Endpoint to advertise. Applies to `rest` and `webauthn`. MUST be `https://`, with no fragment and no userinfo — the agent refuses anything else, because this value ends up in a signed DID document that clients will fetch.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadConfigUrl(::std::string::String);
impl ::std::ops::Deref for PayloadConfigUrl {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadConfigUrl> for ::std::string::String {
fn from(value: PayloadConfigUrl) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadConfigUrl {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadConfigUrl {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for PayloadConfigUrl {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for PayloadConfigUrl {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for PayloadConfigUrl {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Success response to vta/services/update. Type https://trusttasks.org/spec/vta/services/update/1.0#response.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
#[deprecated(note = "superseded by vta/services/update/1.2")]
pub struct Response {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
pub result: ServiceMutationResult,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.
///
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum ServiceKind {
#[serde(rename = "didcomm")]
Didcomm,
#[serde(rename = "rest")]
Rest,
#[serde(rename = "tsp")]
Tsp,
#[serde(rename = "webauthn")]
Webauthn,
}
impl ::std::fmt::Display for ServiceKind {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Didcomm => f.write_str("didcomm"),
Self::Rest => f.write_str("rest"),
Self::Tsp => f.write_str("tsp"),
Self::Webauthn => f.write_str("webauthn"),
}
}
}
impl ::std::str::FromStr for ServiceKind {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"didcomm" => Ok(Self::Didcomm),
"rest" => Ok(Self::Rest),
"tsp" => Ok(Self::Tsp),
"webauthn" => Ok(Self::Webauthn),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for ServiceKind {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for ServiceKind {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for ServiceKind {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct ServiceMutationResult {
///Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.
#[serde(
rename = "drainUntil",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub drain_until: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
///The mediator being drained, when `drainUntil` is present.
#[serde(
rename = "drainingMediator",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub draining_mediator: ::std::option::Option<::std::string::String>,
///RFC 3339 instant the change took effect — the same instant stamped on the new log entry.
#[serde(rename = "effectiveAt")]
pub effective_at: ::chrono::DateTime<::chrono::offset::Utc>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.
#[serde(rename = "logEntryVersionId")]
pub log_entry_version_id: ServiceMutationResultLogEntryVersionId,
///True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.
#[serde(default)]
pub serverless: bool,
///The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.
#[serde(
rename = "vtaDid",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub vta_did: ::std::option::Option<::std::string::String>,
}
impl ServiceMutationResult {
pub fn builder() -> builder::ServiceMutationResult {
Default::default()
}
}
///Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ServiceMutationResultLogEntryVersionId(::std::string::String);
impl ::std::ops::Deref for ServiceMutationResultLogEntryVersionId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ServiceMutationResultLogEntryVersionId> for ::std::string::String {
fn from(value: ServiceMutationResultLogEntryVersionId) -> Self {
value.0
}
}
impl ::std::str::FromStr for ServiceMutationResultLogEntryVersionId {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ServiceMutationResultLogEntryVersionId {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for ServiceMutationResultLogEntryVersionId {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for ServiceMutationResultLogEntryVersionId {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for ServiceMutationResultLogEntryVersionId {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
/// Types for composing complex structures.
pub mod builder {
#[derive(Clone, Debug)]
pub struct Payload {
config: ::std::result::Result<super::PayloadConfig, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
service: ::std::result::Result<super::ServiceKind, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
config: Err("no value supplied for config".to_string()),
ext: Ok(Default::default()),
service: Err("no value supplied for service".to_string()),
}
}
}
impl Payload {
pub fn config<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PayloadConfig>,
T::Error: ::std::fmt::Display,
{
self.config = value
.try_into()
.map_err(|e| format!("error converting supplied value for config: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn service<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ServiceKind>,
T::Error: ::std::fmt::Display,
{
self.service = value
.try_into()
.map_err(|e| format!("error converting supplied value for service: {e}"));
self
}
}
impl ::std::convert::TryFrom<Payload> for super::Payload {
type Error = super::error::ConversionError;
fn try_from(value: Payload) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
config: value.config?,
ext: value.ext?,
service: value.service?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
config: Ok(value.config),
ext: Ok(value.ext),
service: Ok(value.service),
}
}
}
#[derive(Clone, Debug)]
pub struct PayloadConfig {
force: ::std::result::Result<::std::option::Option<bool>, ::std::string::String>,
handshake_timeout_secs: ::std::result::Result<
::std::option::Option<::std::num::NonZeroU64>,
::std::string::String,
>,
mediator_did: ::std::result::Result<
::std::option::Option<super::PayloadConfigMediatorDid>,
::std::string::String,
>,
url: ::std::result::Result<
::std::option::Option<super::PayloadConfigUrl>,
::std::string::String,
>,
}
impl ::std::default::Default for PayloadConfig {
fn default() -> Self {
Self {
force: Ok(Default::default()),
handshake_timeout_secs: Ok(Default::default()),
mediator_did: Ok(Default::default()),
url: Ok(Default::default()),
}
}
}
impl PayloadConfig {
pub fn force<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<bool>>,
T::Error: ::std::fmt::Display,
{
self.force = value
.try_into()
.map_err(|e| format!("error converting supplied value for force: {e}"));
self
}
pub fn handshake_timeout_secs<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<::std::num::NonZeroU64>>,
T::Error: ::std::fmt::Display,
{
self.handshake_timeout_secs = value.try_into().map_err(|e| {
format!("error converting supplied value for handshake_timeout_secs: {e}")
});
self
}
pub fn mediator_did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PayloadConfigMediatorDid>>,
T::Error: ::std::fmt::Display,
{
self.mediator_did = value
.try_into()
.map_err(|e| format!("error converting supplied value for mediator_did: {e}"));
self
}
pub fn url<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PayloadConfigUrl>>,
T::Error: ::std::fmt::Display,
{
self.url = value
.try_into()
.map_err(|e| format!("error converting supplied value for url: {e}"));
self
}
}
impl ::std::convert::TryFrom<PayloadConfig> for super::PayloadConfig {
type Error = super::error::ConversionError;
fn try_from(
value: PayloadConfig,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
force: value.force?,
handshake_timeout_secs: value.handshake_timeout_secs?,
mediator_did: value.mediator_did?,
url: value.url?,
})
}
}
impl ::std::convert::From<super::PayloadConfig> for PayloadConfig {
fn from(value: super::PayloadConfig) -> Self {
Self {
force: Ok(value.force),
handshake_timeout_secs: Ok(value.handshake_timeout_secs),
mediator_did: Ok(value.mediator_did),
url: Ok(value.url),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
result: ::std::result::Result<super::ServiceMutationResult, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
result: Err("no value supplied for result".to_string()),
}
}
}
impl Response {
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn result<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ServiceMutationResult>,
T::Error: ::std::fmt::Display,
{
self.result = value
.try_into()
.map_err(|e| format!("error converting supplied value for result: {e}"));
self
}
}
impl ::std::convert::TryFrom<Response> for super::Response {
type Error = super::error::ConversionError;
fn try_from(value: Response) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
ext: value.ext?,
result: value.result?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
ext: Ok(value.ext),
result: Ok(value.result),
}
}
}
#[derive(Clone, Debug)]
pub struct ServiceMutationResult {
drain_until: ::std::result::Result<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
::std::string::String,
>,
draining_mediator: ::std::result::Result<
::std::option::Option<::std::string::String>,
::std::string::String,
>,
effective_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
log_entry_version_id: ::std::result::Result<
super::ServiceMutationResultLogEntryVersionId,
::std::string::String,
>,
serverless: ::std::result::Result<bool, ::std::string::String>,
vta_did: ::std::result::Result<
::std::option::Option<::std::string::String>,
::std::string::String,
>,
}
impl ::std::default::Default for ServiceMutationResult {
fn default() -> Self {
Self {
drain_until: Ok(Default::default()),
draining_mediator: Ok(Default::default()),
effective_at: Err("no value supplied for effective_at".to_string()),
ext: Ok(Default::default()),
log_entry_version_id: Err("no value supplied for log_entry_version_id".to_string()),
serverless: Ok(Default::default()),
vta_did: Ok(Default::default()),
}
}
}
impl ServiceMutationResult {
pub fn drain_until<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
>,
T::Error: ::std::fmt::Display,
{
self.drain_until = value
.try_into()
.map_err(|e| format!("error converting supplied value for drain_until: {e}"));
self
}
pub fn draining_mediator<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<::std::string::String>>,
T::Error: ::std::fmt::Display,
{
self.draining_mediator = value
.try_into()
.map_err(|e| format!("error converting supplied value for draining_mediator: {e}"));
self
}
pub fn effective_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.effective_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for effective_at: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn log_entry_version_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ServiceMutationResultLogEntryVersionId>,
T::Error: ::std::fmt::Display,
{
self.log_entry_version_id = value.try_into().map_err(|e| {
format!("error converting supplied value for log_entry_version_id: {e}")
});
self
}
pub fn serverless<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.serverless = value
.try_into()
.map_err(|e| format!("error converting supplied value for serverless: {e}"));
self
}
pub fn vta_did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<::std::string::String>>,
T::Error: ::std::fmt::Display,
{
self.vta_did = value
.try_into()
.map_err(|e| format!("error converting supplied value for vta_did: {e}"));
self
}
}
impl ::std::convert::TryFrom<ServiceMutationResult> for super::ServiceMutationResult {
type Error = super::error::ConversionError;
fn try_from(
value: ServiceMutationResult,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
drain_until: value.drain_until?,
draining_mediator: value.draining_mediator?,
effective_at: value.effective_at?,
ext: value.ext?,
log_entry_version_id: value.log_entry_version_id?,
serverless: value.serverless?,
vta_did: value.vta_did?,
})
}
}
impl ::std::convert::From<super::ServiceMutationResult> for ServiceMutationResult {
fn from(value: super::ServiceMutationResult) -> Self {
Self {
drain_until: Ok(value.drain_until),
draining_mediator: Ok(value.draining_mediator),
effective_at: Ok(value.effective_at),
ext: Ok(value.ext),
log_entry_version_id: Ok(value.log_entry_version_id),
serverless: Ok(value.serverless),
vta_did: Ok(value.vta_did),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/services/update/1.0";
const IS_PROOF_REQUIRED: bool = true;
const IS_ISSUED_AT_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\"$defs\":{\"Ext\":{\"additionalProperties\":true,\"description\":\"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"},\"title\":\"Ext\",\"type\":\"object\"},\"Response\":{\"$anchor\":\"response\",\"additionalProperties\":false,\"description\":\"Success response to vta/services/update. Type https://trusttasks.org/spec/vta/services/update/1.0#response.\",\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"result\":{\"$ref\":\"#/$defs/ServiceMutationResult\"}},\"required\":[\"result\"],\"title\":\"VTA Services — Update — response payload\",\"type\":\"object\"},\"ServiceKind\":{\"description\":\"Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.\",\"enum\":[\"didcomm\",\"rest\",\"tsp\",\"webauthn\"],\"title\":\"ServiceKind\",\"type\":\"string\"},\"ServiceMutationResult\":{\"additionalProperties\":false,\"description\":\"The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.\",\"properties\":{\"drainUntil\":{\"description\":\"Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.\",\"format\":\"date-time\",\"type\":\"string\"},\"drainingMediator\":{\"description\":\"The mediator being drained, when `drainUntil` is present.\",\"type\":\"string\"},\"effectiveAt\":{\"description\":\"RFC 3339 instant the change took effect — the same instant stamped on the new log entry.\",\"format\":\"date-time\",\"type\":\"string\"},\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"logEntryVersionId\":{\"description\":\"Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.\",\"minLength\":1,\"type\":\"string\"},\"serverless\":{\"default\":false,\"description\":\"True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.\",\"type\":\"boolean\"},\"vtaDid\":{\"description\":\"The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.\",\"type\":\"string\"}},\"required\":[\"logEntryVersionId\",\"effectiveAt\"],\"title\":\"ServiceMutationResult\",\"type\":\"object\"}},\"$id\":\"https://trusttasks.org/spec/vta/services/update/1.0\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"additionalProperties\":false,\"description\":\"Request payload for vta/services/update. Replaces the settings on a transport that is already advertised. Refused when the transport is not currently enabled — that case is `enable`, and conflating the two would let a typo silently advertise a service the operator meant to change.\",\"properties\":{\"config\":{\"additionalProperties\":false,\"description\":\"Kind-specific settings. Which member applies is decided by `service`, and the two must agree — a `rest` request carrying `mediatorDid` is malformed, not a request with an ignored field. `didcomm` and `tsp` take `mediatorDid`; `rest` and `webauthn` take `url`.\",\"properties\":{\"force\":{\"description\":\"`didcomm` only: skip the mediator handshake except for DID resolution. Absent means the handshake runs, which is the safe reading — this carries no schema-level default on purpose, because a default would materialise the field into a `rest` or `webauthn` config where it has no meaning. The handshake is what proves the mediator is reachable and willing, so forcing past it can advertise a mediator that cannot actually deliver.\",\"type\":\"boolean\"},\"handshakeTimeoutSecs\":{\"description\":\"`didcomm` only: trust-ping round-trip budget. Default 10.\",\"minimum\":1,\"type\":\"integer\"},\"mediatorDid\":{\"description\":\"Mediator to route through. Applies to `didcomm` and `tsp`.\",\"minLength\":1,\"type\":\"string\"},\"url\":{\"description\":\"Endpoint to advertise. Applies to `rest` and `webauthn`. MUST be `https://`, with no fragment and no userinfo — the agent refuses anything else, because this value ends up in a signed DID document that clients will fetch.\",\"minLength\":1,\"type\":\"string\"}},\"type\":\"object\"},\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"service\":{\"$ref\":\"#/$defs/ServiceKind\"}},\"required\":[\"service\",\"config\"],\"title\":\"VTA Services — Update — payload\",\"type\":\"object\"}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/services/update/1.0#response";
const IS_PROOF_REQUIRED: bool = true;
const IS_ISSUED_AT_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\"$defs\":{\"Ext\":{\"additionalProperties\":true,\"description\":\"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"},\"title\":\"Ext\",\"type\":\"object\"},\"Response\":{\"$anchor\":\"response\",\"additionalProperties\":false,\"description\":\"Success response to vta/services/update. Type https://trusttasks.org/spec/vta/services/update/1.0#response.\",\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"result\":{\"$ref\":\"#/$defs/ServiceMutationResult\"}},\"required\":[\"result\"],\"title\":\"VTA Services — Update — response payload\",\"type\":\"object\"},\"ServiceKind\":{\"description\":\"Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.\",\"enum\":[\"didcomm\",\"rest\",\"tsp\",\"webauthn\"],\"title\":\"ServiceKind\",\"type\":\"string\"},\"ServiceMutationResult\":{\"additionalProperties\":false,\"description\":\"The outcome of a change to an advertised service. Every member describes the **log entry the change produced**, because that is what the change actually is: the agent's DID document is the record, and a consumer that treats the response as a mere acknowledgement will miss that a redeploy may be required.\",\"properties\":{\"drainUntil\":{\"description\":\"Present when the change scheduled a DIDComm drain. Its absence means no drain was scheduled, NOT that a drain finished instantly: a consumer reporting 'done' on an absent value would be right, and one reporting it on a present value would be wrong.\",\"format\":\"date-time\",\"type\":\"string\"},\"drainingMediator\":{\"description\":\"The mediator being drained, when `drainUntil` is present.\",\"type\":\"string\"},\"effectiveAt\":{\"description\":\"RFC 3339 instant the change took effect — the same instant stamped on the new log entry.\",\"format\":\"date-time\",\"type\":\"string\"},\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"logEntryVersionId\":{\"description\":\"Version id of the new did:webvh log entry this change wrote. Joins the change to the document's history.\",\"minLength\":1,\"type\":\"string\"},\"serverless\":{\"default\":false,\"description\":\"True when the agent's DID is self-hosted. **The change is persisted locally but NOT published**: the operator must fetch the updated `did.jsonl` and redeploy before any verifier sees it. A consumer that ignores this reports success for a change no one else can observe yet.\",\"type\":\"boolean\"},\"vtaDid\":{\"description\":\"The agent's own DID — subject of the log entry this change wrote. Carried so a caller can follow up without a second round trip.\",\"type\":\"string\"}},\"required\":[\"logEntryVersionId\",\"effectiveAt\"],\"title\":\"ServiceMutationResult\",\"type\":\"object\"}},\"$ref\":\"#/$defs/Response\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\"}\n",
);
}
impl crate::RequestPayload for Payload {
type Response = Response;
}
/// The earlier `MAJOR.MINOR` of this slug that this version declares it
/// extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
/// `None`. Only the direct declaration; walk a chain with
/// [`crate::extension::extends_for`].
pub const EXTENDS: Option<&str> = None;
/// The extended error codes this specification declares (SPEC §7.3 item 9,
/// §8.5), in declaration order. Empty when it declares none.
pub const ERROR_CODES: &[crate::DeclaredErrorCode] = &[
error_codes::NOT_FOUND,
error_codes::VALIDATION_FAILED,
error_codes::NOT_AUTHORIZED,
];
/// One constant per extended error code this specification declares
/// (SPEC §7.3 item 9), named for its local part.
///
/// Emit these rather than a string literal: the code is read from the
/// specification, so it cannot name a code the specification never
/// declared.
pub mod error_codes {
/// `vta/services/update:notFound`
///
/// The transport is not currently advertised, so there is nothing to update. Use enable.
///
/// Declared `retryable: false`.
pub const NOT_FOUND: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vta/services/update:notFound",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `vta/services/update:validationFailed`
///
/// The config is not valid for the named service — wrong member, or a URL that is not https:// with no fragment and no userinfo.
///
/// Declared `retryable: false`.
pub const VALIDATION_FAILED: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vta/services/update:validationFailed",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `vta/services/update:notAuthorized`
///
/// The caller is not a super-admin.
///
/// Declared `retryable: false`.
pub const NOT_AUTHORIZED: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vta/services/update:notAuthorized",
retryable: false,
details_schema: ::core::option::Option::None,
};
}