summaryrefslogtreecommitdiffstats
path: root/python/knot_resolver_manager/datamodel/management_schema.py
blob: 44f8f3e83b395142021b60ec80e21bccfa020db6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
from typing import Optional

from knot_resolver_manager.datamodel.types import WritableFilePath, IPAddressPort
from knot_resolver_manager.utils.modeling import ConfigSchema


class ManagementSchema(ConfigSchema):
    """
    Configuration of management HTTP API.

    ---
    unix_socket: Path to unix domain socket to listen to.
    interface: IP address and port number to listen to.
    """

    unix_socket: Optional[WritableFilePath] = None
    interface: Optional[IPAddressPort] = None

    def _validate(self) -> None:
        if bool(self.unix_socket) == bool(self.interface):
            raise ValueError("One of 'interface' or 'unix-socket' must be configured.")