torn-api-codegen 0.8.1

Contains the v2 torn API model descriptions and codegen for the bindings
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

use std::borrow::Cow;

use indexmap::IndexMap;
use serde::Deserialize;

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(untagged)]
pub enum OpenApiVariants<'a> {
    Int(Vec<i32>),
    #[serde(borrow)]
    Str(Vec<&'a str>),
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OpenApiType<'a> {
    #[serde(default)]
    pub deprecated: bool,
    pub description: Option<Cow<'a, str>>,

    pub r#type: Option<&'a str>,
    pub format: Option<&'a str>,

    #[serde(rename = "$ref")]
    pub ref_path: Option<&'a str>,

    pub one_of: Option<Vec<OpenApiType<'a>>>,
    pub all_of: Option<Vec<OpenApiType<'a>>>,

    pub required: Option<Vec<&'a str>>,
    #[serde(borrow)]
    pub properties: Option<IndexMap<&'a str, OpenApiType<'a>>>,

    pub items: Option<Box<OpenApiType<'a>>>,
    pub r#enum: Option<OpenApiVariants<'a>>,
}

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

    #[test]
    fn object() {
        let json = r##"
            {
                "required": [
                    "name",
                    "branches"
                ],
                "properties": {
                    "name": {
                        "type": "string"
                    },
                    "branches": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/TornFactionTreeBranch"
                        }
                    }
                },
                "type": "object"
            }
        "##;

        let obj: OpenApiType = serde_json::from_str(json).unwrap();

        assert_eq!(obj.r#type, Some("object"));

        let props = obj.properties.unwrap();

        assert!(props.contains_key("name"));

        let branches = props.get("branches").unwrap();
        assert_eq!(branches.r#type, Some("array"));

        let items = branches.items.as_ref().unwrap();
        assert!(items.ref_path.is_some());
    }

    #[test]
    fn enum_variants() {
        let int_json = r#"
            [1, 2, 3, 4]
        "#;

        let de: OpenApiVariants = serde_json::from_str(int_json).unwrap();

        assert_eq!(de, OpenApiVariants::Int(vec![1, 2, 3, 4]));

        let str_json = r#"
            ["foo", "bar", "baz"]
        "#;

        let de: OpenApiVariants = serde_json::from_str(str_json).unwrap();

        assert_eq!(de, OpenApiVariants::Str(vec!["foo", "bar", "baz"]));
    }
}