-
Notifications
You must be signed in to change notification settings - Fork 0
/
pdok.nl_ogcapis.yaml
3303 lines (3291 loc) · 222 KB
/
pdok.nl_ogcapis.yaml
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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.14.0
name: ogcapis.pdok.nl
spec:
group: pdok.nl
names:
kind: OGCAPI
listKind: OGCAPIList
plural: ogcapis
singular: ogcapi
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: OGCAPI is the Schema for the ogcapis API
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: |-
OGCAPISpec defines the desired state of OGCAPI
^^ unknown fields are allowed (but ignored and not maintained when marshalling) for backwards compatibility
properties:
podSpecPatch:
description: Optional strategic merge patch for the pod in the deployment.
E.g. to patch the resources or add extra env vars.
type: object
x-kubernetes-preserve-unknown-fields: true
service:
properties:
abstract:
description: Human friendly description of the API and dataset.
type: string
availableLanguages:
description: The languages/translations to offer, valid options
are Dutch (nl) and English (en). Dutch is the default.
items:
type: string
type: array
baseUrl:
description: The base URL - that's the part until the OGC API
landing page - under which this API is served
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
collectionOrder:
description: |-
Order in which collections (containing features, tiles, 3d tiles, etc.) should be returned.
When not specified collections are returned in alphabetic order.
items:
type: string
type: array
datasetCatalogUrl:
description: Optional reference to a catalog/portal/registry that
lists all datasets, not just this one
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
datasetDetails:
description: Key/value pairs to add extra information to the landing
page
items:
properties:
name:
description: Arbitrary name to add extra information to
the landing page
type: string
value:
description: Arbitrary value associated with the given name
type: string
required:
- name
- value
type: object
type: array
keywords:
description: Keywords to make this API beter discoverable
items:
type: string
type: array
lastUpdated:
description: Moment in time when the dataset was last updated
format: date-time
type: string
lastUpdatedBy:
description: Who updated the dataset
type: string
license:
description: Licensing term that apply to this API and dataset
properties:
name:
description: Name of the license, e.g. MIT, CC0, etc
type: string
url:
description: URL to license text on the web
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
required:
- name
- url
type: object
ogcApi:
description: Define which OGC API building blocks this API supports
properties:
3dgeovolumes:
description: Enable when this API should offer OGC API 3D
GeoVolumes. This includes OGC 3D Tiles.
properties:
collections:
description: Collections to be served as 3D GeoVolumes
items:
properties:
3dViewerUrl:
description: Optional URL to 3D viewer to visualize
the given collection of 3D Tiles.
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
datasources:
description: Optional collection specific datasources.
Mutually exclusive with top-level defined datasources.
properties:
additional:
description: |-
One or more additional datasources for features in other projections. GoKoala doesn't do
any on-the-fly reprojection so additional datasources need to be reprojected ahead of time.
items:
properties:
geopackage:
description: GeoPackage to get the features
from.
properties:
cloud:
description: Settings to read a GeoPackage
as a Cloud-Backed SQLite database
properties:
auth:
description: |-
Some kind of credential like a password or key to authenticate with the storage backend, e.g:
'Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==' when using Azurite
type: string
cache:
description: Local cache of fetched
blocks from cloud storage
properties:
maxSize:
default: 1Gb
description: Max size of the
local cache. Accepts human-readable
size such as 100Mb, 4Gb,
1Tb, etc. When omitted 1Gb
is used.
type: string
path:
description: Optional path
to directory for caching
cloud-backed GeoPackage
blocks, when omitted a temp
dir will be used.
type: string
warmUp:
default: false
description: When true a warm-up
query is executed on startup
which aims to fill the local
cache. Does increase startup
time.
type: boolean
type: object
connection:
description: |-
Reference to the cloud storage (either azure or google at the moment).
For example 'azure?emulator=127.0.0.1:10000&sas=0' or 'google'
type: string
container:
description: Container/bucket
on the storage account
type: string
externalFid:
description: |-
External feature id column name. When specified this ID column will be exposed to clients instead of the regular FID column.
It allows one to offer a more stable ID to clients instead of an auto-generated FID. External FID column should contain UUIDs.
type: string
fid:
default: fid
description: Feature id column
name
type: string
file:
description: Filename of the GeoPackage
type: string
inMemoryCacheSize:
default: -2000
description: |-
ADVANCED SETTING. Sets the SQLite "cache_size" pragma which determines how many pages are cached in-memory.
See https://sqlite.org/pragma.html#pragma_cache_size for details.
Default in SQLite is 2000 pages, which equates to 2000KiB (2048000 bytes). Which is denoted as -2000.
type: integer
logHttpRequests:
default: false
description: ADVANCED SETTING.
Only for debug purposes! When
true all HTTP requests executed
by sqlite to cloud object storage
are logged to stdout
type: boolean
maxBBoxSizeToUseWithRTree:
default: 8000
description: ADVANCED SETTING.
When the number of features
in a bbox stay within the given
value use an RTree index, otherwise
use a BTree index.
type: integer
queryTimeout:
default: 15s
description: Optional timeout
after which queries are canceled
format: duration
type: string
user:
description: Username of the storage
account, like devstoreaccount1
when using Azurite
type: string
required:
- auth
- connection
- container
- file
- user
type: object
local:
description: Settings to read a GeoPackage
from local disk
properties:
download:
description: |-
Optional initialization task to download a GeoPackage during startup. GeoPackage will be
downloaded to local disk and stored at the location specified in File.
properties:
from:
description: |-
Location of GeoPackage on remote HTTP(S) URL. GeoPackage will be downloaded to local disk
during startup and stored at the location specified in "file".
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
maxRetries:
default: 5
description: ADVANCED SETTING.
Maximum number of retries
when retrying HTTP requests
to download (part of) GeoPackage.
minimum: 1
type: integer
parallelism:
default: 4
description: |-
ADVANCED SETTING. Determines how many workers (goroutines) in parallel will download the specified GeoPackage.
Setting this to 1 will disable concurrent downloads.
minimum: 1
type: integer
retryDelay:
default: 1s
description: ADVANCED SETTING.
Minimum delay to use when
retrying HTTP request to
download (part of) GeoPackage.
format: duration
type: string
retryMaxDelay:
default: 30s
description: ADVANCED SETTING.
Maximum overall delay of
the exponential backoff
while retrying HTTP requests
to download (part of) GeoPackage.
format: duration
type: string
timeout:
default: 2m
description: ADVANCED SETTING.
HTTP request timeout when
downloading (part of) GeoPackage.
format: duration
type: string
tlsSkipVerify:
default: false
description: ADVANCED SETTING.
When true TLS certs are
NOT validated, false otherwise.
Only use true for your own
self-signed certificates!
type: boolean
required:
- from
type: object
externalFid:
description: |-
External feature id column name. When specified this ID column will be exposed to clients instead of the regular FID column.
It allows one to offer a more stable ID to clients instead of an auto-generated FID. External FID column should contain UUIDs.
type: string
fid:
default: fid
description: Feature id column
name
type: string
file:
description: |-
Location of GeoPackage on disk.
You can place the GeoPackage here manually (out-of-band) or you can specify Download
and let the application download the GeoPackage for you and store it at this location.
type: string
inMemoryCacheSize:
default: -2000
description: |-
ADVANCED SETTING. Sets the SQLite "cache_size" pragma which determines how many pages are cached in-memory.
See https://sqlite.org/pragma.html#pragma_cache_size for details.
Default in SQLite is 2000 pages, which equates to 2000KiB (2048000 bytes). Which is denoted as -2000.
type: integer
maxBBoxSizeToUseWithRTree:
default: 8000
description: ADVANCED SETTING.
When the number of features
in a bbox stay within the given
value use an RTree index, otherwise
use a BTree index.
type: integer
queryTimeout:
default: 15s
description: Optional timeout
after which queries are canceled
format: duration
type: string
required:
- file
type: object
type: object
postgis:
description: PostGIS database to get the
features from (not implemented yet).
type: object
srs:
description: Projection (SRS/CRS) used
for the features in this datasource
pattern: ^EPSG:\d+$
type: string
required:
- srs
type: object
type: array
defaultWGS84:
description: |-
Features should always be available in WGS84 (according to spec).
This specifies the datasource to be used for features in the WGS84 projection
properties:
geopackage:
description: GeoPackage to get the features
from.
properties:
cloud:
description: Settings to read a GeoPackage
as a Cloud-Backed SQLite database
properties:
auth:
description: |-
Some kind of credential like a password or key to authenticate with the storage backend, e.g:
'Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==' when using Azurite
type: string
cache:
description: Local cache of fetched
blocks from cloud storage
properties:
maxSize:
default: 1Gb
description: Max size of the
local cache. Accepts human-readable
size such as 100Mb, 4Gb, 1Tb,
etc. When omitted 1Gb is used.
type: string
path:
description: Optional path to
directory for caching cloud-backed
GeoPackage blocks, when omitted
a temp dir will be used.
type: string
warmUp:
default: false
description: When true a warm-up
query is executed on startup
which aims to fill the local
cache. Does increase startup
time.
type: boolean
type: object
connection:
description: |-
Reference to the cloud storage (either azure or google at the moment).
For example 'azure?emulator=127.0.0.1:10000&sas=0' or 'google'
type: string
container:
description: Container/bucket on
the storage account
type: string
externalFid:
description: |-
External feature id column name. When specified this ID column will be exposed to clients instead of the regular FID column.
It allows one to offer a more stable ID to clients instead of an auto-generated FID. External FID column should contain UUIDs.
type: string
fid:
default: fid
description: Feature id column name
type: string
file:
description: Filename of the GeoPackage
type: string
inMemoryCacheSize:
default: -2000
description: |-
ADVANCED SETTING. Sets the SQLite "cache_size" pragma which determines how many pages are cached in-memory.
See https://sqlite.org/pragma.html#pragma_cache_size for details.
Default in SQLite is 2000 pages, which equates to 2000KiB (2048000 bytes). Which is denoted as -2000.
type: integer
logHttpRequests:
default: false
description: ADVANCED SETTING. Only
for debug purposes! When true
all HTTP requests executed by
sqlite to cloud object storage
are logged to stdout
type: boolean
maxBBoxSizeToUseWithRTree:
default: 8000
description: ADVANCED SETTING. When
the number of features in a bbox
stay within the given value use
an RTree index, otherwise use
a BTree index.
type: integer
queryTimeout:
default: 15s
description: Optional timeout after
which queries are canceled
format: duration
type: string
user:
description: Username of the storage
account, like devstoreaccount1
when using Azurite
type: string
required:
- auth
- connection
- container
- file
- user
type: object
local:
description: Settings to read a GeoPackage
from local disk
properties:
download:
description: |-
Optional initialization task to download a GeoPackage during startup. GeoPackage will be
downloaded to local disk and stored at the location specified in File.
properties:
from:
description: |-
Location of GeoPackage on remote HTTP(S) URL. GeoPackage will be downloaded to local disk
during startup and stored at the location specified in "file".
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
maxRetries:
default: 5
description: ADVANCED SETTING.
Maximum number of retries
when retrying HTTP requests
to download (part of) GeoPackage.
minimum: 1
type: integer
parallelism:
default: 4
description: |-
ADVANCED SETTING. Determines how many workers (goroutines) in parallel will download the specified GeoPackage.
Setting this to 1 will disable concurrent downloads.
minimum: 1
type: integer
retryDelay:
default: 1s
description: ADVANCED SETTING.
Minimum delay to use when
retrying HTTP request to download
(part of) GeoPackage.
format: duration
type: string
retryMaxDelay:
default: 30s
description: ADVANCED SETTING.
Maximum overall delay of the
exponential backoff while
retrying HTTP requests to
download (part of) GeoPackage.
format: duration
type: string
timeout:
default: 2m
description: ADVANCED SETTING.
HTTP request timeout when
downloading (part of) GeoPackage.
format: duration
type: string
tlsSkipVerify:
default: false
description: ADVANCED SETTING.
When true TLS certs are NOT
validated, false otherwise.
Only use true for your own
self-signed certificates!
type: boolean
required:
- from
type: object
externalFid:
description: |-
External feature id column name. When specified this ID column will be exposed to clients instead of the regular FID column.
It allows one to offer a more stable ID to clients instead of an auto-generated FID. External FID column should contain UUIDs.
type: string
fid:
default: fid
description: Feature id column name
type: string
file:
description: |-
Location of GeoPackage on disk.
You can place the GeoPackage here manually (out-of-band) or you can specify Download
and let the application download the GeoPackage for you and store it at this location.
type: string
inMemoryCacheSize:
default: -2000
description: |-
ADVANCED SETTING. Sets the SQLite "cache_size" pragma which determines how many pages are cached in-memory.
See https://sqlite.org/pragma.html#pragma_cache_size for details.
Default in SQLite is 2000 pages, which equates to 2000KiB (2048000 bytes). Which is denoted as -2000.
type: integer
maxBBoxSizeToUseWithRTree:
default: 8000
description: ADVANCED SETTING. When
the number of features in a bbox
stay within the given value use
an RTree index, otherwise use
a BTree index.
type: integer
queryTimeout:
default: 15s
description: Optional timeout after
which queries are canceled
format: duration
type: string
required:
- file
type: object
type: object
postgis:
description: PostGIS database to get the
features from (not implemented yet).
type: object
type: object
required:
- defaultWGS84
type: object
filters:
description: Filters available for this collection
properties:
properties:
description: |-
OAF Part 1: filter on feature properties
https://docs.ogc.org/is/17-069r4/17-069r4.html#_parameters_for_filtering_on_feature_properties
items:
properties:
allowedValues:
description: Static list of allowed values
to be used as input for this property
filter. Will be enforced by OpenAPI
spec.
items:
type: string
type: array
deriveAllowedValuesFromDatasource:
default: false
description: |-
Derive list of allowed values for this property filter from the corresponding column in the datastore.
Use with caution since it can increase startup time when used on large tables. Make sure an index in present.
type: boolean
description:
default: Filter features by this property
description: Explains this property filter
type: string
indexRequired:
default: true
description: |-
When true the property/column in the feature table needs to be indexed. Initialization will fail
when no index is present, when false the index check is skipped. For large tables an index is recommended!
type: boolean
name:
description: Needs to match with a column
name in the feature table (in the configured
datasource)
type: string
required:
- name
type: object
type: array
type: object
id:
description: Unique ID of the collection
type: string
links:
description: Links pertaining to this collection
(e.g., downloads, documentation)
properties:
downloads:
description: Links to downloads of entire collection.
These will be rendered as rel=enclosure links
items:
properties:
assetUrl:
description: Full URL to the file to be
downloaded
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
mediaType:
description: Media type of the file to
be downloaded
type: string
name:
description: Name of the provided download
type: string
size:
description: Approximate size of the file
to be downloaded
type: string
required:
- assetUrl
- mediaType
- name
type: object
type: array
type: object
mapSheetDownloads:
description: |-
Downloads available for this collection through map sheets. Note that 'map sheets' refer to a map
divided in rectangle areas that can be downloaded individually.
properties:
properties:
description: |-
Properties that provide the download details per map sheet. Note that 'map sheets' refer to a map
divided in rectangle areas that can be downloaded individually.
properties:
assetUrl:
description: Property/column containing
file download URL
type: string
mapSheetId:
description: Property/column containing
the map sheet identifier
type: string
mediaType:
description: The actual media type (not
a property/column) of the download, like
application/zip.
type: string
size:
description: Property/column containing
file size
type: string
required:
- assetUrl
- mapSheetId
- mediaType
- size
type: object
required:
- properties
type: object
metadata:
description: Metadata describing the collection
contents
properties:
description:
description: Describes the content of this collection
type: string
extent:
description: Extent of the collection, both
geospatial and/or temporal
properties:
bbox:
description: Geospatial extent
items:
type: string
type: array
interval:
description: Temporal extent
items:
type: string
maxItems: 2
minItems: 2
type: array
srs:
description: Projection (SRS/CRS) to be
used. When none is provided WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)
is used.
pattern: ^EPSG:\d+$
type: string
required:
- bbox
type: object
keywords:
description: Keywords to make this collection
beter discoverable
items:
type: string
type: array
lastUpdated:
description: Moment in time when the collection
was last updated
format: date-time
type: string
lastUpdatedBy:
description: Who updated this collection
type: string
storageCrs:
default: http://www.opengis.net/def/crs/OGC/1.3/CRS84
description: |-
The CRS identifier which the features are originally stored, meaning no CRS transformations are applied when features are retrieved in this CRS.
WGS84 is the default storage CRS.
pattern: ^http:\/\/www\.opengis\.net\/def\/crs\/.*$
type: string
temporalProperties:
description: Fields in the datasource to be
used in temporal queries
properties:
endDate:
description: Name of field in datasource
to be used in temporal queries as the
end date
type: string
startDate:
description: Name of field in datasource
to be used in temporal queries as the
start date
type: string
required:
- endDate
- startDate
type: object
thumbnail:
description: |-
Reference to a PNG image to use a thumbnail on the collections.
The full path is constructed by appending Resources + Thumbnail.
type: string
title:
description: Human friendly title of this collection.
When no title is specified the collection
ID is used.
type: string
required:
- description
type: object
properties:
description: |-
Properties/fields of features in this collection. This setting controls two things:
A) allows one to exclude certain properties, when propertiesExcludeUnknown=true
B) allows one sort the properties in the given order, when propertiesInSpecificOrder=true
When not set all available properties are returned in API responses, in alphabetical order.
items:
type: string
type: array
propertiesExcludeUnknown:
default: false
description: |-
When true properties not listed under 'properties' are excluded from API responses. When false
unlisted properties are also included in API responses.
type: boolean
propertiesInSpecificOrder:
default: false
description: |-
When true properties are returned according to the ordering specified under 'properties'. When false
properties are returned in alphabetical order.
type: boolean
supportedSrs:
description: |-
Specifies in what projections (SRS/CRS) the tiles are offered
Note: Only marked as optional in CRD to support top-level OR collection-level tiles
items:
properties:
srs:
description: Projection (SRS/CRS) used
pattern: ^EPSG:\d+$
type: string
zoomLevelRange:
description: Available zoom levels
properties:
end:
description: End zoom level
type: integer
start:
description: Start zoom level
minimum: 0
type: integer
required:
- end
- start
type: object
required:
- srs
- zoomLevelRange
type: object
type: array
tableName:
description: Optional way to explicitly map a collection
ID to the underlying table in the datasource.
type: string
tileServer:
description: |-
Reference to the server (or object storage) hosting the tiles.
Note: Only marked as optional in CRD to support top-level OR collection-level tiles
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
tileServerPath:
description: Optional basepath to 3D tiles on the
tileserver. Defaults to the collection ID.
type: string
types:
description: |-
Could be 'vector' and/or 'raster' to indicate the types of tiles offered
Note: Only marked as optional in CRD to support top-level OR collection-level tiles
items:
enum:
- raster
- vector
type: string
type: array
uriTemplate3dTiles:
description: URI template for individual 3D tiles.
type: string
uriTemplateDTM:
description: URI template for digital terrain model
(DTM) in Quantized Mesh format, REQUIRED when
you want to serve a DTM.
type: string
uriTemplateImplicitTilingSubtree:
description: Optional URI template for subtrees,
only required when "implicit tiling" extension
is used.
type: string
uriTemplateTiles:
description: Optional template to the vector tiles
on the tileserver. Defaults to {tms}/{z}/{x}/{y}.pbf.
type: string
web:
description: Configuration specifically related
to HTML/Web representation
properties:
featureViewer:
description: Viewer config for displaying a
single feature on a map
properties:
maxScale:
description: |-
Minimal initial zoom level of the viewer when rendering features, specified by scale denominator
(not set by default).
type: integer
minScale:
description: |-
Maximum initial zoom level of the viewer when rendering features, specified by scale denominator.
Defaults to 1000 (= scale 1:1000).
type: integer
type: object
featuresViewer:
description: Viewer config for displaying multiple
features on a map
properties:
maxScale:
description: |-
Minimal initial zoom level of the viewer when rendering features, specified by scale denominator
(not set by default).
type: integer
minScale:
description: |-
Maximum initial zoom level of the viewer when rendering features, specified by scale denominator.
Defaults to 1000 (= scale 1:1000).
type: integer
type: object
urlAsHyperlink:
description: Whether URLs (to external resources)
in the HTML representation of features should
be rendered as hyperlinks.
type: boolean
type: object
required:
- id
type: object
type: array
tileServer:
description: Reference to the server (or object storage)
hosting the 3D Tiles
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
validateResponses:
default: true
description: |-
Whether JSON responses will be validated against the OpenAPI spec
since it has significant performance impact when dealing with large JSON payloads.
type: boolean
required:
- collections
- tileServer
type: object
features:
description: Enable when this API should offer OGC API Features.
properties:
basemap:
default: OSM
description: Basemap to use in embedded viewer on the
HTML pages.
enum:
- OSM
- BRT
type: string
collections:
description: Collections to be served as features through
this API
items:
properties:
3dViewerUrl:
description: Optional URL to 3D viewer to visualize
the given collection of 3D Tiles.
pattern: ^(https?://.+)|(\$\{.+\}.*)
type: string
datasources:
description: Optional collection specific datasources.
Mutually exclusive with top-level defined datasources.
properties:
additional:
description: |-
One or more additional datasources for features in other projections. GoKoala doesn't do
any on-the-fly reprojection so additional datasources need to be reprojected ahead of time.
items:
properties:
geopackage:
description: GeoPackage to get the features
from.
properties:
cloud:
description: Settings to read a GeoPackage
as a Cloud-Backed SQLite database
properties:
auth:
description: |-
Some kind of credential like a password or key to authenticate with the storage backend, e.g:
'Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==' when using Azurite
type: string
cache:
description: Local cache of fetched
blocks from cloud storage
properties:
maxSize:
default: 1Gb
description: Max size of the
local cache. Accepts human-readable
size such as 100Mb, 4Gb,
1Tb, etc. When omitted 1Gb
is used.
type: string
path:
description: Optional path
to directory for caching
cloud-backed GeoPackage
blocks, when omitted a temp