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/maintenance.py.md
Matt Griswold 57a4175c00 Support 202202 (#1125)
* New Field "Health Check" #512

* Add status_dashboard to fields #512

* RS Peer Checkbox also visible on IX Site #727

* Add "Management" search field to Advanced Search of Exchanges #506

* wrap correctly on mobile #881

* missing delete button for user #653

* Removed cruft from IX view template #881

* To force or not to force www, that is a question #916

* add health check fields to entity creation forms (fac, ix, net) (#512)

* status_dashboard should accept null values #512

* Sort usergroup names in https://peeringdb.com/cp/peeringdb_server/userpermission/xxxxx numerically #656

* fix issue with deleted entities showing up in search results #1042

* 2FA Backup Tokens language doesn't seem correct #908

* linting

* poetry relock

* fix user permission save trying to create a user

* add status_dashboard to mock data

* docs

* add api doc regen to gen_docs call
fix issue with run_tests if BASE_URL env var is set

* fix generate_schema typo

* linting

Co-authored-by: David Poarch <dpoarch@20c.com>
Co-authored-by: Stefan Pratter <stefan@20c.com>
2022-03-08 07:27:45 -06:00

84 lines
1.2 KiB
Markdown

Generated from maintenance.py on 2022-03-07 17:01:26.860132
# peeringdb_server.maintenance
Django middleware to handle maintenance mode.
# Functions
---
## active
`def active()`
Return True if maintenance mode is currently active.
---
## off
`def off()`
Turn maintenance mode off.
---
## on
`def on(timeout=None)`
Turn maintenance mode on.
Keyword Arguments:
- timeout<int=None>: if specified will automatically
end maintenance mode after n seconds
---
## raise_if_active
`def raise_if_active()`
Raise ActionBlocked exception if maintenance mode is active.
---
# Classes
---
## ActionBlocked
```
ActionBlocked(builtins.Exception)
```
Common base class for all non-exit exceptions.
### Methods
#### \__init__
`def __init__(self)`
Initialize self. See help(type(self)) for accurate signature.
---
## Middleware
```
Middleware(builtins.object)
```
Middleware will return 503 json responses for all write
ops (POST PUT PATCH DELETE).
### Methods
#### \__call__
`def __call__(self, request)`
Call self as a function.
---
#### \__init__
`def __init__(self, get_response=None)`
Initialize self. See help(type(self)) for accurate signature.
---