//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `registry/recognition`. 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())
}
}
}
///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())
})
}
}
///TRQP v2.0 recognition query: ask a trust registry whether an entity is recognised by an authority for a given action+resource. Field names are verbatim from the TRQP recognition request/response schemas so the same payload serves the plain HTTP TRQP binding and the Trust Task binding.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/registry/recognition/0.1",
/// "title": "Payload",
/// "description": "TRQP v2.0 recognition query: ask a trust registry whether an entity is recognised by an authority for a given action+resource. Field names are verbatim from the TRQP recognition request/response schemas so the same payload serves the plain HTTP TRQP binding and the Trust Task binding.",
/// "type": "object",
/// "required": [
/// "action",
/// "authority_id",
/// "entity_id",
/// "resource"
/// ],
/// "properties": {
/// "action": {
/// "description": "The action the query is checking recognition for.",
/// "type": "string"
/// },
/// "authority_id": {
/// "description": "Identifier of the authority being queried to recognise the entity.",
/// "type": "string"
/// },
/// "context": {
/// "$ref": "#/definitions/QueryContext"
/// },
/// "entity_id": {
/// "description": "Identifier of the entity being tested for recognition.",
/// "type": "string"
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "resource": {
/// "description": "The resource the query is checking recognition for.",
/// "type": "string"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Payload {
///The action the query is checking recognition for.
pub action: ::std::string::String,
///Identifier of the authority being queried to recognise the entity.
pub authority_id: ::std::string::String,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub context: ::std::option::Option<QueryContext>,
///Identifier of the entity being tested for recognition.
pub entity_id: ::std::string::String,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///The resource the query is checking recognition for.
pub resource: ::std::string::String,
}
///Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "QueryContext",
/// "description": "Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.",
/// "type": "object",
/// "properties": {
/// "locator": {
/// "description": "Optional hint for systems that need extra information to locate the records in question (authorization queries).",
/// "type": "string"
/// },
/// "time": {
/// "description": "Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time.",
/// "type": "string",
/// "format": "date-time"
/// }
/// },
/// "additionalProperties": {
/// "type": "string"
/// }
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
pub struct QueryContext {
///Optional hint for systems that need extra information to locate the records in question (authorization queries).
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub locator: ::std::option::Option<::std::string::String>,
///Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub time: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
#[serde(flatten)]
pub extra: ::std::collections::HashMap<::std::string::String, ::std::string::String>,
}
///`Response`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "type": "object",
/// "required": [
/// "action",
/// "authority_id",
/// "entity_id",
/// "recognized",
/// "resource",
/// "time_evaluated"
/// ],
/// "properties": {
/// "action": {
/// "type": "string"
/// },
/// "authority_id": {
/// "type": "string"
/// },
/// "context": {
/// "$ref": "#/definitions/QueryContext"
/// },
/// "entity_id": {
/// "type": "string"
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "message": {
/// "description": "Additional human-readable detail about the recognition response.",
/// "type": "string"
/// },
/// "recognized": {
/// "description": "True if the action+resource has been recognised, false otherwise.",
/// "type": "boolean"
/// },
/// "resource": {
/// "type": "string"
/// },
/// "time_evaluated": {
/// "description": "Server time the query was evaluated at, per the endpoint clock.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_requested": {
/// "description": "The requested server time, echoed from the request `context.time` when supplied.",
/// "type": "string",
/// "format": "date-time"
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Response {
pub action: ::std::string::String,
pub authority_id: ::std::string::String,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub context: ::std::option::Option<QueryContext>,
pub entity_id: ::std::string::String,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Additional human-readable detail about the recognition response.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub message: ::std::option::Option<::std::string::String>,
///True if the action+resource has been recognised, false otherwise.
pub recognized: bool,
pub resource: ::std::string::String,
///Server time the query was evaluated at, per the endpoint clock.
pub time_evaluated: ::chrono::DateTime<::chrono::offset::Utc>,
///The requested server time, echoed from the request `context.time` when supplied.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub time_requested: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/registry/recognition/0.1";
const IS_RECIPIENT_REQUIRED: bool = true;
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/registry/recognition/0.1#response";
const IS_RECIPIENT_REQUIRED: bool = true;
}
#[cfg(feature = "validate")]
impl crate::validate::ValidatedPayload for Payload {
const SCHEMA_JSON: &'static str = "{\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 \"QueryContext\": {\n \"additionalProperties\": {\n \"type\": \"string\"\n },\n \"description\": \"Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.\",\n \"properties\": {\n \"locator\": {\n \"description\": \"Optional hint for systems that need extra information to locate the records in question (authorization queries).\",\n \"type\": \"string\"\n },\n \"time\": {\n \"description\": \"Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n \"title\": \"QueryContext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"properties\": {\n \"action\": {\n \"type\": \"string\"\n },\n \"authority_id\": {\n \"type\": \"string\"\n },\n \"context\": {\n \"$ref\": \"#/$defs/QueryContext\"\n },\n \"entity_id\": {\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"message\": {\n \"description\": \"Additional human-readable detail about the recognition response.\",\n \"type\": \"string\"\n },\n \"recognized\": {\n \"description\": \"True if the action+resource has been recognised, false otherwise.\",\n \"type\": \"boolean\"\n },\n \"resource\": {\n \"type\": \"string\"\n },\n \"time_evaluated\": {\n \"description\": \"Server time the query was evaluated at, per the endpoint clock.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"time_requested\": {\n \"description\": \"The requested server time, echoed from the request `context.time` when supplied.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"entity_id\",\n \"authority_id\",\n \"action\",\n \"resource\",\n \"recognized\",\n \"time_evaluated\"\n ],\n \"title\": \"Registry Recognition — response payload\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/registry/recognition/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"TRQP v2.0 recognition query: ask a trust registry whether an entity is recognised by an authority for a given action+resource. Field names are verbatim from the TRQP recognition request/response schemas so the same payload serves the plain HTTP TRQP binding and the Trust Task binding.\",\n \"properties\": {\n \"action\": {\n \"description\": \"The action the query is checking recognition for.\",\n \"type\": \"string\"\n },\n \"authority_id\": {\n \"description\": \"Identifier of the authority being queried to recognise the entity.\",\n \"type\": \"string\"\n },\n \"context\": {\n \"$ref\": \"#/$defs/QueryContext\"\n },\n \"entity_id\": {\n \"description\": \"Identifier of the entity being tested for recognition.\",\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"resource\": {\n \"description\": \"The resource the query is checking recognition for.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"entity_id\",\n \"authority_id\",\n \"action\",\n \"resource\"\n ],\n \"title\": \"Registry Recognition — payload\",\n \"type\": \"object\"\n}\n";
}
#[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).
/// 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)] = &[
(
"Empty payload omits the required members entity_id, authority_id, action, resource.",
"{}",
),
(
"Unknown top-level member is rejected (additionalProperties: false).",
"{\n \"__notARealMember__\": true,\n \"action\": \"issue\",\n \"authority_id\": \"did:example:authority\",\n \"entity_id\": \"did:example:entity\",\n \"resource\": \"vc\"\n}",
),
(
"entity_id must be a string.",
"{\n \"action\": \"issue\",\n \"authority_id\": \"did:example:authority\",\n \"entity_id\": 42,\n \"resource\": \"vc\"\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
);
}
}
}