Files
peeringdb-peeringdb/docs/dev/modules/api_cache.py.md
T
Matt Griswold e2619a001f Support 202201 (#1111)
* remove survey notifications

* substantially rate limit unauthenticated /api/ queries to encourage authenticated queries #853

* move api throttle class configuration to settings (#853)

* #722 with a more generic validation approach

* Add organisations and registered users to "Global System Statistics" in footer #620

* poetry relock

* linting

* regen docs

* fix test data

Co-authored-by: Stefan Pratter <[email protected]>
Co-authored-by: David Poarch <[email protected]>
2022-02-08 13:14:27 -06:00

1.1 KiB

Generated from api_cache.py on 2022-02-07 09:42:46.681191

peeringdb_server.api_cache

Handle loading of api-cache data.

Classes


APICacheLoader

APICacheLoader(builtins.object)

Checks if an API GET request qualifies for a cache load and if it does allows you to provide the cached result.

Methods

_init_

def __init__(self, viewset, qset, filters)

Initialize self. See help(type(self)) for accurate signature.


filter_fields

def filter_fields(self, row)

Remove any unwanted fields from the resultset according to the fields filter specified in the request.


load

def load(self)

Load the cached response according to tag and depth.


qualifies

def qualifies(self)

Check if request qualifies for a cache load.


CacheRedirect

CacheRedirect(builtins.Exception)

Raise this error to redirect to cache response during viewset.get_queryset or viewset.list()

Argument should be an APICacheLoader instance.

Methods

_init_

def __init__(self, loader)

Initialize self. See help(type(self)) for accurate signature.