Skip to content

Commit

Permalink
update RFC5 details
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis committed Dec 31, 2024
1 parent fb0367a commit c626a1b
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions docs/development/rfc/5.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: RFC5 - Enhanced data limit handling
- author: Tom Kralidis
- contact: [email protected]
- status: draft
- modified: 2024-11-19
- modified: 2024-12-30

## Overview

Expand All @@ -31,7 +31,7 @@ limits:
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
on_surpass: error # one of error, throttle
on_exceed: error # one of error, throttle
```
The `limits` setting will be applied as follows:
Expand All @@ -44,7 +44,7 @@ The `limits` setting will be applied as follows:
## Implementation

- an `evaluate_limit` function will be added to the `pygeoapi` module for use by `pygeoapi.api` accordingly
- if `limits.on_surpass` is `error`, then pygeoapi will throw HTTP 413
- if `limits.on_exceed` is `error`, then pygeoapi will throw HTTP 413

### Backwards Compatibility Issues

Expand All @@ -62,9 +62,7 @@ Documentation will be added to the configuration description page.

Issue: <https://github.com/geopython/pygeoapi/issues/1856>

Branch: <https://github.com/geopython/pygeoapi/tree/limits>

Pull Request: TBD
Pull Request: <https://github.com/geopython/pygeoapi/pull/1892>

## Voting History

Expand Down

0 comments on commit c626a1b

Please sign in to comment.