oas-document 1.1.1

OAS Identity Document types and validation for the Open Agent Specification
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

// OAS Spec §5.8 — Entity Profile
//! Profile section for OAS Identity Documents.
//!
//! The profile section provides the "business card" presentation layer
//! for any OAS entity — avatar, tagline, categories, languages, timezone.

use serde::{Deserialize, Serialize};

/// Profile section of an OAS Identity Document.
///
/// Provides human-readable presentation data for the entity.
/// All fields are optional — entities expose only what they choose to.
///
/// # Examples
///
/// ```
/// use oas_document::profile::ProfileSection;
///
/// let profile = ProfileSection {
///     avatar_url: Some("https://cdn.example.com/agent-42/avatar.png".to_string()),
///     banner_url: None,
///     tagline: Some("AI-powered financial analysis agent".to_string()),
///     categories: vec!["finance".to_string(), "analytics".to_string()],
///     languages: vec!["en".to_string(), "es".to_string()],
///     timezone: Some("America/New_York".to_string()),
///     accent_color: Some("#3B82F6".to_string()),
/// };
/// assert_eq!(profile.languages.len(), 2);
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ProfileSection {
    /// URL to the entity's avatar image.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub avatar_url: Option<String>,

    /// URL to the entity's banner/header image.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub banner_url: Option<String>,

    /// Short tagline or bio (max 280 chars, like a tweet).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tagline: Option<String>,

    /// Category tags for discovery (e.g., "finance", "customer-support", "research").
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub categories: Vec<String>,

    /// Supported languages as ISO 639-1 codes (e.g., "en", "es", "zh").
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub languages: Vec<String>,

    /// IANA timezone identifier (e.g., "America/New_York", "UTC").
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,

    /// Accent/brand color as hex (e.g., "#3B82F6").
    #[serde(skip_serializing_if = "Option::is_none")]
    pub accent_color: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn serde_round_trip() {
        let profile = ProfileSection {
            avatar_url: Some("https://example.com/avatar.png".to_string()),
            banner_url: None,
            tagline: Some("Test agent".to_string()),
            categories: vec!["test".to_string()],
            languages: vec!["en".to_string()],
            timezone: Some("UTC".to_string()),
            accent_color: None,
        };
        let json = serde_json::to_string(&profile).unwrap_or_default();
        let parsed: ProfileSection =
            serde_json::from_str(&json).unwrap_or_else(|_| profile.clone());
        assert_eq!(profile, parsed);
    }

    #[test]
    fn minimal_profile_deserializes() {
        let json = r#"{"tagline":"Hello"}"#;
        let profile: Result<ProfileSection, _> = serde_json::from_str(json);
        assert!(profile.is_ok());
        let profile = profile.unwrap_or_else(|_| ProfileSection {
            avatar_url: None,
            banner_url: None,
            tagline: None,
            categories: vec![],
            languages: vec![],
            timezone: None,
            accent_color: None,
        });
        assert_eq!(profile.tagline.as_deref(), Some("Hello"));
        assert!(profile.categories.is_empty());
    }

    #[test]
    fn empty_vecs_omitted_in_serialization() {
        let profile = ProfileSection {
            avatar_url: None,
            banner_url: None,
            tagline: Some("Minimal".to_string()),
            categories: vec![],
            languages: vec![],
            timezone: None,
            accent_color: None,
        };
        let json = serde_json::to_string(&profile).unwrap_or_default();
        assert!(!json.contains("categories"));
        assert!(!json.contains("languages"));
    }
}