Skip to content

request

stac_fastapi.extensions.core.free_text.request

Request model for the Free-text extension.

FreeTextAdvancedExtensionGetRequest

Bases: APIRequest

Free-text Extension GET request model.

Source code in stac_fastapi/extensions/core/free_text/request.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@attr.s
class FreeTextAdvancedExtensionGetRequest(APIRequest):
    """Free-text Extension GET request model."""

    q: Annotated[
        Optional[str],
        Query(
            description="Parameter to perform free-text queries against STAC metadata",
            openapi_examples={
                "user-provided": {"value": None},
                "Coastal": {"value": "ocean,coast"},
            },
        ),
    ] = attr.ib(default=None)

FreeTextAdvancedExtensionPostRequest

Bases: BaseModel

Free-text Extension POST request model.

Source code in stac_fastapi/extensions/core/free_text/request.py 
62
63
64
65
66
67
68
class FreeTextAdvancedExtensionPostRequest(BaseModel):
    """Free-text Extension POST request model."""

    q: Optional[str] = Field(
        None,
        description="Parameter to perform free-text queries against STAC metadata",
    )

FreeTextExtensionGetRequest

Bases: APIRequest

Free-text Extension GET request model.

Source code in stac_fastapi/extensions/core/free_text/request.py 
30
31
32
33
34
@attr.s
class FreeTextExtensionGetRequest(APIRequest):
    """Free-text Extension GET request model."""

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

FreeTextExtensionPostRequest

Bases: BaseModel

Free-text Extension POST request model.

Source code in stac_fastapi/extensions/core/free_text/request.py 
37
38
39
40
41
42
43
class FreeTextExtensionPostRequest(BaseModel):
    """Free-text Extension POST request model."""

    q: Optional[List[str]] = Field(
        None,
        description="Parameter to perform free-text queries against STAC metadata",
    )