Module stac_fastapi.extensions.core.query¶

Query extension module.

Sub-modules¶

Classes¶

QueryExtension¶

class QueryExtension(
    conformance_classes: List[str] = NOTHING,
    schema_href: Optional[str] = None
)

Query Extension.

The Query extension adds an additional query parameter to /search requests which allows the caller to perform queries against item metadata (ex. find all images with cloud cover less than 15%). stac-api-extensions/query

Ancestors (in MRO)¶

stac_fastapi.types.extension.ApiExtension
abc.ABC

Class variables¶

GET

POST

Methods¶

get_request_model¶

def get_request_model(
    self,
    verb: Optional[str] = 'GET'
) -> Optional[pydantic.main.BaseModel]

Return the request model for the extension.method.

The model can differ based on HTTP verb

register¶

def register(
    self,
    app: fastapi.applications.FastAPI
) -> None

Register the extension with a FastAPI application.

Parameters:

Name	Type	Description	Default
app	None	target FastAPI application.	None

Returns:

Type	Description
None	None