models

stac_fastapi.api.models

Api request/response models.

CollectionUri

Bases: APIRequest

Get or delete collection.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

@attr.s
class CollectionUri(APIRequest):
    """Get or delete collection."""

    collection_id: Annotated[str, Path(description="Collection ID")] = attr.ib()

EmptyRequest

Bases: APIRequest

Empty request.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

@attr.s
class EmptyRequest(APIRequest):
    """Empty request."""

    ...

GeoJSONResponse

Bases: JSONResponse

JSON with custom, vendor content-type.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

class GeoJSONResponse(JSONResponse):
    """JSON with custom, vendor content-type."""

    media_type = "application/geo+json"

HealthCheck

Bases: BaseModel

health check response model.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

class HealthCheck(BaseModel, extra="allow"):
    """health check response model."""

    status: Literal["UP", "DOWN"]

ItemCollectionUri

Bases: APIRequest, DatetimeMixin

Get item collection.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

@attr.s
class ItemCollectionUri(APIRequest, DatetimeMixin):
    """Get item collection."""

    collection_id: Annotated[str, Path(description="Collection ID")] = attr.ib()
    limit: Annotated[
        Optional[Limit],
        Query(
            description="Limits the number of results that are included in each page of the response (capped to 10_000)."  # noqa: E501
        ),
    ] = attr.ib(default=10)
    bbox: Optional[BBox] = attr.ib(default=None, converter=_bbox_converter)  # type: ignore [misc]
    datetime: DateTimeQueryType = attr.ib(default=None, validator=_validate_datetime)

ItemUri

Bases: APIRequest

Get or delete item.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

@attr.s
class ItemUri(APIRequest):
    """Get or delete item."""

    collection_id: Annotated[str, Path(description="Collection ID")] = attr.ib()
    item_id: Annotated[str, Path(description="Item ID")] = attr.ib()

JSONSchemaResponse

Bases: JSONResponse

JSON with custom, vendor content-type.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

class JSONSchemaResponse(JSONResponse):
    """JSON with custom, vendor content-type."""

    media_type = "application/schema+json"

create_get_request_model

create_get_request_model(
    extensions: Optional[List[ApiExtension]], base_model: Type[APIRequest] = BaseSearchGetRequest
) -> Type[APIRequest]

Wrap create_request_model to create the GET request model.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

def create_get_request_model(
    extensions: Optional[List[ApiExtension]],
    base_model: Type[APIRequest] = BaseSearchGetRequest,
) -> Type[APIRequest]:
    """Wrap create_request_model to create the GET request model."""
    model = create_request_model(
        "SearchGetRequest",
        base_model=base_model,
        extensions=extensions,
        request_type="GET",
    )
    return cast(Type[APIRequest], model)

create_post_request_model

create_post_request_model(
    extensions: Optional[List[ApiExtension]], base_model: Type[BaseModel] = BaseSearchPostRequest
) -> Type[BaseModel]

Wrap create_request_model to create the POST request model.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

def create_post_request_model(
    extensions: Optional[List[ApiExtension]],
    base_model: Type[BaseModel] = BaseSearchPostRequest,
) -> Type[BaseModel]:
    """Wrap create_request_model to create the POST request model."""
    model = create_request_model(
        "SearchPostRequest",
        base_model=base_model,
        extensions=extensions,
        request_type="POST",
    )
    return cast(Type[BaseModel], model)

create_request_model

create_request_model(
    model_name="SearchGetRequest",
    base_model: Union[Type[BaseModel], Type[APIRequest]] = BaseSearchGetRequest,
    extensions: Optional[List[ApiExtension]] = None,
    mixins: Optional[Union[List[Type[BaseModel]], List[Type[APIRequest]]]] = None,
    request_type: str = "GET",
) -> Union[Type[BaseModel], Type[APIRequest]]

Create a pydantic model for validating request bodies.

Source code in stac_fastapi/api/stac_fastapi/api/models.py

def create_request_model(
    model_name="SearchGetRequest",
    base_model: Union[Type[BaseModel], Type[APIRequest]] = BaseSearchGetRequest,
    extensions: Optional[List[ApiExtension]] = None,
    mixins: Optional[Union[List[Type[BaseModel]], List[Type[APIRequest]]]] = None,
    request_type: str = "GET",
) -> Union[Type[BaseModel], Type[APIRequest]]:
    """Create a pydantic model for validating request bodies."""
    fields = {}
    extension_models: List[Union[Type[BaseModel], Type[APIRequest]]] = []

    # Check extensions for additional parameters to search
    for extension in extensions or []:
        if extension_model := extension.get_request_model(request_type):
            extension_models.append(extension_model)

    mixins = mixins or []

    models = [base_model] + extension_models + mixins

    # Handle GET requests
    if all([issubclass(m, APIRequest) for m in models]):
        get_model = attr.make_class(model_name, attrs={}, bases=tuple(models))
        return cast(Type[APIRequest], get_model)

    # Handle POST requests
    elif all([issubclass(m, BaseModel) for m in models]):
        for model in models:
            for k, field_info in model.model_fields.items():  # type: ignore
                fields[k] = (field_info.annotation, field_info)

        post_model = create_model(model_name, **fields, __base__=base_model)  # type: ignore
        return cast(Type[BaseModel], post_model)

    raise TypeError("Mixed Request Model types. Check extension request types.")