api.models

Attributes

_DefaultT
log

Exceptions

ApiException	Base class for all API exceptions.
ApiInvalidParamException	Base class for all API exceptions.

Classes

ApiEndpointItem	A single instance of an item of a specific endpoint.
ApiEndpoint	An API endpoint.
ApiEndpointCollection	A collection of all available API endpoints.
AuthEndpoint
ApiKey

Module Contents

api.models._DefaultT

api.models.log

exception api.models.ApiException(message: str = 'Internal Server Error', exception: Exception | None = None, status_code: int = 500, headers: dict[str, str] | None = None)

Bases: Exception

Base class for all API exceptions.

Mainly used to ensure that all exceptions regarding the API are rendered with the correct content type.

message = 'Internal Server Error'

status_code = 500

headers

exception api.models.ApiInvalidParamException(message: str = 'Invalid Parameter', status_code: int = 400)

Bases: ApiException

Base class for all API exceptions.

Mainly used to ensure that all exceptions regarding the API are rendered with the correct content type.

message = 'Invalid Parameter'

status_code = 400

class api.models.ApiEndpointItem(app: onegov.core.Framework, endpoint: str, id: str)

Bases: Generic[onegov.core.collection._M]

A single instance of an item of a specific endpoint.

Passes all functionality to the specific API endpoint and is mainly used for routing.

app

endpoint

id

property api_endpoint: ApiEndpoint[_M] | None

property item: onegov.core.collection._M | None

property data: dict[str, Any] | None

property links: dict[str, Any] | None

form(request: onegov.core.request.CoreRequest) → Form | None

class api.models.ApiEndpoint(app: onegov.core.Framework, extra_parameters: dict[str, str | None] | None = None, page: int | None = None)

Bases: Generic[onegov.core.collection._M]

An API endpoint.

API endpoints wrap collection and do some filter mapping.

To add a new endpoint, inherit from this class and provide the missing functions and properties at the bottom. Note that the collection is expected to be to provide the functionality of onegov.core.collection.Pagination.

name: ClassVar[str] = ''

endpoint: ClassVar[str] = ''

filters: ClassVar[set[str]]

form_class: ClassVar[type[onegov.form.Form] | None] = None

app

extra_parameters

page = None

batch_size = 100

for_page(page: int | None) → Self | None

Return a new endpoint instance with the given page while keeping the current filters.

for_filter(**filters: Any) → Self

Return a new endpoint instance with the given filters while discarding the current filters and page.

for_item(item: None) → None

for_item(item: onegov.core.collection._M) → ApiEndpointItem[_M]

Return a new endpoint item instance with the given item.

get_filter(name: str, default: _DefaultT, empty: _EmptyT) → str | _DefaultT | _EmptyT

get_filter(name: str, default: _DefaultT, empty: None = None) → str | _DefaultT | None

get_filter(name: str, default: None = None, *, empty: _EmptyT) → str | _EmptyT | None

get_filter(name: str, default: None = None, empty: None = None) → str | None

Returns the filter value with the given name.

by_id(id: onegov.core.collection.PKType) → onegov.core.collection._M | None

Return the item with the given ID from the collection.

property session: sqlalchemy.orm.Session

property links: dict[str, Self | None]

Returns a dictionary with pagination instances.

property batch: dict[ApiEndpointItem[_M], onegov.core.collection._M]

Returns a dictionary with endpoint item instances and their titles.

abstract item_data(item: onegov.core.collection._M) → dict[str, Any]

Return the data properties of the collection item as a dictionary.

For example:

{
    'name': 'Paul',
    'age': 40
}

abstract item_links(item: onegov.core.collection._M) → dict[str, Any]

Return the link properties of the collection item as a dictionary. Links can either be string or a linkable object.

For example:

{
    'website': 'https://onegov.ch',
    'friends': FriendsApiEndpoint(app).for_item(paul),
    'home': ApiEndpointCollection(app)
}

form(item: onegov.core.collection._M | None, request: onegov.core.request.CoreRequest) → Form | None

Return a form for editing items of this collection.

abstract apply_changes(item: onegov.core.collection._M, form: Any) → None

Apply the changes to the item based on the given form data.

property collection: PaginationWithById[_M, Any]

Abstractmethod:

Return an instance of the collection with filters and page set.

assert_valid_filter(param: str) → None

class api.models.ApiEndpointCollection(app: onegov.core.Framework)

A collection of all available API endpoints.

app

property endpoints: dict[str, type[ApiEndpoint[Any]]]

class api.models.AuthEndpoint(app: onegov.core.Framework)

app

class api.models.ApiKey

Bases: onegov.core.orm.Base

__tablename__ = 'api_keys'

id: Column[uuid.UUID]

user_id: Column[uuid.UUID]

user: relationship[User]

name: Column[str]

read_only: Column[bool]

last_used: Column[datetime | None]

key: Column[uuid.UUID]