@@ -8,7 +8,7 @@ title: RFC5 - Enhanced data limit handling
8
8
- author: Tom Kralidis
9
9
10
10
- status: draft
11
- - modified: 2024-12-30
11
+ - modified: 2025-01-14
12
12
13
13
## Overview
14
14
@@ -27,19 +27,20 @@ pygeoapi will define a `limits` configuration parameter that will allow a user t
27
27
28
28
``` yaml
29
29
limits :
30
- defaultitems : 10 # applies to vector data
31
- maxitems : 500 # applies to vector data
32
- maxdistance : [x, y] # applies to all datasets
33
- units : m # as per UCUM https://ucum.org/ucum#section-Tables-of-Terminal-Symbols
30
+ items_default : 10 # applies to vector data
31
+ items_max : 500 # applies to vector data
32
+ max_distance_x : 123 # applies to all datasets
33
+ max_distance_y : 456 # applies to all datasets
34
+ max_distance_units : m # as per UCUM https://ucum.org/ucum#section-Tables-of-Terminal-Symbols
34
35
on_exceed : error # one of error, throttle
35
36
` ` `
36
37
37
38
The ` limits` setting will be applied as follows:
38
39
39
40
- pygeoapi administrator is able to use at both the `server` and `resources` levels, with `resources` limits overriding server wide `limits` settings
40
- - no limit specified by client : use `limits.defaultitems ` to set the result set size
41
- - limit specified by client : calculate the minimum of the query parameter and `limits.maxitems ` to set the result set size
42
- - bbox or spatial dimensions : compare distance of request to maximum definition allowed in `limits.maxdistance `
41
+ - no limit specified by client : use `limits.items_default ` to set the result set size
42
+ - limit specified by client : calculate the minimum of the query parameter and `limits.items_max ` to set the result set size
43
+ - bbox or spatial dimensions : compare distance of request to maximum definition allowed in `limits.max_distance_x` and `limits.max_distance_y `
43
44
44
45
# # Implementation
45
46
@@ -66,4 +67,4 @@ Pull Request: <https://github.com/geopython/pygeoapi/pull/1892>
66
67
67
68
# # Voting History
68
69
69
- TBD
70
+ Adopted on 2025-01-14 with +1 from jorgejesus, tomkralidis, kalxas
0 commit comments