mirror of
https://github.com/peeringdb/peeringdb.git
synced 2024-05-11 05:55:09 +00:00
Stefan Pratter
5eb925e319
* 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>
138 lines
2.6 KiB
Markdown
138 lines
2.6 KiB
Markdown
Generated from validators.py on 2023-02-14 15:33:37.135106
|
|
|
|
# peeringdb_server.validators
|
|
|
|
peeringdb model / field validators
|
|
|
|
# Functions
|
|
---
|
|
|
|
## validate_address_space
|
|
`def validate_address_space(prefix)`
|
|
|
|
Validate an ip prefix according to peeringdb specs.
|
|
|
|
Arguments:
|
|
- prefix: ipaddress.IPv4Network or an ipaddress.IPv6Network
|
|
|
|
Raises:
|
|
- ValidationError on failed validation
|
|
|
|
---
|
|
## validate_api_rate
|
|
`def validate_api_rate(value)`
|
|
|
|
Validates a number/time-unit format used to determine rate limits
|
|
|
|
e.g., 10/second or 100/minute
|
|
|
|
Will raise a ValidationError on failure
|
|
|
|
Arguments:
|
|
|
|
- value(`str`)
|
|
|
|
Returns:
|
|
|
|
- validated value (`str`)
|
|
|
|
---
|
|
## validate_bool
|
|
`def validate_bool(value)`
|
|
|
|
Validates a boolean value
|
|
|
|
This can be passed a string for `True` or `False` or an integer as 1, 0 as well
|
|
to convert and return a boolean value
|
|
|
|
Will raise ValidationError on failure.
|
|
|
|
Arguments:
|
|
|
|
- value (`str`|`int`|`bool`)
|
|
|
|
Returns:
|
|
|
|
- validated value (`bool`)
|
|
|
|
---
|
|
## validate_irr_as_set
|
|
`def validate_irr_as_set(value)`
|
|
|
|
Validate irr as-set string.
|
|
|
|
- the as-set/rs-set name has to conform to RFC 2622 (5.1 and 5.2)
|
|
- the source may be specified by AS-SET@SOURCE or SOURCE::AS-SET
|
|
- multiple values must be separated by either comma, space or comma followed by space
|
|
|
|
Arguments:
|
|
|
|
- value: irr as-set string
|
|
|
|
Returns:
|
|
|
|
- str: validated irr as-set string
|
|
|
|
---
|
|
## validate_phonenumber
|
|
`def validate_phonenumber(phonenumber, country=None)`
|
|
|
|
Validate a phonenumber to E.164
|
|
|
|
Arguments:
|
|
- phonenumber (str)
|
|
|
|
Raises:
|
|
- ValidationError if phone number isn't valid E.164 and cannot
|
|
be made E.164 valid
|
|
|
|
Returns:
|
|
- str: validated phonenumber
|
|
|
|
---
|
|
## validate_prefix
|
|
`def validate_prefix(prefix)`
|
|
|
|
Validate ip prefix.
|
|
|
|
Arguments:
|
|
- prefix: ipaddress.IPv4Network or an ipaddress.IPv6Network
|
|
|
|
Raises:
|
|
- ValidationError on failed validation
|
|
|
|
Returns:
|
|
- ipaddress.ip_network instance
|
|
|
|
---
|
|
## validate_prefix_overlap
|
|
`def validate_prefix_overlap(prefix)`
|
|
|
|
Validate that a prefix does not overlap with another prefix
|
|
on an already existing ixlan.
|
|
|
|
Arguments:
|
|
- prefix: ipaddress.IPv4Network or an ipaddress.IPv6Network
|
|
|
|
Raises:
|
|
- ValidationError on failed validation
|
|
|
|
---
|
|
## validate_zipcode
|
|
`def validate_zipcode(zipcode, country)`
|
|
|
|
Validate a zipcode for a country. If a country has zipcodes, a zipcode
|
|
is required. If a country does not have zipcodes, it's not required.
|
|
|
|
|
|
Arguments:
|
|
- zipcode (can be Str or None at this point)
|
|
- country (two-letter country-code provided in data)
|
|
Raises:
|
|
- ValidationError if Zipcode is missing from a country WITH
|
|
zipcodes
|
|
Returns:
|
|
- str: zipcode
|
|
|
|
---
|