1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/docs/dev/modules/api_cache.py.md
Stefan Pratter d5c3429254 Support 202206 (#1207)
* Organization Merging Tool only offers the first 10 matches #941

* AC Change User Permission broken #1043

* change rs peer icon and move to policy column (#727)

* An account with admin status can not have permissions #1157

* add rir_* fields to keep track of ASN status #473

* poetry relock for rdap 1.3.0

* Ops: Limit Django session creation for unauthenticated requests (#1205)

* refactor 941 changes to honor grappelli field configuration and also fix broken end anchors

* check term has a value

* fix tests

* poetry reloc and pin django-peeringdb to 2.14.0

* fix middleware test

* linting

* set more reasonable default RIR_ALLOCATION_DATA_CACHE_DAYS

* better default dir for RIR_ALLOCATION_DATA_PATH

* fix csv export for advanced search

* fix issues with tests failing on CSRF_USE_SESSIONS when they are using RequestFactory

* tox.ini for flake8 options

* regen docs

* regen docs

Co-authored-by: David Poarch <dpoarch@20c.com>
2022-07-15 13:47:59 -05:00

68 lines
1.1 KiB
Markdown

Generated from api_cache.py on 2022-07-15 18:42:55.852692
# 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.
---