Files
peeringdb-peeringdb/docs/dev/modules/api_cache.py.md
T
a0f1970fec Support 202211 (#1304)
* Carrier object implementation #909

* API keys: disabling of user account by a PeeringDB admin does not disable access via a User API key. Also no disable mech, only revoke. #1140

* Ops: django needs lightweight healthcheck route that confirms database connectivity #1284

* Ops: various indexes are needed #1285

* API requests with invalid Authentication headers should notify users in some way. #1220

* Allow user to change account username #1130

* UX to remove carriers from facilities more inline the other similar UX

* more UX fixes for removing carriers from facilities

* Cache hints are needed for optimal CDN use #970

* fixes Commandline tool "Run command" button gone #1278

* RIR status gets deleted when changes are made to the network #1279

* Improve MTU field #658

* CSRF cookie not set error from email confirmation view #1296

* expose CSP_CONNECT_SRC

* fix confirm email path checking in session middleware

* Ops: Emails to OPERATIONS_EMAIL need to be rate-limited #1282

* add website field to carrier ux

* website field on carrier optional with org fallback

* linting

* add *.google-analytics.com to CSP_CONNECT_SRC

* poetry relock

* fix issues with confirm-email reverse during session creation validation

* fix tests

* fix tests

* pin django-peeringdb to support_202211

* linting

* django ratelimit to <4

* regen docs

* fix automated net stats to only include networks with status `ok` #1283

* linting

* poetry lock

Co-authored-by: Matt Griswold <[email protected]>
2023-01-18 10:32:46 -06:00

68 lines
1.1 KiB
Markdown

Generated from api_cache.py on 2023-01-17 22:33:48.360745
# 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.
---