Module stac_fastapi.extensions.core.context¶

Context extension.

Classes¶

ContextExtension¶

class ContextExtension(
    conformance_classes: List[str] = NOTHING,
    schema_href: Union[str, NoneType] = 'https://raw.githubusercontent.com/stac-api-extensions/context/v1.0.0-rc.2/json-schema/schema.json'
)

Context Extension.

The Context extension adds a JSON object to ItemCollection responses (/search, /collections/{collection_id}/items) which includes the number of items matched, returned, and the limit requested. stac-api-extensions/context

Ancestors (in MRO)¶

stac_fastapi.types.extension.ApiExtension
abc.ABC

Class variables¶

GET

POST

Methods¶

get_request_model¶

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

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