awp-types 0.8.1

Shared protocol types for the Agentic Web Protocol (AWP)
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

use serde::{Deserialize, Serialize};

/// JSON-LD capability manifest describing what a site offers to agents.
///
/// The `@context` field is always `"https://schema.org"` and `@type` is `"WebAPI"`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct CapabilityManifest {
    #[serde(rename = "@context")]
    pub context: String,
    #[serde(rename = "@type")]
    pub type_: String,
    pub name: String,
    pub description: String,
    pub capabilities: Vec<CapabilityEntry>,
}

/// A single capability entry within a [`CapabilityManifest`].
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CapabilityEntry {
    pub name: String,
    pub description: String,
    pub endpoint: String,
    pub method: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub input_schema: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub output_schema: Option<String>,
}

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

    #[test]
    fn test_serde_round_trip() {
        let manifest = CapabilityManifest {
            context: "https://schema.org".to_string(),
            type_: "WebAPI".to_string(),
            name: "Test API".to_string(),
            description: "A test API".to_string(),
            capabilities: vec![CapabilityEntry {
                name: "get_data".to_string(),
                description: "Get data".to_string(),
                endpoint: "/api/data".to_string(),
                method: "GET".to_string(),
                input_schema: None,
                output_schema: Some("DataResponse".to_string()),
            }],
        };
        let json = serde_json::to_string(&manifest).unwrap();
        let deserialized: CapabilityManifest = serde_json::from_str(&json).unwrap();
        assert_eq!(manifest, deserialized);
    }

    #[test]
    fn test_json_ld_fields() {
        let manifest = CapabilityManifest {
            context: "https://schema.org".to_string(),
            type_: "WebAPI".to_string(),
            name: "Test".to_string(),
            description: "Test".to_string(),
            capabilities: vec![],
        };
        let json = serde_json::to_string(&manifest).unwrap();
        assert!(json.contains("\"@context\""));
        assert!(json.contains("\"@type\""));
    }

    #[test]
    fn test_optional_fields_skipped() {
        let entry = CapabilityEntry {
            name: "test".to_string(),
            description: "test".to_string(),
            endpoint: "/test".to_string(),
            method: "GET".to_string(),
            input_schema: None,
            output_schema: None,
        };
        let json = serde_json::to_string(&entry).unwrap();
        assert!(!json.contains("inputSchema"));
        assert!(!json.contains("outputSchema"));
    }
}