-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
tileset.json
652 lines (652 loc) · 29.2 KB
/
tileset.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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
{
"swagger": "2.0",
"info": {
"title": "Azure Maps Tileset Service",
"version": "2023-03-01-preview",
"description": "APIs for managing Tilesets."
},
"x-ms-parameterized-host": {
"hostTemplate": "{geography}.atlas.microsoft.com",
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation"
}
]
},
"schemes": [
"https"
],
"consumes": [],
"produces": [
"application/json"
],
"securityDefinitions": {
"AADToken": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "These are the [Azure Active Directory OAuth2](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
"scopes": {
"https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default"
}
},
"SharedKey": {
"type": "apiKey",
"description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.",
"name": "subscription-key",
"in": "query"
},
"SasToken": {
"type": "apiKey",
"description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.",
"name": "SAS Token",
"in": "header"
}
},
"security": [
{
"AADToken": [
"https://atlas.microsoft.com/.default"
]
},
{
"SharedKey": []
},
{
"SasToken": []
}
],
"responses": {},
"parameters": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
"in": "query",
"required": true,
"x-ms-parameter-location": "client"
},
"DatasetIdQuery": {
"name": "datasetId",
"description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](/rest/api/maps-creator/dataset/create) call.",
"type": "string",
"in": "query",
"required": true,
"x-ms-parameter-location": "method"
},
"TilesetId": {
"name": "tilesetId",
"description": "The Tileset Id",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"DescriptionTileset": {
"name": "description",
"description": "User provided description of the tileset. Maximum length 1024 characters.",
"type": "string",
"in": "query",
"x-ms-parameter-location": "method"
},
"TilesetOperationId": {
"name": "operationId",
"type": "string",
"in": "path",
"description": "The ID to query the status for the tileset create/import request.",
"required": true,
"x-ms-parameter-location": "method"
}
},
"paths": {
"/tilesets": {
"post": {
"summary": "Use to create a tileset.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n The `Create` API is an HTTP `POST` request used to create a tileset from the specified dataset. For more information, see [Create a tileset](/azure/azure-maps/tutorial-creator-indoor-maps#create-a-tileset). A tileset contains a set of tiles that can be consumed using [Get Map Tile](/rest/api/maps/render/get-map-tile) to retrieve custom tiles. To create a dataset, use [Dataset Create](/rest/api/maps-creator/dataset/create). For an introduction to concepts and tools that apply to Azure Maps Creator, see [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps)..\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).",
"operationId": "Tileset_Create",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"Create Tileset by providing a Dataset Id": {
"$ref": "./examples/tileset/Tileset_Create.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/DatasetIdQuery"
},
{
"$ref": "#/parameters/DescriptionTileset"
},
{
"name": "TilesetConfiguration",
"in": "body",
"description": "The custom tileset configuration to use.",
"required": false,
"schema": {
"$ref": "#/definitions/TilesetConfiguration"
}
}
],
"responses": {
"202": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2"
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"get": {
"summary": "Use to get a list of tilesets.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List Request\n\nThe `List` API is an HTTP `GET` request used to fetch a list of all existing tilesets.",
"operationId": "Tileset_List",
"x-ms-examples": {
"Get a list of all tilesets": {
"$ref": "./examples/tileset/Tileset_List.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
}
],
"x-ms-pageable": {
"itemName": "tilesets",
"nextLinkName": "nextLink"
},
"responses": {
"200": {
"description": "List tileset request completed successfully. The response body contains a list of all tilesets.",
"schema": {
"$ref": "#/definitions/TilesetListResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/tilesets/{tilesetId}": {
"get": {
"summary": "Use to get the details of a tileset.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request used to fetch the details of a tileset.",
"operationId": "Tileset_Get",
"x-ms-examples": {
"Gets the details for a single tileset": {
"$ref": "./examples/tileset/Tileset_Get.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TilesetId"
}
],
"responses": {
"200": {
"description": "List tileset request completed successfully. The response body contains a list of all tilesets.",
"schema": {
"$ref": "#/definitions/Tileset"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"delete": {
"summary": "Use to delete a tileset.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete the specified tileset, where the path will contain the `tilesetId` of the tileset to delete.\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.<br> \n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n<br>\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```",
"operationId": "Tileset_Delete",
"x-ms-examples": {
"Delete a created tileset": {
"$ref": "./examples/tileset/Tileset_Delete.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TilesetId"
}
],
"responses": {
"204": {
"description": "Tileset delete request completed successfully."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/tilesets:fetchConfiguration": {
"get": {
"summary": "Use to get a tileset configuration.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Tileset `Get Configuration` request allows the caller to get a [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) based on the dataset provided. The tileset configuration can then be used to create a custom tileset using [Tileset Create](/rest/api/maps-creator/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. For more information on concepts and tools that apply to Azure Maps Creator, see [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps).\n\n### Submit Get Configuration Request\n\n The `Get Configuration` API is an HTTP `GET` request is used to get a tileset configuration based on the `datasetId.",
"operationId": "Tileset_GetConfiguration",
"x-ms-examples": {
"Gets the tileset configuration for a given dataset": {
"$ref": "./examples/tileset/Tileset_GetConfiguration.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/DatasetIdQuery"
}
],
"responses": {
"200": {
"description": "Get tileset configuration request completed successfully. The response body contains a default [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) generated for the given dataset.",
"schema": {
"$ref": "#/definitions/TilesetConfiguration"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/tilesets:validateConfiguration": {
"post": {
"summary": "Use to validate a tileset configuration.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Validate Configuration Request\n\nThe `Validate Configuration` API is an HTTP `POST` request used to validate the specified [tileset configuration](/rest/api/maps-creator/tileset/validate-configuration#tilesetconfiguration) based on the provided `datasetId`.",
"operationId": "Tileset_ValidateConfiguration",
"x-ms-examples": {
"Validates the correctness of a tileset configuration": {
"$ref": "./examples/tileset/Tileset_ValidateConfiguration.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/DatasetIdQuery"
},
{
"name": "TilesetConfiguration",
"in": "body",
"description": "The custom tileset configuration to use.",
"required": false,
"schema": {
"$ref": "#/definitions/TilesetConfiguration"
}
}
],
"responses": {
"200": {
"description": "Validate tileset configuration request completed successfully. The response body contains the validation results.",
"schema": {
"$ref": "#/definitions/TilesetConfigurationValidationResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/tilesets/operations/{operationId}": {
"get": {
"summary": "Use to get the status of a tileset creation.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request is used to check the status of the tileset creation process and retrieve the `tilesetId` value. The path is obtained from a call to [Tileset - Create](/rest/api/maps-creator/tilesets/create). While in progress, an HTTP 200 is returned with no extra headers. Once successfully completed an HTTP 200 is returned with a `Resource-Location` header. For more information, see [Check the status of tileset creation](/azure/azure-maps/tutorial-creator-indoor-maps#check-the-status-of-tileset-creation).",
"operationId": "Tileset_GetOperation",
"x-ms-examples": {
"Get the status of an operation which is still running": {
"$ref": "./examples/tileset/Tileset_GetOperationStillRunning.json"
},
"Get the status of an operation which has finished successfully": {
"$ref": "./examples/tileset/Tileset_GetOperation.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TilesetOperationId"
}
],
"responses": {
"200": {
"description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.",
"schema": {
"$ref": "./tileset.json#/definitions/LongRunningOperationResult"
},
"headers": {
"Resource-Location": {
"type": "string",
"description": "If successful, a URI where details on the newly created resource can be found."
}
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
}
},
"definitions": {
"LongRunningOperationResult": {
"description": "The response model for a Long-Running Operations API.",
"type": "object",
"properties": {
"operationId": {
"description": "The Id for this long-running operation.",
"type": "string"
},
"status": {
"description": "The status state of the request.",
"type": "string",
"enum": [
"NotStarted",
"Running",
"Failed",
"Succeeded"
],
"x-ms-enum": {
"name": "LroStatus",
"modelAsString": true,
"values": [
{
"value": "NotStarted",
"description": "The request has not started processing yet."
},
{
"value": "Running",
"description": "The request has started processing."
},
{
"value": "Failed",
"description": "The request has one or more failures."
},
{
"value": "Succeeded",
"description": "The request has successfully completed."
}
]
},
"readOnly": true
},
"created": {
"description": "The created timestamp.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"error": {
"$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail"
},
"warning": {
"$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail"
}
}
},
"TilesetListResult": {
"description": "The response model for the Tileset List API. Returns a list of all tilesets.",
"type": "object",
"properties": {
"tilesets": {
"description": "A list of all tilesets.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Tileset"
}
},
"nextLink": {
"description": "If present, the location of the next page of data.",
"type": "string",
"readOnly": true
}
}
},
"Tileset": {
"description": "Detail information for the data.",
"type": "object",
"properties": {
"tilesetId": {
"description": "The unique tileset id for the tileset.",
"type": "string",
"readOnly": true
},
"ontology": {
"$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology"
},
"datasetId": {
"description": "The unique dataset Id used to create the tileset.",
"type": "string",
"readOnly": true
},
"description": {
"description": "The description the caller provided when creating the tileset. Maximum length 1024 characters.",
"type": "string",
"readOnly": true
},
"minZoom": {
"description": "The lowest tile zoom level tile generated for the tileset.",
"type": "integer",
"format": "int32",
"readOnly": true
},
"maxZoom": {
"description": "The highest tile zoom level tile generated for the tileset.",
"type": "integer",
"format": "int32",
"readOnly": true
},
"bbox": {
"description": "Bounding box which all features of the tileset lay within. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'.",
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BoundingBox"
},
"tilesetConfiguration": {
"description": "Tileset configuration which is used to build the tileset.",
"$ref": "#/definitions/TilesetConfiguration"
},
"defaultMapConfigurationId": {
"description": "The default generated map configuration id for the tileset",
"type": "string",
"readOnly": true
}
}
},
"TilesetConfiguration": {
"description": "Tileset configuration top-level fields. A tileset configuration is a JSON object that must contain the following top-level fields:",
"type": "object",
"required": [
"version",
"layers"
],
"properties": {
"version": {
"description": "The version of Azure Maps Tiling service configuration reference that the tileset configuration uses. Currently only version 1 is allowed. Using any version other the current version or a previous version will result in an error.",
"type": "integer",
"format": "int32"
},
"layers": {
"description": "The names of the layers and their configuration options. The configuration layers object contains key-value pairs associating the names of tile layers with their configuration. For each key-value pair, the key is the name of the layer, and the value is a LayerObject containing the configuration and options for the layer. Each layer must have a name. This is the unique identifier for the layer of data in your final tileset. In any tileset, each layer name must be unique. The layer name must be a string with only underscores (_) and alphanumeric characters. The corresponding LayerObject for each layer name describes how that vector tile layer should be created. It specifies which feature classes to retrieve feature data, the precision of the data through zoom levels, and how to transform features and render them into tiles.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LayerObject"
}
}
}
},
"LayerObject": {
"description": "Layer object for tileset configuration.",
"type": "object",
"required": [
"features",
"minZoom",
"maxZoom"
],
"properties": {
"features": {
"description": "Specifies the feature classes and filters.",
"$ref": "#/definitions/Feature"
},
"minZoom": {
"description": "The lowest zoom level for the layer to build.",
"type": "integer",
"format": "int32"
},
"maxZoom": {
"description": "The highest zoom level for the layer to build.",
"type": "integer",
"format": "int32"
}
}
},
"Feature": {
"description": "Feature configuration for tileset configuration.",
"type": "object",
"required": [
"featureClasses"
],
"properties": {
"featureClasses": {
"description": "The list of feature classes that will be used to build the layer. The valid feature classes can be found in its ontology definition. For example, [Facility Ontology](/azure/azure-maps/creator-facility-ontology)",
"type": "array",
"items": {
"type": "string"
}
},
"filter": {
"description": "Removes features that do not match a pattern. Refer to [MapLibre filter expression](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#filter)",
"type": "object"
}
}
},
"TilesetConfigurationValidationResult": {
"description": "Tileset configuration validation result.",
"type": "object",
"properties": {
"valid": {
"description": "Validation result.",
"type": "boolean"
},
"warnings": {
"description": "The list of validation warnings.",
"type": "array",
"items": {
"$ref": "#/definitions/ValidationWarning"
}
},
"errors": {
"description": "The list of validation errors.",
"type": "array",
"items": {
"$ref": "#/definitions/ValidationError"
}
}
}
},
"ValidationError": {
"description": "Tileset configuration validation errors.",
"type": "object",
"properties": {
"code": {
"description": "Validation error code.",
"$ref": "#/definitions/TilesetConfigurationErrorCode"
},
"message": {
"description": "Validation error message.",
"type": "string"
},
"target": {
"description": "The target element for the validation error.",
"type": "string"
}
}
},
"ValidationWarning": {
"description": "Tileset configuration validation errors.",
"type": "object",
"properties": {
"code": {
"description": "Validation warning code.",
"type": "string"
},
"message": {
"description": "Validation warning message.",
"type": "string"
},
"target": {
"description": "The target element for the validation warning.",
"type": "string"
}
}
},
"TilesetConfigurationErrorCode": {
"description": "The possible error code for tileset configuration validation request.",
"type": "string",
"enum": [
"DuplicateLayerNameFound",
"UndefinedFeatureClasses",
"DuplicateFeatureClassFound",
"CustomLayerNameNotSupported",
"CustomOntologyNotSupported"
],
"x-ms-enum": {
"name": "ErrorCode",
"modelAsString": true,
"values": [
{
"value": "DuplicateLayerNameFound",
"description": "The layer name should be unique."
},
{
"value": "UndefinedFeatureClasses",
"description": "Feature class should be defined in ontology definition, and the feature class name is case sensitive."
},
{
"value": "DuplicateFeatureClassFound",
"description": "Feature class name should be unique."
},
{
"value": "CustomLayerNameNotSupported",
"description": "Custom layer name is not supported right now."
},
{
"value": "CustomOntologyNotSupported",
"description": "Custom ontology is not supported right now, 'Facility-2.0' is the supported ontology."
}
]
}
}
}
}