//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `persona/attribute/purge-version`. Version: `1.0`.
#[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.
///
/// <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())
})
}
}
///Permanently remove earlier versions of one attribute that the maintainer kept because a profile pins them. The holder's override on retention: after a name change, the old name is kept only while something needs it, and this is how the holder says nothing does.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/persona/attribute/purge-version/1.0",
/// "title": "Payload",
/// "description": "Permanently remove earlier versions of one attribute that the maintainer kept because a profile pins them. The holder's override on retention: after a name change, the old name is kept only while something needs it, and this is how the holder says nothing does.",
/// "type": "object",
/// "required": [
/// "attributeId"
/// ],
/// "properties": {
/// "attributeId": {
/// "$ref": "#/definitions/Ulid"
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "versions": {
/// "description": "The retained versions to remove. Omit to remove every retained version of the attribute. The current version is never removed by this task — that is persona/attribute/delete.",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/Version"
/// },
/// "maxItems": 64,
/// "minItems": 1,
/// "uniqueItems": true
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
#[serde(rename = "attributeId")]
pub attribute_id: Ulid,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///The retained versions to remove. Omit to remove every retained version of the attribute. The current version is never removed by this task — that is persona/attribute/delete.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub versions: ::std::option::Option<Vec<Version>>,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///Success response to persona/attribute/purge-version. Type https://trusttasks.org/spec/persona/attribute/purge-version/1.0#response. Purging a version that is not held is a success that purges nothing, so a repeated purge converges.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "Success response to persona/attribute/purge-version. Type https://trusttasks.org/spec/persona/attribute/purge-version/1.0#response. Purging a version that is not held is a success that purges nothing, so a repeated purge converges.",
/// "type": "object",
/// "required": [
/// "attributeId",
/// "purged"
/// ],
/// "properties": {
/// "attributeId": {
/// "$ref": "#/definitions/Ulid"
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "purged": {
/// "description": "The versions actually removed. Empty when none named was held.",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/Version"
/// },
/// "maxItems": 64
/// },
/// "stalePins": {
/// "description": "Profiles that pinned a purged version and now present that entry as stale — which is to say, disclose nothing for it until the holder repins or edits them. Named because a purge that quietly shortened what three faces present is the surprise this family exists to prevent. Absent when none did.",
/// "type": "array",
/// "items": {
/// "type": "object",
/// "required": [
/// "pinVersion",
/// "profileId"
/// ],
/// "properties": {
/// "pinVersion": {
/// "$ref": "#/definitions/Version"
/// },
/// "profileId": {
/// "$ref": "#/definitions/Ulid"
/// }
/// },
/// "additionalProperties": false
/// },
/// "maxItems": 256
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
#[serde(rename = "attributeId")]
pub attribute_id: Ulid,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///The versions actually removed. Empty when none named was held.
pub purged: ::std::vec::Vec<Version>,
///Profiles that pinned a purged version and now present that entry as stale — which is to say, disclose nothing for it until the holder repins or edits them. Named because a purge that quietly shortened what three faces present is the surprise this family exists to prevent. Absent when none did.
#[serde(
rename = "stalePins",
default,
skip_serializing_if = "::std::vec::Vec::is_empty"
)]
pub stale_pins: ::std::vec::Vec<ResponseStalePinsItem>,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///`ResponseStalePinsItem`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "pinVersion",
/// "profileId"
/// ],
/// "properties": {
/// "pinVersion": {
/// "$ref": "#/definitions/Version"
/// },
/// "profileId": {
/// "$ref": "#/definitions/Ulid"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct ResponseStalePinsItem {
#[serde(rename = "pinVersion")]
pub pin_version: Version,
#[serde(rename = "profileId")]
pub profile_id: Ulid,
}
impl ResponseStalePinsItem {
pub fn builder() -> builder::ResponseStalePinsItem {
Default::default()
}
}
///A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Ulid",
/// "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
/// "type": "string",
/// "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct Ulid(::std::string::String);
impl ::std::ops::Deref for Ulid {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<Ulid> for ::std::string::String {
fn from(value: Ulid) -> Self {
value.0
}
}
impl ::std::str::FromStr for Ulid {
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("^[0-9A-HJKMNP-TV-Z]{26}$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[0-9A-HJKMNP-TV-Z]{26}$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for Ulid {
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 Ulid {
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 Ulid {
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 Ulid {
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())
})
}
}
///A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Version",
/// "description": "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.",
/// "type": "integer",
/// "minimum": 1.0
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Version(pub ::std::num::NonZeroU64);
impl ::std::ops::Deref for Version {
type Target = ::std::num::NonZeroU64;
fn deref(&self) -> &::std::num::NonZeroU64 {
&self.0
}
}
impl ::std::convert::From<Version> for ::std::num::NonZeroU64 {
fn from(value: Version) -> Self {
value.0
}
}
impl ::std::convert::From<::std::num::NonZeroU64> for Version {
fn from(value: ::std::num::NonZeroU64) -> Self {
Self(value)
}
}
impl ::std::str::FromStr for Version {
type Err = <::std::num::NonZeroU64 as ::std::str::FromStr>::Err;
fn from_str(value: &str) -> ::std::result::Result<Self, Self::Err> {
Ok(Self(value.parse()?))
}
}
impl ::std::convert::TryFrom<&str> for Version {
type Error = <::std::num::NonZeroU64 as ::std::str::FromStr>::Err;
fn try_from(value: &str) -> ::std::result::Result<Self, Self::Error> {
value.parse()
}
}
impl ::std::convert::TryFrom<String> for Version {
type Error = <::std::num::NonZeroU64 as ::std::str::FromStr>::Err;
fn try_from(value: String) -> ::std::result::Result<Self, Self::Error> {
value.parse()
}
}
impl ::std::fmt::Display for Version {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
self.0.fmt(f)
}
}
/// Types for composing complex structures.
pub mod builder {
#[derive(Clone, Debug)]
pub struct Payload {
attribute_id: ::std::result::Result<super::Ulid, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
versions: ::std::result::Result<
::std::option::Option<Vec<super::Version>>,
::std::string::String,
>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
attribute_id: Err("no value supplied for attribute_id".to_string()),
ext: Ok(Default::default()),
versions: Ok(Default::default()),
}
}
}
impl Payload {
pub fn attribute_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Ulid>,
T::Error: ::std::fmt::Display,
{
self.attribute_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for attribute_id: {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 versions<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<Vec<super::Version>>>,
T::Error: ::std::fmt::Display,
{
self.versions = value
.try_into()
.map_err(|e| format!("error converting supplied value for versions: {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 {
attribute_id: value.attribute_id?,
ext: value.ext?,
versions: value.versions?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
attribute_id: Ok(value.attribute_id),
ext: Ok(value.ext),
versions: Ok(value.versions),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
attribute_id: ::std::result::Result<super::Ulid, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
purged: ::std::result::Result<::std::vec::Vec<super::Version>, ::std::string::String>,
stale_pins: ::std::result::Result<
::std::vec::Vec<super::ResponseStalePinsItem>,
::std::string::String,
>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
attribute_id: Err("no value supplied for attribute_id".to_string()),
ext: Ok(Default::default()),
purged: Err("no value supplied for purged".to_string()),
stale_pins: Ok(Default::default()),
}
}
}
impl Response {
pub fn attribute_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Ulid>,
T::Error: ::std::fmt::Display,
{
self.attribute_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for attribute_id: {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 purged<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::Version>>,
T::Error: ::std::fmt::Display,
{
self.purged = value
.try_into()
.map_err(|e| format!("error converting supplied value for purged: {e}"));
self
}
pub fn stale_pins<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::ResponseStalePinsItem>>,
T::Error: ::std::fmt::Display,
{
self.stale_pins = value
.try_into()
.map_err(|e| format!("error converting supplied value for stale_pins: {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 {
attribute_id: value.attribute_id?,
ext: value.ext?,
purged: value.purged?,
stale_pins: value.stale_pins?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
attribute_id: Ok(value.attribute_id),
ext: Ok(value.ext),
purged: Ok(value.purged),
stale_pins: Ok(value.stale_pins),
}
}
}
#[derive(Clone, Debug)]
pub struct ResponseStalePinsItem {
pin_version: ::std::result::Result<super::Version, ::std::string::String>,
profile_id: ::std::result::Result<super::Ulid, ::std::string::String>,
}
impl ::std::default::Default for ResponseStalePinsItem {
fn default() -> Self {
Self {
pin_version: Err("no value supplied for pin_version".to_string()),
profile_id: Err("no value supplied for profile_id".to_string()),
}
}
}
impl ResponseStalePinsItem {
pub fn pin_version<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Version>,
T::Error: ::std::fmt::Display,
{
self.pin_version = value
.try_into()
.map_err(|e| format!("error converting supplied value for pin_version: {e}"));
self
}
pub fn profile_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Ulid>,
T::Error: ::std::fmt::Display,
{
self.profile_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for profile_id: {e}"));
self
}
}
impl ::std::convert::TryFrom<ResponseStalePinsItem> for super::ResponseStalePinsItem {
type Error = super::error::ConversionError;
fn try_from(
value: ResponseStalePinsItem,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
pin_version: value.pin_version?,
profile_id: value.profile_id?,
})
}
}
impl ::std::convert::From<super::ResponseStalePinsItem> for ResponseStalePinsItem {
fn from(value: super::ResponseStalePinsItem) -> Self {
Self {
pin_version: Ok(value.pin_version),
profile_id: Ok(value.profile_id),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/persona/attribute/purge-version/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(
"{\n \"$defs\": {\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\": \"Success response to persona/attribute/purge-version. Type https://trusttasks.org/spec/persona/attribute/purge-version/1.0#response. Purging a version that is not held is a success that purges nothing, so a repeated purge converges.\",\n \"properties\": {\n \"attributeId\": {\n \"$ref\": \"#/$defs/Ulid\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"purged\": {\n \"description\": \"The versions actually removed. Empty when none named was held.\",\n \"items\": {\n \"$ref\": \"#/$defs/Version\"\n },\n \"maxItems\": 64,\n \"type\": \"array\"\n },\n \"stalePins\": {\n \"description\": \"Profiles that pinned a purged version and now present that entry as stale — which is to say, disclose nothing for it until the holder repins or edits them. Named because a purge that quietly shortened what three faces present is the surprise this family exists to prevent. Absent when none did.\",\n \"items\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"pinVersion\": {\n \"$ref\": \"#/$defs/Version\"\n },\n \"profileId\": {\n \"$ref\": \"#/$defs/Ulid\"\n }\n },\n \"required\": [\n \"profileId\",\n \"pinVersion\"\n ],\n \"type\": \"object\"\n },\n \"maxItems\": 256,\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"attributeId\",\n \"purged\"\n ],\n \"title\": \"Persona Attribute Purge Version — response payload\",\n \"type\": \"object\"\n },\n \"Ulid\": {\n \"description\": \"A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.\",\n \"pattern\": \"^[0-9A-HJKMNP-TV-Z]{26}$\",\n \"title\": \"Ulid\",\n \"type\": \"string\"\n },\n \"Version\": {\n \"description\": \"A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.\",\n \"minimum\": 1,\n \"title\": \"Version\",\n \"type\": \"integer\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/persona/attribute/purge-version/1.0\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"Permanently remove earlier versions of one attribute that the maintainer kept because a profile pins them. The holder's override on retention: after a name change, the old name is kept only while something needs it, and this is how the holder says nothing does.\",\n \"properties\": {\n \"attributeId\": {\n \"$ref\": \"#/$defs/Ulid\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"versions\": {\n \"description\": \"The retained versions to remove. Omit to remove every retained version of the attribute. The current version is never removed by this task — that is persona/attribute/delete.\",\n \"items\": {\n \"$ref\": \"#/$defs/Version\"\n },\n \"maxItems\": 64,\n \"minItems\": 1,\n \"type\": \"array\",\n \"uniqueItems\": true\n }\n },\n \"required\": [\n \"attributeId\"\n ],\n \"title\": \"Persona Attribute Purge Version — payload\",\n \"type\": \"object\"\n}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/persona/attribute/purge-version/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(
"{\n \"$defs\": {\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\": \"Success response to persona/attribute/purge-version. Type https://trusttasks.org/spec/persona/attribute/purge-version/1.0#response. Purging a version that is not held is a success that purges nothing, so a repeated purge converges.\",\n \"properties\": {\n \"attributeId\": {\n \"$ref\": \"#/$defs/Ulid\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"purged\": {\n \"description\": \"The versions actually removed. Empty when none named was held.\",\n \"items\": {\n \"$ref\": \"#/$defs/Version\"\n },\n \"maxItems\": 64,\n \"type\": \"array\"\n },\n \"stalePins\": {\n \"description\": \"Profiles that pinned a purged version and now present that entry as stale — which is to say, disclose nothing for it until the holder repins or edits them. Named because a purge that quietly shortened what three faces present is the surprise this family exists to prevent. Absent when none did.\",\n \"items\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"pinVersion\": {\n \"$ref\": \"#/$defs/Version\"\n },\n \"profileId\": {\n \"$ref\": \"#/$defs/Ulid\"\n }\n },\n \"required\": [\n \"profileId\",\n \"pinVersion\"\n ],\n \"type\": \"object\"\n },\n \"maxItems\": 256,\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"attributeId\",\n \"purged\"\n ],\n \"title\": \"Persona Attribute Purge Version — response payload\",\n \"type\": \"object\"\n },\n \"Ulid\": {\n \"description\": \"A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.\",\n \"pattern\": \"^[0-9A-HJKMNP-TV-Z]{26}$\",\n \"title\": \"Ulid\",\n \"type\": \"string\"\n },\n \"Version\": {\n \"description\": \"A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.\",\n \"minimum\": 1,\n \"title\": \"Version\",\n \"type\": \"integer\"\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] = &[error_codes::CURRENT_VERSION];
/// 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 {
/// `persona/attribute/purge-version:currentVersion`
///
/// A named version is the attribute's current one. The current value is removed with persona/attribute/delete, never here — a purge that could take the live value would make "tidy up old names" able to erase the present one.
///
/// Declared `retryable: false`.
pub const CURRENT_VERSION: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "persona/attribute/purge-version:currentVersion",
retryable: false,
};
}