//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vta/restore/status`. Version: `0.1`.
#[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())
}
}
}
///The kind of deployment an agent's state lives in, as a backup restore classifies it: plain (an unencrypted store), hardened (the store encrypted under a key derived from the agent's seed), or tee (seed and signing keys sealed to an attested trusted execution environment).
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "DeploymentEnvironment",
/// "description": "The kind of deployment an agent's state lives in, as a backup restore classifies it: plain (an unencrypted store), hardened (the store encrypted under a key derived from the agent's seed), or tee (seed and signing keys sealed to an attested trusted execution environment).",
/// "type": "string",
/// "enum": [
/// "plain",
/// "hardened",
/// "tee"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum DeploymentEnvironment {
#[serde(rename = "plain")]
Plain,
#[serde(rename = "hardened")]
Hardened,
#[serde(rename = "tee")]
Tee,
}
impl ::std::fmt::Display for DeploymentEnvironment {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Plain => f.write_str("plain"),
Self::Hardened => f.write_str("hardened"),
Self::Tee => f.write_str("tee"),
}
}
}
impl ::std::str::FromStr for DeploymentEnvironment {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"plain" => Ok(Self::Plain),
"hardened" => Ok(Self::Hardened),
"tee" => Ok(Self::Tee),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for DeploymentEnvironment {
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 DeploymentEnvironment {
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 DeploymentEnvironment {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///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.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Ext",
/// "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.",
/// "type": "object",
/// "minProperties": 1,
/// "additionalProperties": true,
/// "propertyNames": {
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
/// }
///}
/// ```
/// </details>
#[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`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
///}
/// ```
/// </details>
#[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())
})
}
}
///An administrator asks a Verifiable Trust Agent whether its current state derives from a backup restore, and which software version it runs. The payload carries nothing. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/vta/restore/status/0.1",
/// "title": "Payload",
/// "description": "An administrator asks a Verifiable Trust Agent whether its current state derives from a backup restore, and which software version it runs. The payload carries nothing. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
/// "type": "object",
/// "properties": {
/// "ext": {
/// "description": "Ecosystem-defined extension members per SPEC.md §4.5.1.",
/// "$ref": "#/definitions/Ext"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
///Ecosystem-defined extension members per SPEC.md §4.5.1.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Default::default(),
}
}
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/restore/status/0.1#response. Failures use trust-task-error, not this shape.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/restore/status/0.1#response. Failures use trust-task-error, not this shape.",
/// "type": "object",
/// "required": [
/// "restored",
/// "version"
/// ],
/// "properties": {
/// "ext": {
/// "description": "Ecosystem-defined extension members per SPEC.md §4.5.1.",
/// "$ref": "#/definitions/Ext"
/// },
/// "restore": {
/// "description": "The restore the agent's current state derives from. Present exactly when `restored` is true.",
/// "$ref": "#/definitions/RestoreRecord"
/// },
/// "restored": {
/// "description": "Whether the agent's current state derives from a backup restore. Always present, so 'not restored' is stated rather than inferred from an absent member. True exactly when `restore` is present.",
/// "type": "boolean"
/// },
/// "version": {
/// "description": "The agent's software version, as its build reports it.",
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 1
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
///Ecosystem-defined extension members per SPEC.md §4.5.1.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///The restore the agent's current state derives from. Present exactly when `restored` is true.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub restore: ::std::option::Option<RestoreRecord>,
///Whether the agent's current state derives from a backup restore. Always present, so 'not restored' is stated rather than inferred from an absent member. True exactly when `restore` is present.
pub restored: bool,
///The agent's software version, as its build reports it.
pub version: ResponseVersion,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///The agent's software version, as its build reports it.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The agent's software version, as its build reports it.",
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseVersion(::std::string::String);
impl ::std::ops::Deref for ResponseVersion {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseVersion> for ::std::string::String {
fn from(value: ResponseVersion) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseVersion {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 64usize {
return Err("longer than 64 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResponseVersion {
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 ResponseVersion {
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 ResponseVersion {
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 ResponseVersion {
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())
})
}
}
///The backup restore the agent's current state derives from (VTI-VTA-051). `sourceEnvironment` is the kind of deployment the backup was taken from, present when the backup records it; `targetEnvironment` is the kind the restore was applied to — this agent's.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "RestoreRecord",
/// "description": "The backup restore the agent's current state derives from (VTI-VTA-051). `sourceEnvironment` is the kind of deployment the backup was taken from, present when the backup records it; `targetEnvironment` is the kind the restore was applied to — this agent's.",
/// "type": "object",
/// "required": [
/// "appliedAt",
/// "stagedAt",
/// "stagedBy",
/// "targetEnvironment"
/// ],
/// "properties": {
/// "appliedAt": {
/// "description": "When the restored state was applied — the boot at which it replaced the agent's previous state.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "hostedDidsDetached": {
/// "description": "DIDs whose hosting registrations the restore detached because it replaced a different identity; each must be registered with its host again. Absent when none were.",
/// "type": "array",
/// "items": {
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
/// },
/// "maxItems": 10000
/// },
/// "internalKeysLost": {
/// "description": "Identifiers of keys whose records came back without their material: keys the agent generated internally and never exports, so no backup carries them. Absent when none were lost.",
/// "type": "array",
/// "items": {
/// "type": "string",
/// "maxLength": 256,
/// "minLength": 1
/// },
/// "maxItems": 10000
/// },
/// "sourceDid": {
/// "description": "The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
/// },
/// "sourceEnvironment": {
/// "$ref": "#/definitions/DeploymentEnvironment"
/// },
/// "stagedAt": {
/// "description": "When the restore was committed and staged for the next boot.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "stagedBy": {
/// "description": "The DID of the administrator who committed the restore.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
/// },
/// "targetEnvironment": {
/// "$ref": "#/definitions/DeploymentEnvironment"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct RestoreRecord {
///When the restored state was applied — the boot at which it replaced the agent's previous state.
#[serde(rename = "appliedAt")]
pub applied_at: ::chrono::DateTime<::chrono::offset::Utc>,
///DIDs whose hosting registrations the restore detached because it replaced a different identity; each must be registered with its host again. Absent when none were.
#[serde(
rename = "hostedDidsDetached",
default,
skip_serializing_if = "::std::vec::Vec::is_empty"
)]
pub hosted_dids_detached: ::std::vec::Vec<RestoreRecordHostedDidsDetachedItem>,
///Identifiers of keys whose records came back without their material: keys the agent generated internally and never exports, so no backup carries them. Absent when none were lost.
#[serde(
rename = "internalKeysLost",
default,
skip_serializing_if = "::std::vec::Vec::is_empty"
)]
pub internal_keys_lost: ::std::vec::Vec<RestoreRecordInternalKeysLostItem>,
///The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity.
#[serde(
rename = "sourceDid",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub source_did: ::std::option::Option<RestoreRecordSourceDid>,
#[serde(
rename = "sourceEnvironment",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub source_environment: ::std::option::Option<DeploymentEnvironment>,
///When the restore was committed and staged for the next boot.
#[serde(rename = "stagedAt")]
pub staged_at: ::chrono::DateTime<::chrono::offset::Utc>,
///The DID of the administrator who committed the restore.
#[serde(rename = "stagedBy")]
pub staged_by: RestoreRecordStagedBy,
#[serde(rename = "targetEnvironment")]
pub target_environment: DeploymentEnvironment,
}
impl RestoreRecord {
pub fn builder() -> builder::RestoreRecord {
Default::default()
}
}
///`RestoreRecordHostedDidsDetachedItem`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct RestoreRecordHostedDidsDetachedItem(::std::string::String);
impl ::std::ops::Deref for RestoreRecordHostedDidsDetachedItem {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<RestoreRecordHostedDidsDetachedItem> for ::std::string::String {
fn from(value: RestoreRecordHostedDidsDetachedItem) -> Self {
value.0
}
}
impl ::std::str::FromStr for RestoreRecordHostedDidsDetachedItem {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 2048usize {
return Err("longer than 2048 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^did:").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for RestoreRecordHostedDidsDetachedItem {
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 RestoreRecordHostedDidsDetachedItem {
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 RestoreRecordHostedDidsDetachedItem {
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 RestoreRecordHostedDidsDetachedItem {
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())
})
}
}
///`RestoreRecordInternalKeysLostItem`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "maxLength": 256,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct RestoreRecordInternalKeysLostItem(::std::string::String);
impl ::std::ops::Deref for RestoreRecordInternalKeysLostItem {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<RestoreRecordInternalKeysLostItem> for ::std::string::String {
fn from(value: RestoreRecordInternalKeysLostItem) -> Self {
value.0
}
}
impl ::std::str::FromStr for RestoreRecordInternalKeysLostItem {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 256usize {
return Err("longer than 256 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for RestoreRecordInternalKeysLostItem {
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 RestoreRecordInternalKeysLostItem {
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 RestoreRecordInternalKeysLostItem {
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 RestoreRecordInternalKeysLostItem {
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())
})
}
}
///The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct RestoreRecordSourceDid(::std::string::String);
impl ::std::ops::Deref for RestoreRecordSourceDid {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<RestoreRecordSourceDid> for ::std::string::String {
fn from(value: RestoreRecordSourceDid) -> Self {
value.0
}
}
impl ::std::str::FromStr for RestoreRecordSourceDid {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 2048usize {
return Err("longer than 2048 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^did:").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for RestoreRecordSourceDid {
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 RestoreRecordSourceDid {
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 RestoreRecordSourceDid {
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 RestoreRecordSourceDid {
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())
})
}
}
///The DID of the administrator who committed the restore.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The DID of the administrator who committed the restore.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct RestoreRecordStagedBy(::std::string::String);
impl ::std::ops::Deref for RestoreRecordStagedBy {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<RestoreRecordStagedBy> for ::std::string::String {
fn from(value: RestoreRecordStagedBy) -> Self {
value.0
}
}
impl ::std::str::FromStr for RestoreRecordStagedBy {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 2048usize {
return Err("longer than 2048 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^did:").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for RestoreRecordStagedBy {
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 RestoreRecordStagedBy {
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 RestoreRecordStagedBy {
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 RestoreRecordStagedBy {
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 {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
}
}
}
impl Payload {
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
}
}
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 { ext: value.ext? })
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self { ext: Ok(value.ext) }
}
}
#[derive(Clone, Debug)]
pub struct Response {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
restore: ::std::result::Result<
::std::option::Option<super::RestoreRecord>,
::std::string::String,
>,
restored: ::std::result::Result<bool, ::std::string::String>,
version: ::std::result::Result<super::ResponseVersion, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
restore: Ok(Default::default()),
restored: Err("no value supplied for restored".to_string()),
version: Err("no value supplied for version".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 restore<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::RestoreRecord>>,
T::Error: ::std::fmt::Display,
{
self.restore = value
.try_into()
.map_err(|e| format!("error converting supplied value for restore: {e}"));
self
}
pub fn restored<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.restored = value
.try_into()
.map_err(|e| format!("error converting supplied value for restored: {e}"));
self
}
pub fn version<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResponseVersion>,
T::Error: ::std::fmt::Display,
{
self.version = value
.try_into()
.map_err(|e| format!("error converting supplied value for version: {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?,
restore: value.restore?,
restored: value.restored?,
version: value.version?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
ext: Ok(value.ext),
restore: Ok(value.restore),
restored: Ok(value.restored),
version: Ok(value.version),
}
}
}
#[derive(Clone, Debug)]
pub struct RestoreRecord {
applied_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
hosted_dids_detached: ::std::result::Result<
::std::vec::Vec<super::RestoreRecordHostedDidsDetachedItem>,
::std::string::String,
>,
internal_keys_lost: ::std::result::Result<
::std::vec::Vec<super::RestoreRecordInternalKeysLostItem>,
::std::string::String,
>,
source_did: ::std::result::Result<
::std::option::Option<super::RestoreRecordSourceDid>,
::std::string::String,
>,
source_environment: ::std::result::Result<
::std::option::Option<super::DeploymentEnvironment>,
::std::string::String,
>,
staged_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
staged_by: ::std::result::Result<super::RestoreRecordStagedBy, ::std::string::String>,
target_environment:
::std::result::Result<super::DeploymentEnvironment, ::std::string::String>,
}
impl ::std::default::Default for RestoreRecord {
fn default() -> Self {
Self {
applied_at: Err("no value supplied for applied_at".to_string()),
hosted_dids_detached: Ok(Default::default()),
internal_keys_lost: Ok(Default::default()),
source_did: Ok(Default::default()),
source_environment: Ok(Default::default()),
staged_at: Err("no value supplied for staged_at".to_string()),
staged_by: Err("no value supplied for staged_by".to_string()),
target_environment: Err("no value supplied for target_environment".to_string()),
}
}
}
impl RestoreRecord {
pub fn applied_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.applied_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for applied_at: {e}"));
self
}
pub fn hosted_dids_detached<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::RestoreRecordHostedDidsDetachedItem>>,
T::Error: ::std::fmt::Display,
{
self.hosted_dids_detached = value.try_into().map_err(|e| {
format!("error converting supplied value for hosted_dids_detached: {e}")
});
self
}
pub fn internal_keys_lost<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::RestoreRecordInternalKeysLostItem>>,
T::Error: ::std::fmt::Display,
{
self.internal_keys_lost = value.try_into().map_err(|e| {
format!("error converting supplied value for internal_keys_lost: {e}")
});
self
}
pub fn source_did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::RestoreRecordSourceDid>>,
T::Error: ::std::fmt::Display,
{
self.source_did = value
.try_into()
.map_err(|e| format!("error converting supplied value for source_did: {e}"));
self
}
pub fn source_environment<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::DeploymentEnvironment>>,
T::Error: ::std::fmt::Display,
{
self.source_environment = value.try_into().map_err(|e| {
format!("error converting supplied value for source_environment: {e}")
});
self
}
pub fn staged_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.staged_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for staged_at: {e}"));
self
}
pub fn staged_by<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::RestoreRecordStagedBy>,
T::Error: ::std::fmt::Display,
{
self.staged_by = value
.try_into()
.map_err(|e| format!("error converting supplied value for staged_by: {e}"));
self
}
pub fn target_environment<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::DeploymentEnvironment>,
T::Error: ::std::fmt::Display,
{
self.target_environment = value.try_into().map_err(|e| {
format!("error converting supplied value for target_environment: {e}")
});
self
}
}
impl ::std::convert::TryFrom<RestoreRecord> for super::RestoreRecord {
type Error = super::error::ConversionError;
fn try_from(
value: RestoreRecord,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
applied_at: value.applied_at?,
hosted_dids_detached: value.hosted_dids_detached?,
internal_keys_lost: value.internal_keys_lost?,
source_did: value.source_did?,
source_environment: value.source_environment?,
staged_at: value.staged_at?,
staged_by: value.staged_by?,
target_environment: value.target_environment?,
})
}
}
impl ::std::convert::From<super::RestoreRecord> for RestoreRecord {
fn from(value: super::RestoreRecord) -> Self {
Self {
applied_at: Ok(value.applied_at),
hosted_dids_detached: Ok(value.hosted_dids_detached),
internal_keys_lost: Ok(value.internal_keys_lost),
source_did: Ok(value.source_did),
source_environment: Ok(value.source_environment),
staged_at: Ok(value.staged_at),
staged_by: Ok(value.staged_by),
target_environment: Ok(value.target_environment),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/restore/status/0.1";
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(
"{\n \"$defs\": {\n \"DeploymentEnvironment\": {\n \"description\": \"The kind of deployment an agent's state lives in, as a backup restore classifies it: plain (an unencrypted store), hardened (the store encrypted under a key derived from the agent's seed), or tee (seed and signing keys sealed to an attested trusted execution environment).\",\n \"enum\": [\n \"plain\",\n \"hardened\",\n \"tee\"\n ],\n \"title\": \"DeploymentEnvironment\",\n \"type\": \"string\"\n },\n \"Ext\": {\n \"additionalProperties\": true,\n \"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.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/restore/status/0.1#response. Failures use trust-task-error, not this shape.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\",\n \"description\": \"Ecosystem-defined extension members per SPEC.md §4.5.1.\"\n },\n \"restore\": {\n \"$ref\": \"#/$defs/RestoreRecord\",\n \"description\": \"The restore the agent's current state derives from. Present exactly when `restored` is true.\"\n },\n \"restored\": {\n \"description\": \"Whether the agent's current state derives from a backup restore. Always present, so 'not restored' is stated rather than inferred from an absent member. True exactly when `restore` is present.\",\n \"type\": \"boolean\"\n },\n \"version\": {\n \"description\": \"The agent's software version, as its build reports it.\",\n \"maxLength\": 64,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"version\",\n \"restored\"\n ],\n \"title\": \"VTA Restore Status — response payload\",\n \"type\": \"object\"\n },\n \"RestoreRecord\": {\n \"additionalProperties\": false,\n \"description\": \"The backup restore the agent's current state derives from (VTI-VTA-051). `sourceEnvironment` is the kind of deployment the backup was taken from, present when the backup records it; `targetEnvironment` is the kind the restore was applied to — this agent's.\",\n \"properties\": {\n \"appliedAt\": {\n \"description\": \"When the restored state was applied — the boot at which it replaced the agent's previous state.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"hostedDidsDetached\": {\n \"description\": \"DIDs whose hosting registrations the restore detached because it replaced a different identity; each must be registered with its host again. Absent when none were.\",\n \"items\": {\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"maxItems\": 10000,\n \"type\": \"array\"\n },\n \"internalKeysLost\": {\n \"description\": \"Identifiers of keys whose records came back without their material: keys the agent generated internally and never exports, so no backup carries them. Absent when none were lost.\",\n \"items\": {\n \"maxLength\": 256,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"maxItems\": 10000,\n \"type\": \"array\"\n },\n \"sourceDid\": {\n \"description\": \"The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity.\",\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"sourceEnvironment\": {\n \"$ref\": \"#/$defs/DeploymentEnvironment\"\n },\n \"stagedAt\": {\n \"description\": \"When the restore was committed and staged for the next boot.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"stagedBy\": {\n \"description\": \"The DID of the administrator who committed the restore.\",\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"targetEnvironment\": {\n \"$ref\": \"#/$defs/DeploymentEnvironment\"\n }\n },\n \"required\": [\n \"appliedAt\",\n \"stagedAt\",\n \"stagedBy\",\n \"targetEnvironment\"\n ],\n \"title\": \"RestoreRecord\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/vta/restore/status/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"An administrator asks a Verifiable Trust Agent whether its current state derives from a backup restore, and which software version it runs. The payload carries nothing. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\",\n \"description\": \"Ecosystem-defined extension members per SPEC.md §4.5.1.\"\n }\n },\n \"title\": \"VTA Restore — Status — payload\",\n \"type\": \"object\"\n}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/restore/status/0.1#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(
"{\n \"$defs\": {\n \"DeploymentEnvironment\": {\n \"description\": \"The kind of deployment an agent's state lives in, as a backup restore classifies it: plain (an unencrypted store), hardened (the store encrypted under a key derived from the agent's seed), or tee (seed and signing keys sealed to an attested trusted execution environment).\",\n \"enum\": [\n \"plain\",\n \"hardened\",\n \"tee\"\n ],\n \"title\": \"DeploymentEnvironment\",\n \"type\": \"string\"\n },\n \"Ext\": {\n \"additionalProperties\": true,\n \"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.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/restore/status/0.1#response. Failures use trust-task-error, not this shape.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\",\n \"description\": \"Ecosystem-defined extension members per SPEC.md §4.5.1.\"\n },\n \"restore\": {\n \"$ref\": \"#/$defs/RestoreRecord\",\n \"description\": \"The restore the agent's current state derives from. Present exactly when `restored` is true.\"\n },\n \"restored\": {\n \"description\": \"Whether the agent's current state derives from a backup restore. Always present, so 'not restored' is stated rather than inferred from an absent member. True exactly when `restore` is present.\",\n \"type\": \"boolean\"\n },\n \"version\": {\n \"description\": \"The agent's software version, as its build reports it.\",\n \"maxLength\": 64,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"version\",\n \"restored\"\n ],\n \"title\": \"VTA Restore Status — response payload\",\n \"type\": \"object\"\n },\n \"RestoreRecord\": {\n \"additionalProperties\": false,\n \"description\": \"The backup restore the agent's current state derives from (VTI-VTA-051). `sourceEnvironment` is the kind of deployment the backup was taken from, present when the backup records it; `targetEnvironment` is the kind the restore was applied to — this agent's.\",\n \"properties\": {\n \"appliedAt\": {\n \"description\": \"When the restored state was applied — the boot at which it replaced the agent's previous state.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"hostedDidsDetached\": {\n \"description\": \"DIDs whose hosting registrations the restore detached because it replaced a different identity; each must be registered with its host again. Absent when none were.\",\n \"items\": {\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"maxItems\": 10000,\n \"type\": \"array\"\n },\n \"internalKeysLost\": {\n \"description\": \"Identifiers of keys whose records came back without their material: keys the agent generated internally and never exports, so no backup carries them. Absent when none were lost.\",\n \"items\": {\n \"maxLength\": 256,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"maxItems\": 10000,\n \"type\": \"array\"\n },\n \"sourceDid\": {\n \"description\": \"The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity.\",\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"sourceEnvironment\": {\n \"$ref\": \"#/$defs/DeploymentEnvironment\"\n },\n \"stagedAt\": {\n \"description\": \"When the restore was committed and staged for the next boot.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"stagedBy\": {\n \"description\": \"The DID of the administrator who committed the restore.\",\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"targetEnvironment\": {\n \"$ref\": \"#/$defs/DeploymentEnvironment\"\n }\n },\n \"required\": [\n \"appliedAt\",\n \"stagedAt\",\n \"stagedBy\",\n \"targetEnvironment\"\n ],\n \"title\": \"RestoreRecord\",\n \"type\": \"object\"\n }\n },\n \"$ref\": \"#/$defs/Response\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\"\n}\n",
);
}
impl crate::RequestPayload for Payload {
type Response = Response;
}
/// 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] = &[];
#[cfg(test)]
mod conformance {
//! Round-trip tests harvested from the spec's `spec.md`,
//! plus a `rejects_invalid_examples` test for any fixtures
//! in `payload.invalid-examples.json` (validate feature).
#[test]
fn request_example_1() {
const JSON: &str = "{\n \"id\": \"urn:uuid:4b5a6f7e-8d9c-4abb-8ad9-e8f7a6b5c434\",\n \"type\": \"https://trusttasks.org/spec/vta/restore/status/0.1\",\n \"issuer\": \"did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK\",\n \"recipient\": \"did:webvh:QmExampleScid:vta.example.com\",\n \"issuedAt\": \"2026-09-27T12:00:00Z\",\n \"payload\": {},\n \"proof\": {\n \"type\": \"DataIntegrityProof\",\n \"cryptosuite\": \"eddsa-jcs-2022\",\n \"verificationMethod\": \"did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK#z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK\",\n \"created\": \"2026-09-27T12:00:00Z\",\n \"proofPurpose\": \"authentication\",\n \"proofValue\": \"z3kg…\"\n }\n}\n";
let doc: crate::TrustTask<super::Payload> =
serde_json::from_str(JSON).expect("deserialize request example");
let rendered = serde_json::to_value(&doc).expect("re-serialize");
let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
assert_eq!(rendered, expected, "request example failed round-trip");
}
#[test]
fn response_example_1() {
const JSON: &str = "{\n \"id\": \"urn:uuid:5c6b7a8f-9e0d-4bcc-9bea-f9a8b7c6d545\",\n \"threadId\": \"urn:uuid:4b5a6f7e-8d9c-4abb-8ad9-e8f7a6b5c434\",\n \"type\": \"https://trusttasks.org/spec/vta/restore/status/0.1#response\",\n \"issuer\": \"did:webvh:QmExampleScid:vta.example.com\",\n \"recipient\": \"did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK\",\n \"issuedAt\": \"2026-09-27T12:00:01Z\",\n \"payload\": {\n \"version\": \"0.40.0\",\n \"restored\": false\n },\n \"proof\": {\n \"type\": \"DataIntegrityProof\",\n \"cryptosuite\": \"eddsa-jcs-2022\",\n \"verificationMethod\": \"did:webvh:QmExampleScid:vta.example.com#key-1\",\n \"created\": \"2026-09-27T12:00:01Z\",\n \"proofPurpose\": \"authentication\",\n \"proofValue\": \"z3kg…\"\n }\n}\n";
let doc: crate::TrustTask<super::Response> =
serde_json::from_str(JSON).expect("deserialize response example");
let rendered = serde_json::to_value(&doc).expect("re-serialize");
let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
assert_eq!(rendered, expected, "response example failed round-trip");
}
#[test]
fn response_example_2() {
const JSON: &str = "{\n \"id\": \"urn:uuid:6d7c8b9a-0f1e-4cdd-8cfb-0a9b8c7d6e56\",\n \"threadId\": \"urn:uuid:4b5a6f7e-8d9c-4abb-8ad9-e8f7a6b5c434\",\n \"type\": \"https://trusttasks.org/spec/vta/restore/status/0.1#response\",\n \"issuer\": \"did:webvh:QmExampleScid:vta.example.com\",\n \"recipient\": \"did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK\",\n \"issuedAt\": \"2026-09-27T12:00:01Z\",\n \"payload\": {\n \"version\": \"0.40.0\",\n \"restored\": true,\n \"restore\": {\n \"appliedAt\": \"2026-09-26T08:15:02Z\",\n \"stagedAt\": \"2026-09-26T08:14:40Z\",\n \"stagedBy\": \"did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK\",\n \"sourceDid\": \"did:webvh:QmOldScid:vta-old.example.com\",\n \"sourceEnvironment\": \"hardened\",\n \"targetEnvironment\": \"tee\",\n \"internalKeysLost\": [\"audit-checkpoint-signer\"],\n \"hostedDidsDetached\": [\"did:webvh:QmHostedScid:app.example.com\"]\n }\n },\n \"proof\": {\n \"type\": \"DataIntegrityProof\",\n \"cryptosuite\": \"eddsa-jcs-2022\",\n \"verificationMethod\": \"did:webvh:QmExampleScid:vta.example.com#key-1\",\n \"created\": \"2026-09-27T12:00:01Z\",\n \"proofPurpose\": \"authentication\",\n \"proofValue\": \"z3kg…\"\n }\n}\n";
let doc: crate::TrustTask<super::Response> =
serde_json::from_str(JSON).expect("deserialize response example");
let rendered = serde_json::to_value(&doc).expect("re-serialize");
let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
assert_eq!(rendered, expected, "response example failed round-trip");
}
/// Each fixture in `payload.invalid-examples.json` MUST be
/// rejected by at least one of: serde deserialization, or
/// JSON-Schema validation under the `validate` feature. The
/// fixture file documents the producer-side bug class that
/// each payload exemplifies; this generated test pins it.
#[cfg(feature = "validate")]
#[test]
fn rejects_invalid_examples() {
use crate::validate::ValidatedPayload;
let fixtures: &[(&str, &str)] = &[
(
"The request carries nothing — an unknown top-level member is rejected (additionalProperties: false). An administrator cannot select a subset of the record.",
"{\n \"fields\": [\n \"stagedBy\"\n ]\n}",
),
(
"Bare/unnamespaced ext key — SPEC §4.5.1 requires every immediate child of ext to be reverse-DNS namespaced.",
"{\n \"ext\": {\n \"bare-key\": {\n \"anything\": \"here\"\n }\n }\n}",
),
("`ext` must be an object, not a string.", "{\n \"ext\": \"vendor\"\n}"),
];
for (i, (note, raw)) in fixtures.iter().enumerate() {
let value: serde_json::Value = match serde_json::from_str(raw) {
Ok(v) => v,
Err(_) => continue,
};
let serde_ok = serde_json::from_value::<super::Payload>(value.clone()).is_ok();
let schema_ok = super::Payload::validate_value(&value).is_ok();
assert!(
!(serde_ok && schema_ok),
"invalid-example #{} ({:?}) was accepted by both serde and JSON Schema; \
the fixture's stated failure class is no longer caught:\n{}",
i + 1,
note,
raw
);
}
}
}