minecraft_registry_api 1.1.0

Typed API clients for Minecraft modding platforms — Modrinth, Mojang, Paper, Purpur, Fabric, Forge, NeoForge
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

use serde::Deserialize;

#[derive(Debug)]
pub struct ProjectQuery<'a> {
    pub project: &'a str,
}

#[derive(Debug)]
pub struct BuildQuery<'a> {
    pub project: &'a str,
    pub version: &'a str,
    pub build: i64,
}

#[derive(Debug)]
pub struct BuildDownload<'a> {
    pub project: &'a str,
    pub version: &'a str,
    pub build: i64,
}

#[derive(Debug, Deserialize)]
pub struct PaperProject {
    pub project_id: String,
    pub project_name: String,
    pub version_groups: Vec<String>,
    pub versions: Vec<String>,
}

#[derive(Debug, Deserialize)]
pub struct PaperBuild {
    pub project_id: String,
    pub project_name: String,
    pub version: String,
    pub build: i64,
    pub time: String,
    pub channel: String,
    pub promoted: bool,
    pub changes: Vec<Change>,
    pub downloads: Downloads,
}

#[derive(Debug, Deserialize)]
pub struct Change {
    pub commit: String,
    pub summary: String,
    pub message: String,
}

#[derive(Debug, Deserialize)]
pub struct Downloads {
    pub application: Application,
}

#[derive(Debug, Deserialize)]
pub struct Application {
    pub name: String,
    pub sha256: String,
}

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

    #[test]
    fn test_paper_project_deserialize() {
        let json = serde_json::json!({
            "project_id": "paper",
            "project_name": "Paper",
            "version_groups": ["1.21"],
            "versions": ["1.21.4"]
        });
        let p: PaperProject = serde_json::from_value(json).unwrap();
        assert_eq!(p.project_id, "paper");
    }

    #[test]
    fn test_paper_build_deserialize() {
        let json = serde_json::json!({
            "project_id": "paper",
            "project_name": "Paper",
            "version": "1.21.4",
            "build": 123,
            "time": "2024-12-03T13:00:00Z",
            "channel": "default",
            "promoted": true,
            "changes": [{
                "commit": "abc123",
                "summary": "Fix bug",
                "message": "Fix a critical bug"
            }],
            "downloads": {
                "application": {
                    "name": "paper-1.21.4-123.jar",
                    "sha256": "deadbeef"
                }
            }
        });
        let b: PaperBuild = serde_json::from_value(json).unwrap();
        assert_eq!(b.build, 123);
        assert!(b.promoted);
        assert_eq!(b.downloads.application.name, "paper-1.21.4-123.jar");
        assert_eq!(b.changes[0].commit, "abc123");
    }
}