Skip to content

request

stac_fastapi.extensions.core.query.request

Request model for the Query extension.

QueryExtensionGetRequest

Bases: APIRequest

Query Extension GET request model.

Source code in stac_fastapi/extensions/core/query/request.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@attr.s
class QueryExtensionGetRequest(APIRequest):
    """Query Extension GET request model."""

    query: Annotated[
        Optional[str],
        Query(
            description="Allows additional filtering based on the properties of Item objects",  # noqa: E501
            openapi_examples={
                "user-provided": {"value": None},
                "cloudy": {"value": '{"eo:cloud_cover": {"gte": 95}}'},
            },
        ),
    ] = attr.ib(default=None)

QueryExtensionPostRequest

Bases: BaseModel

Query Extension POST request model.

Source code in stac_fastapi/extensions/core/query/request.py 
29
30
31
32
33
34
35
36
37
38
39
class QueryExtensionPostRequest(BaseModel):
    """Query Extension POST request model."""

    query: Optional[Dict[str, Dict[str, Any]]] = Field(
        None,
        description="Allows additional filtering based on the properties of Item objects",  # noqa: E501
        openapi_examples={
            "user-provided": {"value": None},
            "cloudy": {"value": '{"eo:cloud_cover": {"gte": 95}}'},
        },
    )