This repository has been archived by the owner on Dec 20, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
/
repoelement.json
121 lines (109 loc) · 5.19 KB
/
repoelement.json
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
117
118
119
120
121
{
"additionalProperties": false,
"javaType": "es.eucm.ead.schema.editor.components.repo.RepoElement",
"extends": {
"$ref": "../../../engine/components/component.json"
},
"properties": {
"entityRef":{
"type":"string",
"description":"Number provided by the backend that uniquely identifies each element. Should only filled by the backend."
},
"thumbnailUrl":{
"type":"string",
"description":"Absolute url pointing to the thumbnail that better suits the client for this element. This information should be added at runtime by the backend, who knows how to retrieve binary files associated to a given element, taking into account the width and height provided by the client in the request, if present."
},
"contentsUrl":{
"type":"string",
"description": "Absolute url pointing to the zip with the contents of the element. Should be filled in by the backend when building a response, who knows how to store and retrieve binary files for elements."
},
"contentsSize":{
"type": "number",
"description": "Size of the contents.zip file, in Megabytes. Should be filled in by the backend when building a response"
},
"authorName":{
"type":"string",
"description":"The name of the person or organizations that created the resource. For crediting and licensing."
},
"authorUrl":{
"type":"string",
"description":"URL associated to the author of the resource. Can be used for author recognition"
},
"publisher":{
"type":"string",
"description":"Organization that published the element (e.g. mokap, freepik, openclipart)"
},
"libraryId":{
"type":"string",
"description":"Id of the library this element belongs to. Useful to retrieve similar items."
},
"version":{
"type":"string",
"description":"An integer value that determines the version, generated from date: YYYYMMDDHH (e.g. 2014092713)."
},
"licenseName":{
"type":"string",
"description":"String value representing the name of the license that applies to this element. Can either be one of the default common open licenses specified in {@link es.eucm.ead.schema.editor.components.repo.licenses.DefaultLicenses}, or a custom name. If a default license (eg. cc-by) is used, fields {@link #licensePrice} and {@link #licenseTerms} do not apply and should not be filled in."
},
"licensePrice":{
"type":"string",
"description":"Float value representing the fee the customer has to pay for the item. Only applies if a custom license is used"
},
"licenseTerms":{
"type":"string",
"description":"String representing the legal text associated to the license. Only applies if a custom license is used."
},
"width":{
"type":"number",
"description":"Float value representing the width of the element on screen"
},
"height":{
"type":"number",
"description":"Float value representing the height of the element on screen"
},
"categoryList":{
"type":"array",
"items":{
"$ref":"repocategories.json"
},
"description":"An array with the categories this element should be listed on."
},
"tagList":{
"type":"array",
"items":{
"type":"string"
},
"description":"A list of tags. Useful for searching"
},
"descriptionList":{
"type":"array",
"items":{
"type":"string"
},
"description":"List with descriptions (Strings). Each description is a brief description of the resource, including what kind of contents it has, and how many (e.g. number of animations, frames, etc.), in a different language. The language of each description is specified in param {@link #descriptionI18nList}."
},
"descriptionI18nList":{
"type":"array",
"items":{
"type":"string"
},
"description":"List with language codes (Strings) for the descriptions defined in {@link #descriptionList}. Example: [es_ES,en_EN] indicates that the first element in descriptionList is in Spanish, while the second is in English."
},
"nameList":{
"type":"array",
"items":{
"type":"string"
},
"description":"List with names (Strings). Each name is provided in a different language. The language of each name is specified in param {@link #nameI18nList}."
},
"nameI18nList":{
"type":"array",
"items":{
"type":"string"
},
"description":"List with language codes (Strings) for the names defined in {@link #nameList}. "
}
},
"type": "object",
"description": "A simple editor component for elements that are meant to be shared and reused through the repository."
}