Skip to content

request

stac_fastapi.extensions.core.sort.request

Request model for the Sort Extension.

SortExtensionGetRequest

Bases: APIRequest

Sortby Parameter for GET requests.

Source code in stac_fastapi/extensions/core/sort/request.py 
30
31
32
33
34
@attr.s
class SortExtensionGetRequest(APIRequest):
    """Sortby Parameter for GET requests."""

    sortby: Optional[List[str]] = attr.ib(default=None, converter=_sort_converter)

SortExtensionPostRequest

Bases: BaseModel

Sortby parameter for POST requests.

Source code in stac_fastapi/extensions/core/sort/request.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class SortExtensionPostRequest(BaseModel):
    """Sortby parameter for POST requests."""

    sortby: Optional[List[PostSortModel]] = Field(
        None,
        description="An array of property (field) names, and direction in form of '{'field': '<property_name>', 'direction':'<direction>'}'",  # noqa: E501
        openapi_examples={
            "user-provided": {"value": None},
            "creation-time": {
                "value": [
                    {
                        "field": "properties.created",
                        "direction": "asc",
                    }
                ],
            },
        },
    )