Skip to content

Commit ac2eb2e

Browse files
committed
update RFC5
1 parent 99d7678 commit ac2eb2e

File tree

1 file changed

+10
-9
lines changed
  • docs/development/rfc

1 file changed

+10
-9
lines changed

docs/development/rfc/5.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: RFC5 - Enhanced data limit handling
88
- author: Tom Kralidis
99
1010
- status: draft
11-
- modified: 2024-12-30
11+
- modified: 2025-01-14
1212

1313
## Overview
1414

@@ -27,19 +27,20 @@ pygeoapi will define a `limits` configuration parameter that will allow a user t
2727

2828
```yaml
2929
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
3435
on_exceed: error # one of error, throttle
3536
```
3637
3738
The `limits` setting will be applied as follows:
3839

3940
- 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`
4344

4445
## Implementation
4546

@@ -66,4 +67,4 @@ Pull Request: <https://github.com/geopython/pygeoapi/pull/1892>
6667

6768
## Voting History
6869

69-
TBD
70+
Adopted on 2025-01-14 with +1 from jorgejesus, tomkralidis, kalxas

0 commit comments

Comments
 (0)