Skip to content

request

stac_fastapi.extensions.core.pagination.request

Pagination extension request models.

GETOffsetPagination

Bases: APIRequest

Offset pagination for GET requests.

Source code in stac_fastapi/extensions/core/pagination/request.py 
39
40
41
42
43
@attr.s
class GETOffsetPagination(APIRequest):
    """Offset pagination for GET requests."""

    offset: Annotated[Optional[int], Query()] = attr.ib(default=None)

GETPagination

Bases: APIRequest

Page based pagination for GET requests.

Source code in stac_fastapi/extensions/core/pagination/request.py 
26
27
28
29
30
@attr.s
class GETPagination(APIRequest):
    """Page based pagination for GET requests."""

    page: Annotated[Optional[str], Query()] = attr.ib(default=None)

GETTokenPagination

Bases: APIRequest

Token pagination for GET requests.

Source code in stac_fastapi/extensions/core/pagination/request.py 
13
14
15
16
17
@attr.s
class GETTokenPagination(APIRequest):
    """Token pagination for GET requests."""

    token: Annotated[Optional[str], Query()] = attr.ib(default=None)

POSTOffsetPagination

Bases: BaseModel

Offset pagination model for POST requests.

Source code in stac_fastapi/extensions/core/pagination/request.py 
46
47
48
49
class POSTOffsetPagination(BaseModel):
    """Offset pagination model for POST requests."""

    offset: Optional[int] = None

POSTPagination

Bases: BaseModel

Page based pagination for POST requests.

Source code in stac_fastapi/extensions/core/pagination/request.py 
33
34
35
36
class POSTPagination(BaseModel):
    """Page based pagination for POST requests."""

    page: Optional[str] = None

POSTTokenPagination

Bases: BaseModel

Token pagination model for POST requests.

Source code in stac_fastapi/extensions/core/pagination/request.py 
20
21
22
23
class POSTTokenPagination(BaseModel):
    """Token pagination model for POST requests."""

    token: Optional[str] = None