Skip to content

Module stac_fastapi.extensions.core.sort

Sort extension module.

Sub-modules

Classes

SortExtension

class SortExtension(
    conformance_classes: List[str] = NOTHING,
    schema_href: Union[str, NoneType] = None
)

Sort Extension.

The Sort extension adds the sortby parameter to the /search endpoint, allowing the caller to specify the sort order of the returned items. stac-api-extensions/sort

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