forked from osmlab/editor-layer-index
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.json
259 lines (259 loc) · 11.3 KB
/
schema.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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://github.com/osmlab/editor-layer-index",
"properties": {
"type": {
"type": "string",
"enum": [
"Feature"
]
},
"bbox": {
"$ref": "http://json.schemastore.org/geojson#/properties/bbox"
},
"geometry": {
"$ref": "http://json.schemastore.org/geojson#/definitions/geometry"
},
"properties": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"url",
"name"
],
"properties": {
"name": {
"description": "The name of the imagery source",
"type": "string"
},
"i18n": {
"description": "Whether the imagery name should be translated",
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"tms",
"wms",
"bing",
"scanex",
"wms_endpoint",
"wmts"
]
},
"category": {
"description": "A rough categorisation of different types of layers. See https://github.com/osmlab/editor-layer-index/blob/gh-pages/CONTRIBUTING.md#categories for a description of the individual categories.",
"type": "string",
"enum": [
"photo",
"map",
"historicmap",
"osmbasedmap",
"historicphoto",
"qa",
"elevation",
"other"
]
},
"url": {
"description": "A URL template for imagery tiles",
"type": "string"
},
"min_zoom": {
"type": "integer",
"minimum": 0,
"default": 0
},
"max_zoom": {
"type": "integer",
"minimum": 1
},
"permission_osm": {
"description": "explicit/implicit permission by the owner for use in OSM",
"type": "string",
"enum": [
"explicit",
"implicit",
"no"
]
},
"license_url": {
"description": "A URL for the license or permissions for the imagery",
"type": "string"
},
"privacy_policy_url": {
"description": "A URL for the privacy policy of the operator or false if there is no existing privacy policy for tis imagery.",
"type": ["string", "boolean"]
},
"id": {
"description": "A unique identifier for the source; used in imagery_used changeset tag",
"pattern": "^[-_.A-Za-z0-9]+$",
"type": "string"
},
"description": {
"description": "A short English-language description of the source",
"type": "string"
},
"country_code": {
"description": "The ISO 3166-1 alpha-2 two letter country code in upper case. Use ZZ for unknown or multiple.",
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"default": {
"description": "Whether this imagery should be shown in the default world-wide menu",
"type": "boolean"
},
"best": {
"description": "Whether this imagery is the best source for the region",
"type": "boolean"
},
"start_date": {
"description": "The age of the oldest imagery or data in the source, as an RFC3339 date or leading portion of one",
"type": "string",
"pattern": "^\\d\\d\\d\\d(-\\d\\d(-\\d\\d)?)?$"
},
"end_date": {
"description": "The age of the newest imagery or data in the source, as an RFC3339 date or leading portion of one",
"type": "string",
"pattern": "^\\d\\d\\d\\d(-\\d\\d(-\\d\\d)?)?$"
},
"no_tile_header": {
"description": "HTTP header to check for information if the tile is invalid",
"type": "object",
"minProperties": 1,
"maxProperties": 1,
"patternProperties": {
"^.*$": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"overlay": {
"description": "'true' if tiles are transparent and can be overlaid on another source",
"type": "boolean",
"default": "false"
},
"available_projections": {
"type": "array",
"items": {
"type": "string"
}
},
"attribution": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"text": {
"type": "string"
},
"html": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
"icon": {
"description": "A URL for an image, that can be displayed in the list of imagery layers next to the name",
"type": "string"
},
"eula": {
"description": "A link to an EULA text that has to be accepted by the user, before the imagery source is added. Can contain {lang} to be replaced by a current user language wiki code (like FR:) or an empty string for the default English text.",
"type": "string"
},
"logo-image": {
"description": "A URL for an image, that is displayed in the mapview for attribution",
"type": "string"
},
"terms-of-use-text": {
"description": "Customized text for the terms of use link (default is \"Background Terms of Use\")",
"type": "string"
},
"no-tile-checksum": {
"description": "Specify a checksum for tiles, which aren't real tiles. `type` is the digest type and can be MD5, SHA-1, SHA-256, SHA-384 and SHA-512, value is the hex encoded checksum in lower case. To create a checksum save the tile as file and upload it to e.g. https://defuse.ca/checksums.htm.",
"type": "string"
},
"metadata-header": {
"description": "header-name attribute specifies a header returned by tile server, that will be shown as `metadata-key` attribute in Show Tile Info dialog",
"type": "string"
},
"valid-georeference": {
"description": "Set to `true` if imagery source is properly aligned and does not need imagery offset adjustments. This is used for OSM based sources too.",
"type": "boolean"
},
"tile-size": {
"description": "Size of individual tiles delivered by a TMS service",
"type": "integer",
"default": 256
},
"mod-tile-features": {
"description": "Whether tiles status can be accessed by appending /status to the tile URL and can be submitted for re-rendering by appending /dirty.",
"type": "string"
},
"custom-http-headers": {
"description": "HTTP headers to be sent to server. It has two attributes header-name and header-value. May be specified multiple times.",
"type": "object",
"properties": {
"header-name": {
"type": "string"
},
"header-value": {
"type": "string"
}
},
"additionalProperties": false
},
"default-layers": {
"description": "Default layer to open (when using WMS_ENDPOINT type). Contains list of layer tag with two attributes - name and style, e.g. `\"default-layers\": [\"layer\": { name=\"Basisdata_NP_Basiskart_JanMayen_WMTS_25829\" \"style\":\"default\" } ]` (not allowed in `mirror` attribute)",
"type": "array",
"items": {
"type": "object",
"properties": {
"layer" : {
"type": "object",
"properties": {
"layer-name": {
"type": "string"
},
"layer-style": {
"type": "string"
}
}
}
}
}
},
"format": {
"description": "format to use when connecting tile server (when using WMS_ENDPOINT type)",
"type": "string"
},
"transparent": {
"description": "If `true` transparent tiles will be requested from WMS server",
"type": "boolean",
"default": "false"
},
"minimum-tile-expire": {
"description": "minimum expiry time for tiles in seconds. The larger the value, the longer entry in cache will be considered valid",
"type": "integer"
}
}
}
}
}