Module stac_fastapi.types.extension¶

Base api extension.

Classes¶

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

Abstract base class for defining API extensions.

stac_fastapi.extensions.core.aggregation.aggregation.AggregationExtension
stac_fastapi.extensions.core.collection_search.collection_search.CollectionSearchExtension
stac_fastapi.extensions.core.fields.fields.FieldsExtension
stac_fastapi.extensions.core.filter.filter.FilterExtension
stac_fastapi.extensions.core.free_text.free_text.FreeTextExtension
stac_fastapi.extensions.core.free_text.free_text.FreeTextAdvancedExtension
stac_fastapi.extensions.core.pagination.offset_pagination.OffsetPaginationExtension
stac_fastapi.extensions.core.pagination.pagination.PaginationExtension
stac_fastapi.extensions.core.pagination.token_pagination.TokenPaginationExtension
stac_fastapi.extensions.core.query.query.QueryExtension
stac_fastapi.extensions.core.sort.sort.SortExtension
stac_fastapi.extensions.core.transaction.TransactionExtension
stac_fastapi.extensions.third_party.bulk_transactions.BulkTransactionExtension

GET

POST

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

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