gomcapi/requests.go at master · materials-commons/gomcapi · GitHub

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
package mcapi

var DatasetLicenseOpenDataset = "Open Database License (ODC-ODbL)"
var DatasetLicenseAttribution = "Attribution License (ODC-By)"
var DatasetLicensePublicDomain = "Public Domain Dedication and License (PDDL)"

type DepositDatasetRequest struct {
	Files    []DatasetFileUpload `json:"files"`
	Metadata DatasetMetadata     `json:"metadata"`
}

type DatasetFileUpload struct {
	Description string `json:"description"`
	File        string `json:"file"`
	Directory   string `json:"directory"`
}

type DatasetMetadata struct {
	Name        string      `json:"name"`
	Description string      `json:"description"`
	Summary     string      `json:"summary"`
	License     string      `json:"license"`
	Funding     string      `json:"funding"`
	Communities []int       `json:"communities"`
	Authors     []Author    `json:"authors"`
	Tags        []Tag       `json:"tags"`
	DOI         string      `json:"doi"`
	Papers      []Paper     `json:"papers"`
	Attributes  []Attribute `json:"attributes"`
}

type Paper struct {
	Name      string `json:"name"`
	Reference string `json:"reference"`
	DOI       string `json:"doi"`
	URL       string `json:"url"`
}

type DatasetFileSelection struct {
	IncludeFiles []string `json:"include_files"`
	ExcludeFiles []string `json:"exclude_files"`
	IncludeDirs  []string `json:"include_dirs"`
	ExcludeDirs  []string `json:"exclude_dirs"`
}

type CreateOrUpdateDatasetRequest struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Summary     string   `json:"summary"`
	License     string   `json:"license"`
	Funding     string   `json:"funding"`
	Experiments []int    `json:"experiments"`
	Communities []int    `json:"communities"`
	Tags        []Tag    `json:"tags"`
	Authors     []Author `json:"ds_authors"`
}

type Tag struct {
	Value string `json:"value"`
}

type Author struct {
	Name         string `json:"name"`
	Email        string `json:"email"`
	Affiliations string `json:"affiliations"`
}

type CreateProjectRequest struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Summary     string `json:"summary"`
}

type CreateExperimentRequest struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Summary     string `json:"summary"`
	ProjectID   int    `json:"project_id"`
}

type CreateActivityRequest struct {
	Name         string      `json:"name"`
	Description  string      `json:"description"`
	ProjectID    int         `json:"project_id"`
	ExperimentID int         `json:"experiment_id"`
	Attributes   []Attribute `json:"attributes"`
}

type CreateEntityRequest struct {
	Name         string      `json:"name"`
	Category     string      `json:"category"`
	Description  string      `json:"description"`
	Summary      string      `json:"summary"`
	ExperimentID int         `json:"experiment_id"`
	ProjectID    int         `json:"project_id"`
	ActivityID   int         `json:"activity_id"`
	Attributes   []Attribute `json:"attributes"`
}

type Attribute struct {
	Name  string `json:"name"`
	Value any    `json:"value"`
	Unit  string `json:"unit"`
}

type CreateEntityStateRequest struct {
	Current    bool        `json:"current"`
	Attributes []Attribute `json:"attributes"`
}