Files
peeringdb-peeringdb/docs/dev/modules/maintenance.py.md
Stefan Pratter 5eb925e319 Support 202301 (#1329)
* fix next redirect when using U2F 2FA auth (#1191)

* Added self identifier to API

* fix migrations hierarchy after merging in previous support branch

* campus object

Co-authored-by: Stefan Pratter <stefan@20c.com>

* fix out of bound error message
add city / country to campus view

* fix tests

* relock poetry

* linting

* linting

* fix docs regen

* regen docs

* linting

* refactor self entity view to support carrier and campus object types and also make it easier to support additional object types in the future

* remove debug message

---------

Co-authored-by: Gajanan Patil <dipaksavaliya.python@gmail.com>
2023-02-15 07:55:01 +00:00

84 lines
1.2 KiB
Markdown

Generated from maintenance.py on 2023-02-14 15:33:37.135106
# 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.
---