diff options
| author | rtkay123 <dev@kanjala.com> | 2026-03-30 12:09:10 +0200 |
|---|---|---|
| committer | rtkay123 <dev@kanjala.com> | 2026-03-30 12:09:10 +0200 |
| commit | 1b5622e14ca3deaf2a25ee785af656779ded7a41 (patch) | |
| tree | 9c26ce03ed2f13ccffb144714b62904e25ff6fbe /lib/api-config | |
| parent | 562d4855e957bebf8d98b56e40cdd50beea54d84 (diff) | |
| download | warden-1b5622e14ca3deaf2a25ee785af656779ded7a41.tar.bz2 warden-1b5622e14ca3deaf2a25ee785af656779ded7a41.zip | |
feat(api): examples
Diffstat (limited to 'lib/api-config')
| -rw-r--r-- | lib/api-config/src/schema/create.rs | 31 | ||||
| -rw-r--r-- | lib/api-config/src/schema/mod.rs | 31 |
2 files changed, 61 insertions, 1 deletions
diff --git a/lib/api-config/src/schema/create.rs b/lib/api-config/src/schema/create.rs index 5c91f64..eef11f8 100644 --- a/lib/api-config/src/schema/create.rs +++ b/lib/api-config/src/schema/create.rs @@ -3,13 +3,42 @@ use serde::{Deserialize, Serialize}; #[derive(Deserialize, Serialize)] #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] /// Transaction to monitor +#[cfg_attr(feature = "utoipa", schema(example = json!({ + "type": "custom.schema", + "version": "1.0.0", + "json_schema": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "FinancialTransaction", + "type": "object", + "required": ["transaction_id", "amount", "currency", "timestamp"], + "properties": { + "transaction_id": { + "type": "string", + "format": "uuid" + }, + "amount": { + "type": "number", + "exclusiveMinimum": 0 + }, + "currency": { + "type": "string", + "pattern": "^[A-Z]{3}$", + "description": "ISO 4217 Alpha-3 code (e.g., USD, EUR)" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + } + } +})))] pub struct CreateSchema { #[serde(rename = "type")] /// Transaction schema type pub kind: String, /// The schema's version pub version: String, - /// Transaction data + /// The json schema to validate for each transaction of this type and version #[serde(rename = "json_schema")] pub schema: serde_json::Value, } diff --git a/lib/api-config/src/schema/mod.rs b/lib/api-config/src/schema/mod.rs index 1fdbcef..d1ef5f4 100644 --- a/lib/api-config/src/schema/mod.rs +++ b/lib/api-config/src/schema/mod.rs @@ -11,6 +11,37 @@ use crate::ConfigurationError; /// Transaction to monitor #[derive(Deserialize, Serialize)] #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] +#[cfg_attr(feature = "utoipa", schema(example = json!({ + "type": "custom.schema", + "version": "1.0.0", + "json_schema": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "FinancialTransaction", + "type": "object", + "required": ["transaction_id", "amount", "currency", "timestamp"], + "properties": { + "transaction_id": { + "type": "string", + "format": "uuid" + }, + "amount": { + "type": "number", + "exclusiveMinimum": 0 + }, + "currency": { + "type": "string", + "pattern": "^[A-Z]{3}$", + "description": "ISO 4217 Alpha-3 code (e.g., USD, EUR)" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + } + }, + "created_at": time::OffsetDateTime::now_utc().format(&time::format_description::well_known::Rfc3339).unwrap(), + "updated_at": time::OffsetDateTime::now_utc().format(&time::format_description::well_known::Rfc3339).unwrap(), +})))] pub struct TransactionSchema { #[serde(rename = "type")] /// Transaction schema type |