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 3ee0d1ea5e Support 202205 (#1188)
* Add "Last login" to https://peeringdb.com/cp/peeringdb_server/user/ #879

* Bug in renumbering tool #660

* Add the IX name and id to IX-F Import Emails #963

* Use username to create deskpro person when no first-name / last-name data exists #1057

* Organization merge tool usergroup issues #930

* Exempt superusers (PeeringDB Admin Committee & Operations Committee admins) from throttling #1172

* add missing migration for #1172

* linting

* poetry relock

* adapt to django-two-factor-auth template-tag renaming changes

* increase default for DATA_QUALITY_MAX_SPEED to 5Tb

* regenerate docs

* fix api test for netixlan max speed validation

* pdb_api_cache command needs to disable CSRF_USE_SESSIONS before it runs

Co-authored-by: David Poarch <dpoarch@20c.com>
2022-06-15 07:23:26 -05:00

68 lines
1.1 KiB
Markdown

Generated from api_cache.py on 2022-06-14 09:38:55.484251
# 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.
---