Skip to content

configs

configs

API service configuration models.

See Also

Api: The service class that consumes these configurations. BaseServiceConfig: Base class providing interval, max_consecutive_failures, and metrics fields.

Classes

ApiConfig

Bases: BaseServiceConfig

Configuration for the API service.

Attributes:

  • host (str) –

    Bind address for the HTTP server.

  • port (int) –

    Port for the HTTP server.

  • route_prefix (str) –

    URL prefix for all API routes (e.g. /v1, /api/v1).

  • max_page_size (int) –

    Hard ceiling on the limit query parameter.

  • default_page_size (int) –

    Default limit when not specified.

  • tables (dict[str, TableConfig]) –

    Per-table access policies. Tables not listed here default to disabled.

  • cors_origins (list[str]) –

    Allowed CORS origins. Empty list disables CORS.

  • request_timeout (float) –

    HTTP request timeout in seconds.