From ac2eb2e2edfbbe71ca3c1c86f819b39c9189b1b0 Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Tue, 14 Jan 2025 20:04:34 -0500 Subject: [PATCH] update RFC5 --- docs/development/rfc/5.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/development/rfc/5.md b/docs/development/rfc/5.md index 793564e..5bf2adf 100644 --- a/docs/development/rfc/5.md +++ b/docs/development/rfc/5.md @@ -8,7 +8,7 @@ title: RFC5 - Enhanced data limit handling - author: Tom Kralidis - contact: tomkralidis@gmail.com - status: draft -- modified: 2024-12-30 +- modified: 2025-01-14 ## Overview @@ -27,19 +27,20 @@ pygeoapi will define a `limits` configuration parameter that will allow a user t ```yaml limits: - defaultitems: 10 # applies to vector data - maxitems: 500 # applies to vector data - maxdistance: [x, y] # applies to all datasets - units: m # as per UCUM https://ucum.org/ucum#section-Tables-of-Terminal-Symbols + items_default: 10 # applies to vector data + items_max: 500 # applies to vector data + max_distance_x: 123 # applies to all datasets + max_distance_y: 456 # applies to all datasets + max_distance_units: m # as per UCUM https://ucum.org/ucum#section-Tables-of-Terminal-Symbols on_exceed: error # one of error, throttle ``` The `limits` setting will be applied as follows: - pygeoapi administrator is able to use at both the `server` and `resources` levels, with `resources` limits overriding server wide `limits` settings -- no limit specified by client: use `limits.defaultitems` to set the result set size -- limit specified by client: calculate the minimum of the query parameter and `limits.maxitems` to set the result set size -- bbox or spatial dimensions: compare distance of request to maximum definition allowed in `limits.maxdistance` +- no limit specified by client: use `limits.items_default` to set the result set size +- limit specified by client: calculate the minimum of the query parameter and `limits.items_max` to set the result set size +- bbox or spatial dimensions: compare distance of request to maximum definition allowed in `limits.max_distance_x` and `limits.max_distance_y` ## Implementation @@ -66,4 +67,4 @@ Pull Request: ## Voting History -TBD +Adopted on 2025-01-14 with +1 from jorgejesus, tomkralidis, kalxas