//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `acl/revoke`. 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())
}
}
}
///`AclEntry`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "role",
/// "subject"
/// ],
/// "properties": {
/// "createdAt": {
/// "type": "string",
/// "format": "date-time"
/// },
/// "createdBy": {
/// "type": "string"
/// },
/// "expiresAt": {
/// "type": "string",
/// "format": "date-time"
/// },
/// "label": {
/// "type": "string"
/// },
/// "metadata": {
/// "type": "object"
/// },
/// "role": {
/// "type": "string"
/// },
/// "scopes": {
/// "type": "array",
/// "items": {
/// "type": "string"
/// }
/// },
/// "subject": {
/// "type": "string"
/// },
/// "updatedAt": {
/// "type": "string",
/// "format": "date-time"
/// },
/// "updatedBy": {
/// "type": "string"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct AclEntry {
#[serde(
rename = "createdAt",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub created_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
#[serde(
rename = "createdBy",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub created_by: ::std::option::Option<::std::string::String>,
#[serde(
rename = "expiresAt",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub expires_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub label: ::std::option::Option<::std::string::String>,
#[serde(default, skip_serializing_if = "::serde_json::Map::is_empty")]
pub metadata: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
pub role: ::std::string::String,
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub scopes: ::std::vec::Vec<::std::string::String>,
pub subject: ::std::string::String,
#[serde(
rename = "updatedAt",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub updated_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
#[serde(
rename = "updatedBy",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub updated_by: ::std::option::Option<::std::string::String>,
}
impl ::std::convert::From<&AclEntry> for AclEntry {
fn from(value: &AclEntry) -> Self {
value.clone()
}
}
///`Payload`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/acl/revoke/0.1",
/// "title": "Payload",
/// "type": "object",
/// "required": [
/// "subject"
/// ],
/// "properties": {
/// "reason": {
/// "description": "Optional human-readable rationale for the revocation.",
/// "type": "string"
/// },
/// "scopes": {
/// "description": "If present, the specific scopes to remove from the subject's entry. If absent, the entire entry is removed.",
/// "type": "array",
/// "items": {
/// "type": "string",
/// "minLength": 1
/// },
/// "minItems": 1
/// },
/// "subject": {
/// "description": "VID of the party being revoked (or scope-reduced).",
/// "type": "string"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Payload {
///Optional human-readable rationale for the revocation.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub reason: ::std::option::Option<::std::string::String>,
///If present, the specific scopes to remove from the subject's entry. If absent, the entire entry is removed.
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub scopes: ::std::vec::Vec<PayloadScopesItem>,
///VID of the party being revoked (or scope-reduced).
pub subject: ::std::string::String,
}
impl ::std::convert::From<&Payload> for Payload {
fn from(value: &Payload) -> Self {
value.clone()
}
}
///`PayloadScopesItem`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadScopesItem(::std::string::String);
impl ::std::ops::Deref for PayloadScopesItem {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadScopesItem> for ::std::string::String {
fn from(value: PayloadScopesItem) -> Self {
value.0
}
}
impl ::std::convert::From<&PayloadScopesItem> for PayloadScopesItem {
fn from(value: &PayloadScopesItem) -> Self {
value.clone()
}
}
impl ::std::str::FromStr for PayloadScopesItem {
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 PayloadScopesItem {
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 PayloadScopesItem {
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 PayloadScopesItem {
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 PayloadScopesItem {
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 success response to an acl/revoke request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/acl/revoke/0.1#response.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "The success response to an acl/revoke request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/acl/revoke/0.1#response.",
/// "type": "object",
/// "required": [
/// "entry"
/// ],
/// "properties": {
/// "entry": {
/// "description": "The AclEntry the maintainer now holds for the subject. null for a full removal; an AclEntry with reduced scopes for a scope reduction.",
/// "oneOf": [
/// {
/// "type": "null"
/// },
/// {
/// "$ref": "#/definitions/AclEntry"
/// }
/// ]
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Response {
///The AclEntry the maintainer now holds for the subject. null for a full removal; an AclEntry with reduced scopes for a scope reduction.
pub entry: ::std::option::Option<AclEntry>,
}
impl ::std::convert::From<&Response> for Response {
fn from(value: &Response) -> Self {
value.clone()
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/acl/revoke/0.1";
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/acl/revoke/0.1#response";
}
#[cfg(feature = "validate")]
impl crate::validate::ValidatedPayload for Payload {
const SCHEMA_JSON: &'static str = "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"$id\": \"https://trusttasks.org/spec/acl/revoke/0.1\",\n \"title\": \"ACL Revoke — payload\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\"subject\"],\n \"properties\": {\n \"subject\": {\n \"type\": \"string\",\n \"description\": \"VID of the party being revoked (or scope-reduced).\"\n },\n \"scopes\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\", \"minLength\": 1 },\n \"minItems\": 1,\n \"description\": \"If present, the specific scopes to remove from the subject's entry. If absent, the entire entry is removed.\"\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Optional human-readable rationale for the revocation.\"\n }\n },\n \"$defs\": {\n \"AclEntry\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\"subject\", \"role\"],\n \"properties\": {\n \"subject\": { \"type\": \"string\" },\n \"role\": { \"type\": \"string\" },\n \"scopes\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } },\n \"label\": { \"type\": \"string\" },\n \"createdAt\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"createdBy\": { \"type\": \"string\" },\n \"updatedAt\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"updatedBy\": { \"type\": \"string\" },\n \"expiresAt\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"metadata\": { \"type\": \"object\" }\n }\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"title\": \"ACL Revoke — response payload\",\n \"description\": \"The success response to an acl/revoke request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/acl/revoke/0.1#response.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\"entry\"],\n \"properties\": {\n \"entry\": {\n \"description\": \"The AclEntry the maintainer now holds for the subject. null for a full removal; an AclEntry with reduced scopes for a scope reduction.\",\n \"oneOf\": [\n { \"type\": \"null\" },\n { \"$ref\": \"#/$defs/AclEntry\" }\n ]\n }\n }\n }\n }\n}\n";
}
#[cfg(test)]
mod conformance {
//! Round-trip tests harvested from the spec's `spec.md`.
#[test]
fn request_example_1() {
const JSON: &str = "{\n \"id\": \"9e2a1c44-7b81-4d3e-9b51-7a3c89e3d1f2\",\n \"type\": \"https://trusttasks.org/spec/acl/revoke/0.1\",\n \"issuer\": \"did:web:org.example\",\n \"recipient\": \"did:web:maintainer.example\",\n \"issuedAt\": \"2026-05-20T11:00:00Z\",\n \"payload\": {\n \"subject\": \"did:web:contractor.example\",\n \"reason\": \"Engagement completed.\"\n },\n \"proof\": {\n \"type\": \"DataIntegrityProof\",\n \"cryptosuite\": \"eddsa-rdfc-2022\",\n \"verificationMethod\": \"did:web:org.example#key-1\",\n \"created\": \"2026-05-20T11:00:00Z\",\n \"proofPurpose\": \"assertionMethod\",\n \"proofValue\": \"z4ab...\"\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 request_example_2() {
const JSON: &str = "{\n \"id\": \"7a91c7b3-2e62-4a91-a3a4-9d61b75e2f01\",\n \"type\": \"https://trusttasks.org/spec/acl/revoke/0.1\",\n \"issuer\": \"did:web:org.example\",\n \"recipient\": \"did:web:maintainer.example\",\n \"issuedAt\": \"2026-05-21T09:30:00Z\",\n \"payload\": {\n \"subject\": \"did:web:alice.example\",\n \"scopes\": [\"context:project-beta\"],\n \"reason\": \"Project-beta access withdrawn; project-alpha access retained.\"\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 request_example_3() {
const JSON: &str = "{\n \"id\": \"f0b2c5a1-8d3e-4c4a-92b1-1e8d4cbe7104\",\n \"type\": \"https://trusttasks.org/spec/acl/revoke/0.1\",\n \"issuer\": \"did:web:alice.example\",\n \"recipient\": \"did:web:maintainer.example\",\n \"issuedAt\": \"2026-06-01T08:00:00Z\",\n \"payload\": {\n \"subject\": \"did:web:alice.example\",\n \"reason\": \"Resigning from the organization.\"\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\": \"ae2a1c44-7b81-4d3e-9b51-7a3c89e3d1f3\",\n \"type\": \"https://trusttasks.org/spec/acl/revoke/0.1#response\",\n \"threadId\": \"9e2a1c44-7b81-4d3e-9b51-7a3c89e3d1f2\",\n \"issuer\": \"did:web:maintainer.example\",\n \"recipient\": \"did:web:org.example\",\n \"issuedAt\": \"2026-05-20T11:00:01Z\",\n \"payload\": {\n \"entry\": null\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\": \"8a91c7b3-2e62-4a91-a3a4-9d61b75e2f02\",\n \"type\": \"https://trusttasks.org/spec/acl/revoke/0.1#response\",\n \"threadId\": \"7a91c7b3-2e62-4a91-a3a4-9d61b75e2f01\",\n \"issuer\": \"did:web:maintainer.example\",\n \"recipient\": \"did:web:org.example\",\n \"issuedAt\": \"2026-05-21T09:30:01Z\",\n \"payload\": {\n \"entry\": {\n \"subject\": \"did:web:alice.example\",\n \"role\": \"member\",\n \"scopes\": [\"context:project-alpha\"],\n \"createdAt\": \"2026-04-01T00:00:00Z\",\n \"createdBy\": \"did:web:org.example\",\n \"updatedAt\": \"2026-05-21T09:30:01Z\",\n \"updatedBy\": \"did:web:org.example\"\n }\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");
}
}