core

stac_fastapi.types.core

Base clients.

AsyncBaseCoreClient

Bases: LandingPageMixin, ABC

Defines a pattern for implementing STAC api core endpoints.

Attributes:

• extensions (List[ApiExtension]) –

  list of registered api extensions.

Source code in stac_fastapi/types/core.py

@attr.s  # type:ignore
class AsyncBaseCoreClient(LandingPageMixin, abc.ABC):
    """Defines a pattern for implementing STAC api core endpoints.

    Attributes:
        extensions: list of registered api extensions.
    """

    base_conformance_classes: List[str] = attr.ib(
        factory=lambda: BASE_CONFORMANCE_CLASSES
    )
    extensions: List[ApiExtension] = attr.ib(default=attr.Factory(list))

    def conformance_classes(self) -> List[str]:
        """Generate conformance classes by adding extension conformance to base
        conformance classes."""
        conformance_classes = self.base_conformance_classes.copy()

        for extension in self.extensions:
            extension_classes = getattr(extension, "conformance_classes", [])
            conformance_classes.extend(extension_classes)

        return sorted(list(set(conformance_classes)))

    def extension_is_enabled(self, extension: str) -> bool:
        """Check if an api extension is enabled."""
        return any([type(ext).__name__ == extension for ext in self.extensions])

    async def landing_page(self, **kwargs) -> stac.LandingPage:
        """Landing page.

        Called with `GET /`.

        Returns:
            API landing page, serving as an entry point to the API.
        """
        request: Request = kwargs["request"]
        base_url = get_base_url(request)

        landing_page = self._landing_page(
            base_url=base_url,
            conformance_classes=self.conformance_classes(),
            extension_schemas=[],
        )

        # Add Queryables link
        if self.extension_is_enabled("FilterExtension") or self.extension_is_enabled(
            "SearchFilterExtension"
        ):
            landing_page["links"].append(
                {
                    "rel": Relations.queryables.value,
                    "type": MimeTypes.jsonschema.value,
                    "title": "Queryables available for this Catalog",
                    "href": urljoin(base_url, "queryables"),
                    "method": "GET",
                }
            )

        # Add Aggregation links
        if self.extension_is_enabled("AggregationExtension"):
            landing_page["links"].extend(
                [
                    {
                        "rel": "aggregate",
                        "type": "application/json",
                        "title": "Aggregate",
                        "href": urljoin(base_url, "aggregate"),
                    },
                    {
                        "rel": "aggregations",
                        "type": "application/json",
                        "title": "Aggregations",
                        "href": urljoin(base_url, "aggregations"),
                    },
                ]
            )

        # Add OpenAPI URL
        landing_page["links"].append(
            {
                "rel": Relations.service_desc.value,
                "type": MimeTypes.openapi.value,
                "title": "OpenAPI service description",
                "href": str(request.url_for("openapi")),
            }
        )

        # Add human readable service-doc
        landing_page["links"].append(
            {
                "rel": Relations.service_doc.value,
                "type": MimeTypes.html.value,
                "title": "OpenAPI service documentation",
                "href": str(request.url_for("swagger_ui_html")),
            }
        )

        return stac.LandingPage(**landing_page)

    async def conformance(self, **kwargs) -> stac.Conformance:
        """Conformance classes.

        Called with `GET /conformance`.

        Returns:
            Conformance classes which the server conforms to.
        """
        return stac.Conformance(conformsTo=self.conformance_classes())

    @abc.abstractmethod
    async def post_search(
        self, search_request: BaseSearchPostRequest, **kwargs
    ) -> stac.ItemCollection:
        """Cross catalog search (POST).

        Called with `POST /search`.

        Args:
            search_request: search request parameters.

        Returns:
            ItemCollection containing items which match the search criteria.
        """
        ...

    @abc.abstractmethod
    async def get_search(
        self,
        collections: Optional[List[str]] = None,
        ids: Optional[List[str]] = None,
        bbox: Optional[BBox] = None,
        intersects: Optional[Geometry] = None,
        datetime: Optional[str] = None,
        limit: Optional[int] = 10,
        **kwargs,
    ) -> stac.ItemCollection:
        """Cross catalog search (GET).

        Called with `GET /search`.

        Returns:
            ItemCollection containing items which match the search criteria.
        """
        ...

    @abc.abstractmethod
    async def get_item(self, item_id: str, collection_id: str, **kwargs) -> stac.Item:
        """Get item by id.

        Called with `GET /collections/{collection_id}/items/{item_id}`.

        Args:
            item_id: Id of the item.
            collection_id: Id of the collection.

        Returns:
            Item.
        """
        ...

    @abc.abstractmethod
    async def all_collections(self, **kwargs) -> stac.Collections:
        """Get all available collections.

        Called with `GET /collections`.

        Returns:
            A list of collections.
        """
        ...

    @abc.abstractmethod
    async def get_collection(self, collection_id: str, **kwargs) -> stac.Collection:
        """Get collection by id.

        Called with `GET /collections/{collection_id}`.

        Args:
            collection_id: Id of the collection.

        Returns:
            Collection.
        """
        ...

    @abc.abstractmethod
    async def item_collection(
        self,
        collection_id: str,
        bbox: Optional[BBox] = None,
        datetime: Optional[str] = None,
        limit: int = 10,
        token: Optional[str] = None,
        **kwargs,
    ) -> stac.ItemCollection:
        """Get all items from a specific collection.

        Called with `GET /collections/{collection_id}/items`

        Args:
            collection_id: id of the collection.
            limit: number of items to return.
            token: pagination token.

        Returns:
            An ItemCollection.
        """
        ...

all_collections abstractmethod async

all_collections(**kwargs) -> Collections

Get all available collections.

Called with GET /collections.

Returns:

• Collections –

  A list of collections.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def all_collections(self, **kwargs) -> stac.Collections:
    """Get all available collections.

    Called with `GET /collections`.

    Returns:
        A list of collections.
    """
    ...

conformance async

conformance(**kwargs) -> Conformance

Conformance classes.

Called with GET /conformance.

Returns:

• Conformance –

  Conformance classes which the server conforms to.

Source code in stac_fastapi/types/core.py

async def conformance(self, **kwargs) -> stac.Conformance:
    """Conformance classes.

    Called with `GET /conformance`.

    Returns:
        Conformance classes which the server conforms to.
    """
    return stac.Conformance(conformsTo=self.conformance_classes())

conformance_classes

conformance_classes() -> List[str]

Generate conformance classes by adding extension conformance to base conformance classes.

Source code in stac_fastapi/types/core.py

def conformance_classes(self) -> List[str]:
    """Generate conformance classes by adding extension conformance to base
    conformance classes."""
    conformance_classes = self.base_conformance_classes.copy()

    for extension in self.extensions:
        extension_classes = getattr(extension, "conformance_classes", [])
        conformance_classes.extend(extension_classes)

    return sorted(list(set(conformance_classes)))

extension_is_enabled

extension_is_enabled(extension: str) -> bool

Check if an api extension is enabled.

Source code in stac_fastapi/types/core.py

def extension_is_enabled(self, extension: str) -> bool:
    """Check if an api extension is enabled."""
    return any([type(ext).__name__ == extension for ext in self.extensions])

get_collection abstractmethod async

get_collection(collection_id: str, **kwargs) -> Collection

Get collection by id.

Called with GET /collections/{collection_id}.

Parameters:

• collection_id (str) –

  Id of the collection.

Returns:

• Collection –

  Collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def get_collection(self, collection_id: str, **kwargs) -> stac.Collection:
    """Get collection by id.

    Called with `GET /collections/{collection_id}`.

    Args:
        collection_id: Id of the collection.

    Returns:
        Collection.
    """
    ...

get_item abstractmethod async

get_item(item_id: str, collection_id: str, **kwargs) -> Item

Get item by id.

Called with GET /collections/{collection_id}/items/{item_id}.

Parameters:

• item_id (str) –

  Id of the item.

• collection_id (str) –

  Id of the collection.

Returns:

• Item –

  Item.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def get_item(self, item_id: str, collection_id: str, **kwargs) -> stac.Item:
    """Get item by id.

    Called with `GET /collections/{collection_id}/items/{item_id}`.

    Args:
        item_id: Id of the item.
        collection_id: Id of the collection.

    Returns:
        Item.
    """
    ...

get_search abstractmethod async

get_search(
    collections: Optional[List[str]] = None,
    ids: Optional[List[str]] = None,
    bbox: Optional[BBox] = None,
    intersects: Optional[Geometry] = None,
    datetime: Optional[str] = None,
    limit: Optional[int] = 10,
    **kwargs
) -> ItemCollection

Cross catalog search (GET).

Called with GET /search.

Returns:

• ItemCollection –

  ItemCollection containing items which match the search criteria.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def get_search(
    self,
    collections: Optional[List[str]] = None,
    ids: Optional[List[str]] = None,
    bbox: Optional[BBox] = None,
    intersects: Optional[Geometry] = None,
    datetime: Optional[str] = None,
    limit: Optional[int] = 10,
    **kwargs,
) -> stac.ItemCollection:
    """Cross catalog search (GET).

    Called with `GET /search`.

    Returns:
        ItemCollection containing items which match the search criteria.
    """
    ...

item_collection abstractmethod async

item_collection(
    collection_id: str,
    bbox: Optional[BBox] = None,
    datetime: Optional[str] = None,
    limit: int = 10,
    token: Optional[str] = None,
    **kwargs
) -> ItemCollection

Get all items from a specific collection.

Called with GET /collections/{collection_id}/items

Parameters:

• collection_id (str) –

  id of the collection.

• limit (int, default: 10 ) –

  number of items to return.

• token (Optional[str], default: None ) –

  pagination token.

Returns:

• ItemCollection –

  An ItemCollection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def item_collection(
    self,
    collection_id: str,
    bbox: Optional[BBox] = None,
    datetime: Optional[str] = None,
    limit: int = 10,
    token: Optional[str] = None,
    **kwargs,
) -> stac.ItemCollection:
    """Get all items from a specific collection.

    Called with `GET /collections/{collection_id}/items`

    Args:
        collection_id: id of the collection.
        limit: number of items to return.
        token: pagination token.

    Returns:
        An ItemCollection.
    """
    ...

landing_page async

landing_page(**kwargs) -> LandingPage

Landing page.

Called with GET /.

Returns:

• LandingPage –

  API landing page, serving as an entry point to the API.

Source code in stac_fastapi/types/core.py

async def landing_page(self, **kwargs) -> stac.LandingPage:
    """Landing page.

    Called with `GET /`.

    Returns:
        API landing page, serving as an entry point to the API.
    """
    request: Request = kwargs["request"]
    base_url = get_base_url(request)

    landing_page = self._landing_page(
        base_url=base_url,
        conformance_classes=self.conformance_classes(),
        extension_schemas=[],
    )

    # Add Queryables link
    if self.extension_is_enabled("FilterExtension") or self.extension_is_enabled(
        "SearchFilterExtension"
    ):
        landing_page["links"].append(
            {
                "rel": Relations.queryables.value,
                "type": MimeTypes.jsonschema.value,
                "title": "Queryables available for this Catalog",
                "href": urljoin(base_url, "queryables"),
                "method": "GET",
            }
        )

    # Add Aggregation links
    if self.extension_is_enabled("AggregationExtension"):
        landing_page["links"].extend(
            [
                {
                    "rel": "aggregate",
                    "type": "application/json",
                    "title": "Aggregate",
                    "href": urljoin(base_url, "aggregate"),
                },
                {
                    "rel": "aggregations",
                    "type": "application/json",
                    "title": "Aggregations",
                    "href": urljoin(base_url, "aggregations"),
                },
            ]
        )

    # Add OpenAPI URL
    landing_page["links"].append(
        {
            "rel": Relations.service_desc.value,
            "type": MimeTypes.openapi.value,
            "title": "OpenAPI service description",
            "href": str(request.url_for("openapi")),
        }
    )

    # Add human readable service-doc
    landing_page["links"].append(
        {
            "rel": Relations.service_doc.value,
            "type": MimeTypes.html.value,
            "title": "OpenAPI service documentation",
            "href": str(request.url_for("swagger_ui_html")),
        }
    )

    return stac.LandingPage(**landing_page)

post_search abstractmethod async

post_search(search_request: BaseSearchPostRequest, **kwargs) -> ItemCollection

Cross catalog search (POST).

Called with POST /search.

Parameters:

• search_request (BaseSearchPostRequest) –

  search request parameters.

Returns:

• ItemCollection –

  ItemCollection containing items which match the search criteria.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def post_search(
    self, search_request: BaseSearchPostRequest, **kwargs
) -> stac.ItemCollection:
    """Cross catalog search (POST).

    Called with `POST /search`.

    Args:
        search_request: search request parameters.

    Returns:
        ItemCollection containing items which match the search criteria.
    """
    ...

AsyncBaseTransactionsClient

Bases: ABC

Defines a pattern for implementing the STAC transaction extension.

Source code in stac_fastapi/types/core.py

@attr.s  # type:ignore
class AsyncBaseTransactionsClient(abc.ABC):
    """Defines a pattern for implementing the STAC transaction extension."""

    @abc.abstractmethod
    async def create_item(
        self,
        collection_id: str,
        item: Union[Item, ItemCollection],
        **kwargs,
    ) -> Optional[Union[stac.Item, Response, None]]:
        """Create a new item.

        Called with `POST /collections/{collection_id}/items`.

        Args:
            item: the item or item collection
            collection_id: the id of the collection from the resource path

        Returns:
            The item that was created or None if item collection.
        """
        ...

    @abc.abstractmethod
    async def update_item(
        self, collection_id: str, item_id: str, item: Item, **kwargs
    ) -> Optional[Union[stac.Item, Response]]:
        """Perform a complete update on an existing item.

        Called with `PUT /collections/{collection_id}/items`. It is expected
        that this item already exists.  The update should do a diff against the
        saved item and perform any necessary updates.  Partial updates are not
        supported by the transactions extension.

        Args:
            item: the item (must be complete)

        Returns:
            The updated item.
        """
        ...

    @abc.abstractmethod
    async def patch_item(
        self,
        collection_id: str,
        item_id: str,
        patch: Union[stac.PartialItem, List[stac.PatchOperation]],
        **kwargs,
    ) -> Optional[Union[stac.Item, Response]]:
        """Update an item from a collection.

        Called with `PATCH /collections/{collection_id}/items/{item_id}`

        example:
            # convert merge patch item to list of operations
            if isinstance(patch, PartialItem):
                patch = patch.operations()

            item = backend.patch_item(collection_id, item_id, patch)

            return item

        Args:
            item_id: id of the item.
            collection_id: id of the collection.
            patch: either the partial item or list of patch operations.

        Returns:
            The patched item.
        """
        ...

    @abc.abstractmethod
    async def delete_item(
        self, item_id: str, collection_id: str, **kwargs
    ) -> Optional[Union[stac.Item, Response]]:
        """Delete an item from a collection.

        Called with `DELETE /collections/{collection_id}/items/{item_id}`

        Args:
            item_id: id of the item.
            collection_id: id of the collection.

        Returns:
            The deleted item.
        """
        ...

    @abc.abstractmethod
    async def create_collection(
        self, collection: Collection, **kwargs
    ) -> Optional[Union[stac.Collection, Response]]:
        """Create a new collection.

        Called with `POST /collections`.

        Args:
            collection: the collection

        Returns:
            The collection that was created.
        """
        ...

    @abc.abstractmethod
    async def update_collection(
        self, collection_id: str, collection: Collection, **kwargs
    ) -> Optional[Union[stac.Collection, Response]]:
        """Perform a complete update on an existing collection.

        Called with `PUT /collections/{collection_id}`. It is expected that this item
        already exists.  The update should do a diff against the saved collection and
        perform any necessary updates.  Partial updates are not supported by the
        transactions extension.

        Args:
            collection_id: id of the existing collection to be updated
            collection: the updated collection (must be complete)

        Returns:
            The updated collection.
        """
        ...

    @abc.abstractmethod
    async def patch_collection(
        self,
        collection_id: str,
        patch: Union[stac.PartialCollection, List[stac.PatchOperation]],
        **kwargs,
    ) -> Optional[Union[stac.Collection, Response]]:
        """Update a collection.

        Called with `PATCH /collections/{collection_id}`

        example:
            # convert merge patch item to list of operations
            if isinstance(patch, PartialCollection):
                patch = patch.operations()

            collection = backend.patch_collection(collection_id, patch)

            return collection

        Args:
            collection_id: id of the collection.
            patch: either the partial collection or list of patch operations.

        Returns:
            The patched collection.
        """
        ...

    @abc.abstractmethod
    async def delete_collection(
        self, collection_id: str, **kwargs
    ) -> Optional[Union[stac.Collection, Response]]:
        """Delete a collection.

        Called with `DELETE /collections/{collection_id}`

        Args:
            collection_id: id of the collection.

        Returns:
            The deleted collection.
        """
        ...

create_collection abstractmethod async

create_collection(collection: Collection, **kwargs) -> Optional[Union[Collection, Response]]

Create a new collection.

Called with POST /collections.

Parameters:

• collection (Collection) –

  the collection

Returns:

• Optional[Union[Collection, Response]] –

  The collection that was created.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def create_collection(
    self, collection: Collection, **kwargs
) -> Optional[Union[stac.Collection, Response]]:
    """Create a new collection.

    Called with `POST /collections`.

    Args:
        collection: the collection

    Returns:
        The collection that was created.
    """
    ...

create_item abstractmethod async

create_item(
    collection_id: str, item: Union[Item, ItemCollection], **kwargs
) -> Optional[Union[Item, Response, None]]

Create a new item.

Called with POST /collections/{collection_id}/items.

Parameters:

• item (Union[Item, ItemCollection]) –

  the item or item collection

• collection_id (str) –

  the id of the collection from the resource path

Returns:

• Optional[Union[Item, Response, None]] –

  The item that was created or None if item collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def create_item(
    self,
    collection_id: str,
    item: Union[Item, ItemCollection],
    **kwargs,
) -> Optional[Union[stac.Item, Response, None]]:
    """Create a new item.

    Called with `POST /collections/{collection_id}/items`.

    Args:
        item: the item or item collection
        collection_id: the id of the collection from the resource path

    Returns:
        The item that was created or None if item collection.
    """
    ...

delete_collection abstractmethod async

delete_collection(collection_id: str, **kwargs) -> Optional[Union[Collection, Response]]

Delete a collection.

Called with DELETE /collections/{collection_id}

Parameters:

• collection_id (str) –

  id of the collection.

Returns:

• Optional[Union[Collection, Response]] –

  The deleted collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def delete_collection(
    self, collection_id: str, **kwargs
) -> Optional[Union[stac.Collection, Response]]:
    """Delete a collection.

    Called with `DELETE /collections/{collection_id}`

    Args:
        collection_id: id of the collection.

    Returns:
        The deleted collection.
    """
    ...

delete_item abstractmethod async

delete_item(item_id: str, collection_id: str, **kwargs) -> Optional[Union[Item, Response]]

Delete an item from a collection.

Called with DELETE /collections/{collection_id}/items/{item_id}

Parameters:

• item_id (str) –

  id of the item.

• collection_id (str) –

  id of the collection.

Returns:

• Optional[Union[Item, Response]] –

  The deleted item.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def delete_item(
    self, item_id: str, collection_id: str, **kwargs
) -> Optional[Union[stac.Item, Response]]:
    """Delete an item from a collection.

    Called with `DELETE /collections/{collection_id}/items/{item_id}`

    Args:
        item_id: id of the item.
        collection_id: id of the collection.

    Returns:
        The deleted item.
    """
    ...

patch_collection abstractmethod async

patch_collection(
    collection_id: str, patch: Union[PartialCollection, List[PatchOperation]], **kwargs
) -> Optional[Union[Collection, Response]]

Update a collection.

Called with PATCH /collections/{collection_id}

example

convert merge patch item to list of operations

if isinstance(patch, PartialCollection): patch = patch.operations()

collection = backend.patch_collection(collection_id, patch)

return collection

Parameters:

• collection_id (str) –

  id of the collection.

• patch (Union[PartialCollection, List[PatchOperation]]) –

  either the partial collection or list of patch operations.

Returns:

• Optional[Union[Collection, Response]] –

  The patched collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def patch_collection(
    self,
    collection_id: str,
    patch: Union[stac.PartialCollection, List[stac.PatchOperation]],
    **kwargs,
) -> Optional[Union[stac.Collection, Response]]:
    """Update a collection.

    Called with `PATCH /collections/{collection_id}`

    example:
        # convert merge patch item to list of operations
        if isinstance(patch, PartialCollection):
            patch = patch.operations()

        collection = backend.patch_collection(collection_id, patch)

        return collection

    Args:
        collection_id: id of the collection.
        patch: either the partial collection or list of patch operations.

    Returns:
        The patched collection.
    """
    ...

patch_item abstractmethod async

patch_item(
    collection_id: str, item_id: str, patch: Union[PartialItem, List[PatchOperation]], **kwargs
) -> Optional[Union[Item, Response]]

Update an item from a collection.

Called with PATCH /collections/{collection_id}/items/{item_id}

example

convert merge patch item to list of operations

if isinstance(patch, PartialItem): patch = patch.operations()

item = backend.patch_item(collection_id, item_id, patch)

return item

Parameters:

• item_id (str) –

  id of the item.

• collection_id (str) –

  id of the collection.

• patch (Union[PartialItem, List[PatchOperation]]) –

  either the partial item or list of patch operations.

Returns:

• Optional[Union[Item, Response]] –

  The patched item.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def patch_item(
    self,
    collection_id: str,
    item_id: str,
    patch: Union[stac.PartialItem, List[stac.PatchOperation]],
    **kwargs,
) -> Optional[Union[stac.Item, Response]]:
    """Update an item from a collection.

    Called with `PATCH /collections/{collection_id}/items/{item_id}`

    example:
        # convert merge patch item to list of operations
        if isinstance(patch, PartialItem):
            patch = patch.operations()

        item = backend.patch_item(collection_id, item_id, patch)

        return item

    Args:
        item_id: id of the item.
        collection_id: id of the collection.
        patch: either the partial item or list of patch operations.

    Returns:
        The patched item.
    """
    ...

update_collection abstractmethod async

update_collection(
    collection_id: str, collection: Collection, **kwargs
) -> Optional[Union[Collection, Response]]

Perform a complete update on an existing collection.

Called with PUT /collections/{collection_id}. It is expected that this item already exists. The update should do a diff against the saved collection and perform any necessary updates. Partial updates are not supported by the transactions extension.

Parameters:

• collection_id (str) –

  id of the existing collection to be updated

• collection (Collection) –

  the updated collection (must be complete)

Returns:

• Optional[Union[Collection, Response]] –

  The updated collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def update_collection(
    self, collection_id: str, collection: Collection, **kwargs
) -> Optional[Union[stac.Collection, Response]]:
    """Perform a complete update on an existing collection.

    Called with `PUT /collections/{collection_id}`. It is expected that this item
    already exists.  The update should do a diff against the saved collection and
    perform any necessary updates.  Partial updates are not supported by the
    transactions extension.

    Args:
        collection_id: id of the existing collection to be updated
        collection: the updated collection (must be complete)

    Returns:
        The updated collection.
    """
    ...

update_item abstractmethod async

update_item(
    collection_id: str, item_id: str, item: Item, **kwargs
) -> Optional[Union[Item, Response]]

Perform a complete update on an existing item.

Called with PUT /collections/{collection_id}/items. It is expected that this item already exists. The update should do a diff against the saved item and perform any necessary updates. Partial updates are not supported by the transactions extension.

Parameters:

• item (Item) –

  the item (must be complete)

Returns:

• Optional[Union[Item, Response]] –

  The updated item.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
async def update_item(
    self, collection_id: str, item_id: str, item: Item, **kwargs
) -> Optional[Union[stac.Item, Response]]:
    """Perform a complete update on an existing item.

    Called with `PUT /collections/{collection_id}/items`. It is expected
    that this item already exists.  The update should do a diff against the
    saved item and perform any necessary updates.  Partial updates are not
    supported by the transactions extension.

    Args:
        item: the item (must be complete)

    Returns:
        The updated item.
    """
    ...

BaseCoreClient

Bases: LandingPageMixin, ABC

Defines a pattern for implementing STAC api core endpoints.

Attributes:

• extensions (List[ApiExtension]) –

  list of registered api extensions.

Source code in stac_fastapi/types/core.py

@attr.s  # type:ignore
class BaseCoreClient(LandingPageMixin, abc.ABC):
    """Defines a pattern for implementing STAC api core endpoints.

    Attributes:
        extensions: list of registered api extensions.
    """

    base_conformance_classes: List[str] = attr.ib(
        factory=lambda: BASE_CONFORMANCE_CLASSES
    )
    extensions: List[ApiExtension] = attr.ib(default=attr.Factory(list))

    def conformance_classes(self) -> List[str]:
        """Generate conformance classes by adding extension conformance to base
        conformance classes."""
        base_conformance_classes = self.base_conformance_classes.copy()

        for extension in self.extensions:
            extension_classes = getattr(extension, "conformance_classes", [])
            base_conformance_classes.extend(extension_classes)

        return sorted(list(set(base_conformance_classes)))

    def extension_is_enabled(self, extension: str) -> bool:
        """Check if an api extension is enabled."""
        return any([type(ext).__name__ == extension for ext in self.extensions])

    def list_conformance_classes(self):
        """Return a list of conformance classes, including implemented extensions."""
        base_conformance = BASE_CONFORMANCE_CLASSES

        for extension in self.extensions:
            extension_classes = getattr(extension, "conformance_classes", [])
            base_conformance.extend(extension_classes)

        return base_conformance

    def landing_page(self, **kwargs) -> stac.LandingPage:
        """Landing page.

        Called with `GET /`.

        Returns:
            API landing page, serving as an entry point to the API.
        """
        request: Request = kwargs["request"]
        base_url = get_base_url(request)

        landing_page = self._landing_page(
            base_url=base_url,
            conformance_classes=self.conformance_classes(),
            extension_schemas=[],
        )

        # Add Queryables link
        if self.extension_is_enabled("FilterExtension") or self.extension_is_enabled(
            "SearchFilterExtension"
        ):
            landing_page["links"].append(
                {
                    "rel": Relations.queryables.value,
                    "type": MimeTypes.jsonschema.value,
                    "title": "Queryables available for this Catalog",
                    "href": urljoin(base_url, "queryables"),
                }
            )

        # Add Aggregation links
        if self.extension_is_enabled("AggregationExtension"):
            landing_page["links"].extend(
                [
                    {
                        "rel": "aggregate",
                        "type": "application/json",
                        "title": "Aggregate",
                        "href": urljoin(base_url, "aggregate"),
                    },
                    {
                        "rel": "aggregations",
                        "type": "application/json",
                        "title": "Aggregations",
                        "href": urljoin(base_url, "aggregations"),
                    },
                ]
            )

        # Add OpenAPI URL
        landing_page["links"].append(
            {
                "rel": Relations.service_desc.value,
                "type": MimeTypes.openapi.value,
                "title": "OpenAPI service description",
                "href": str(request.url_for("openapi")),
            }
        )

        # Add human readable service-doc
        landing_page["links"].append(
            {
                "rel": Relations.service_doc.value,
                "type": MimeTypes.html.value,
                "title": "OpenAPI service documentation",
                "href": str(request.url_for("swagger_ui_html")),
            }
        )

        return stac.LandingPage(**landing_page)

    def conformance(self, **kwargs) -> stac.Conformance:
        """Conformance classes.

        Called with `GET /conformance`.

        Returns:
            Conformance classes which the server conforms to.
        """
        return stac.Conformance(conformsTo=self.conformance_classes())

    @abc.abstractmethod
    def post_search(
        self, search_request: BaseSearchPostRequest, **kwargs
    ) -> stac.ItemCollection:
        """Cross catalog search (POST).

        Called with `POST /search`.

        Args:
            search_request: search request parameters.

        Returns:
            ItemCollection containing items which match the search criteria.
        """
        ...

    @abc.abstractmethod
    def get_search(
        self,
        collections: Optional[List[str]] = None,
        ids: Optional[List[str]] = None,
        bbox: Optional[BBox] = None,
        intersects: Optional[Geometry] = None,
        datetime: Optional[str] = None,
        limit: Optional[int] = 10,
        **kwargs,
    ) -> stac.ItemCollection:
        """Cross catalog search (GET).

        Called with `GET /search`.

        Returns:
            ItemCollection containing items which match the search criteria.
        """
        ...

    @abc.abstractmethod
    def get_item(self, item_id: str, collection_id: str, **kwargs) -> stac.Item:
        """Get item by id.

        Called with `GET /collections/{collection_id}/items/{item_id}`.

        Args:
            item_id: Id of the item.
            collection_id: Id of the collection.

        Returns:
            Item.
        """
        ...

    @abc.abstractmethod
    def all_collections(self, **kwargs) -> stac.Collections:
        """Get all available collections.

        Called with `GET /collections`.

        Returns:
            A list of collections.
        """
        ...

    @abc.abstractmethod
    def get_collection(self, collection_id: str, **kwargs) -> stac.Collection:
        """Get collection by id.

        Called with `GET /collections/{collection_id}`.

        Args:
            collection_id: Id of the collection.

        Returns:
            Collection.
        """
        ...

    @abc.abstractmethod
    def item_collection(
        self,
        collection_id: str,
        bbox: Optional[BBox] = None,
        datetime: Optional[str] = None,
        limit: int = 10,
        token: Optional[str] = None,
        **kwargs,
    ) -> stac.ItemCollection:
        """Get all items from a specific collection.

        Called with `GET /collections/{collection_id}/items`

        Args:
            collection_id: id of the collection.
            limit: number of items to return.
            token: pagination token.

        Returns:
            An ItemCollection.
        """
        ...

all_collections abstractmethod

all_collections(**kwargs) -> Collections

Get all available collections.

Called with GET /collections.

Returns:

• Collections –

  A list of collections.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def all_collections(self, **kwargs) -> stac.Collections:
    """Get all available collections.

    Called with `GET /collections`.

    Returns:
        A list of collections.
    """
    ...

conformance

conformance(**kwargs) -> Conformance

Conformance classes.

Called with GET /conformance.

Returns:

• Conformance –

  Conformance classes which the server conforms to.

Source code in stac_fastapi/types/core.py

def conformance(self, **kwargs) -> stac.Conformance:
    """Conformance classes.

    Called with `GET /conformance`.

    Returns:
        Conformance classes which the server conforms to.
    """
    return stac.Conformance(conformsTo=self.conformance_classes())

conformance_classes

conformance_classes() -> List[str]

Generate conformance classes by adding extension conformance to base conformance classes.

Source code in stac_fastapi/types/core.py

def conformance_classes(self) -> List[str]:
    """Generate conformance classes by adding extension conformance to base
    conformance classes."""
    base_conformance_classes = self.base_conformance_classes.copy()

    for extension in self.extensions:
        extension_classes = getattr(extension, "conformance_classes", [])
        base_conformance_classes.extend(extension_classes)

    return sorted(list(set(base_conformance_classes)))

extension_is_enabled

extension_is_enabled(extension: str) -> bool

Check if an api extension is enabled.

Source code in stac_fastapi/types/core.py

def extension_is_enabled(self, extension: str) -> bool:
    """Check if an api extension is enabled."""
    return any([type(ext).__name__ == extension for ext in self.extensions])

get_collection abstractmethod

get_collection(collection_id: str, **kwargs) -> Collection

Get collection by id.

Called with GET /collections/{collection_id}.

Parameters:

• collection_id (str) –

  Id of the collection.

Returns:

• Collection –

  Collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def get_collection(self, collection_id: str, **kwargs) -> stac.Collection:
    """Get collection by id.

    Called with `GET /collections/{collection_id}`.

    Args:
        collection_id: Id of the collection.

    Returns:
        Collection.
    """
    ...

get_item abstractmethod

get_item(item_id: str, collection_id: str, **kwargs) -> Item

Get item by id.

Called with GET /collections/{collection_id}/items/{item_id}.

Parameters:

• item_id (str) –

  Id of the item.

• collection_id (str) –

  Id of the collection.

Returns:

• Item –

  Item.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def get_item(self, item_id: str, collection_id: str, **kwargs) -> stac.Item:
    """Get item by id.

    Called with `GET /collections/{collection_id}/items/{item_id}`.

    Args:
        item_id: Id of the item.
        collection_id: Id of the collection.

    Returns:
        Item.
    """
    ...

get_search abstractmethod

get_search(
    collections: Optional[List[str]] = None,
    ids: Optional[List[str]] = None,
    bbox: Optional[BBox] = None,
    intersects: Optional[Geometry] = None,
    datetime: Optional[str] = None,
    limit: Optional[int] = 10,
    **kwargs
) -> ItemCollection

Cross catalog search (GET).

Called with GET /search.

Returns:

• ItemCollection –

  ItemCollection containing items which match the search criteria.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def get_search(
    self,
    collections: Optional[List[str]] = None,
    ids: Optional[List[str]] = None,
    bbox: Optional[BBox] = None,
    intersects: Optional[Geometry] = None,
    datetime: Optional[str] = None,
    limit: Optional[int] = 10,
    **kwargs,
) -> stac.ItemCollection:
    """Cross catalog search (GET).

    Called with `GET /search`.

    Returns:
        ItemCollection containing items which match the search criteria.
    """
    ...

item_collection abstractmethod

item_collection(
    collection_id: str,
    bbox: Optional[BBox] = None,
    datetime: Optional[str] = None,
    limit: int = 10,
    token: Optional[str] = None,
    **kwargs
) -> ItemCollection

Get all items from a specific collection.

Called with GET /collections/{collection_id}/items

Parameters:

• collection_id (str) –

  id of the collection.

• limit (int, default: 10 ) –

  number of items to return.

• token (Optional[str], default: None ) –

  pagination token.

Returns:

• ItemCollection –

  An ItemCollection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def item_collection(
    self,
    collection_id: str,
    bbox: Optional[BBox] = None,
    datetime: Optional[str] = None,
    limit: int = 10,
    token: Optional[str] = None,
    **kwargs,
) -> stac.ItemCollection:
    """Get all items from a specific collection.

    Called with `GET /collections/{collection_id}/items`

    Args:
        collection_id: id of the collection.
        limit: number of items to return.
        token: pagination token.

    Returns:
        An ItemCollection.
    """
    ...

landing_page

landing_page(**kwargs) -> LandingPage

Landing page.

Called with GET /.

Returns:

• LandingPage –

  API landing page, serving as an entry point to the API.

Source code in stac_fastapi/types/core.py

def landing_page(self, **kwargs) -> stac.LandingPage:
    """Landing page.

    Called with `GET /`.

    Returns:
        API landing page, serving as an entry point to the API.
    """
    request: Request = kwargs["request"]
    base_url = get_base_url(request)

    landing_page = self._landing_page(
        base_url=base_url,
        conformance_classes=self.conformance_classes(),
        extension_schemas=[],
    )

    # Add Queryables link
    if self.extension_is_enabled("FilterExtension") or self.extension_is_enabled(
        "SearchFilterExtension"
    ):
        landing_page["links"].append(
            {
                "rel": Relations.queryables.value,
                "type": MimeTypes.jsonschema.value,
                "title": "Queryables available for this Catalog",
                "href": urljoin(base_url, "queryables"),
            }
        )

    # Add Aggregation links
    if self.extension_is_enabled("AggregationExtension"):
        landing_page["links"].extend(
            [
                {
                    "rel": "aggregate",
                    "type": "application/json",
                    "title": "Aggregate",
                    "href": urljoin(base_url, "aggregate"),
                },
                {
                    "rel": "aggregations",
                    "type": "application/json",
                    "title": "Aggregations",
                    "href": urljoin(base_url, "aggregations"),
                },
            ]
        )

    # Add OpenAPI URL
    landing_page["links"].append(
        {
            "rel": Relations.service_desc.value,
            "type": MimeTypes.openapi.value,
            "title": "OpenAPI service description",
            "href": str(request.url_for("openapi")),
        }
    )

    # Add human readable service-doc
    landing_page["links"].append(
        {
            "rel": Relations.service_doc.value,
            "type": MimeTypes.html.value,
            "title": "OpenAPI service documentation",
            "href": str(request.url_for("swagger_ui_html")),
        }
    )

    return stac.LandingPage(**landing_page)

list_conformance_classes

list_conformance_classes()

Return a list of conformance classes, including implemented extensions.

Source code in stac_fastapi/types/core.py

def list_conformance_classes(self):
    """Return a list of conformance classes, including implemented extensions."""
    base_conformance = BASE_CONFORMANCE_CLASSES

    for extension in self.extensions:
        extension_classes = getattr(extension, "conformance_classes", [])
        base_conformance.extend(extension_classes)

    return base_conformance

post_search abstractmethod

post_search(search_request: BaseSearchPostRequest, **kwargs) -> ItemCollection

Cross catalog search (POST).

Called with POST /search.

Parameters:

• search_request (BaseSearchPostRequest) –

  search request parameters.

Returns:

• ItemCollection –

  ItemCollection containing items which match the search criteria.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def post_search(
    self, search_request: BaseSearchPostRequest, **kwargs
) -> stac.ItemCollection:
    """Cross catalog search (POST).

    Called with `POST /search`.

    Args:
        search_request: search request parameters.

    Returns:
        ItemCollection containing items which match the search criteria.
    """
    ...

BaseTransactionsClient

Bases: ABC

Defines a pattern for implementing the STAC API Transaction Extension.

Source code in stac_fastapi/types/core.py

@attr.s  # type:ignore
class BaseTransactionsClient(abc.ABC):
    """Defines a pattern for implementing the STAC API Transaction Extension."""

    @abc.abstractmethod
    def create_item(
        self,
        collection_id: str,
        item: Union[Item, ItemCollection],
        **kwargs,
    ) -> Optional[Union[stac.Item, Response, None]]:
        """Create a new item.

        Called with `POST /collections/{collection_id}/items`.

        Args:
            item: the item or item collection
            collection_id: the id of the collection from the resource path

        Returns:
            The item that was created or None if item collection.
        """
        ...

    @abc.abstractmethod
    def update_item(
        self, collection_id: str, item_id: str, item: Item, **kwargs
    ) -> Optional[Union[stac.Item, Response]]:
        """Perform a complete update on an existing item.

        Called with `PUT /collections/{collection_id}/items`. It is expected
        that this item already exists.  The update should do a diff against the
        saved item and perform any necessary updates.  Partial updates are not
        supported by the transactions extension.

        Args:
            item: the item (must be complete)
            collection_id: the id of the collection from the resource path

        Returns:
            The updated item.
        """
        ...

    @abc.abstractmethod
    def patch_item(
        self,
        collection_id: str,
        item_id: str,
        patch: Union[stac.PartialItem, List[stac.PatchOperation]],
        **kwargs,
    ) -> Optional[Union[stac.Item, Response]]:
        """Update an item from a collection.

        Called with `PATCH /collections/{collection_id}/items/{item_id}`

        example:
            # convert merge patch item to list of operations
            if isinstance(patch, PartialItem):
                patch = patch.operations()

            item = backend.patch_item(collection_id, item_id, patch)

            return item

        Args:
            item_id: id of the item.
            collection_id: id of the collection.
            patch: either the partial item or list of patch operations.

        Returns:
            The patched item.
        """
        ...

    @abc.abstractmethod
    def delete_item(
        self, item_id: str, collection_id: str, **kwargs
    ) -> Optional[Union[stac.Item, Response]]:
        """Delete an item from a collection.

        Called with `DELETE /collections/{collection_id}/items/{item_id}`

        Args:
            item_id: id of the item.
            collection_id: id of the collection.

        Returns:
            The deleted item.
        """
        ...

    @abc.abstractmethod
    def create_collection(
        self, collection: Collection, **kwargs
    ) -> Optional[Union[stac.Collection, Response]]:
        """Create a new collection.

        Called with `POST /collections`.

        Args:
            collection: the collection

        Returns:
            The collection that was created.
        """
        ...

    @abc.abstractmethod
    def update_collection(
        self, collection_id: str, collection: Collection, **kwargs
    ) -> Optional[Union[stac.Collection, Response]]:
        """Perform a complete update on an existing collection.

        Called with `PUT /collections/{collection_id}`. It is expected that this
        collection already exists.  The update should do a diff against the saved
        collection and perform any necessary updates.  Partial updates are not
        supported by the transactions extension.

        Args:
            collection_id: id of the existing collection to be updated
            collection: the updated collection (must be complete)

        Returns:
            The updated collection.
        """
        ...

    @abc.abstractmethod
    def patch_collection(
        self,
        collection_id: str,
        patch: Union[stac.PartialCollection, List[stac.PatchOperation]],
        **kwargs,
    ) -> Optional[Union[stac.Collection, Response]]:
        """Update a collection.

        Called with `PATCH /collections/{collection_id}`

        example:
            # convert merge patch item to list of operations
            if isinstance(patch, PartialCollection):
                patch = patch.operations()

            collection = backend.patch_collection(collection_id, patch)

            return collection

        Args:
            collection_id: id of the collection.
            patch: either the partial collection or list of patch operations.

        Returns:
            The patched collection.
        """
        ...

    @abc.abstractmethod
    def delete_collection(
        self, collection_id: str, **kwargs
    ) -> Optional[Union[stac.Collection, Response]]:
        """Delete a collection.

        Called with `DELETE /collections/{collection_id}`

        Args:
            collection_id: id of the collection.

        Returns:
            The deleted collection.
        """
        ...

create_collection abstractmethod

create_collection(collection: Collection, **kwargs) -> Optional[Union[Collection, Response]]

Create a new collection.

Called with POST /collections.

Parameters:

• collection (Collection) –

  the collection

Returns:

• Optional[Union[Collection, Response]] –

  The collection that was created.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def create_collection(
    self, collection: Collection, **kwargs
) -> Optional[Union[stac.Collection, Response]]:
    """Create a new collection.

    Called with `POST /collections`.

    Args:
        collection: the collection

    Returns:
        The collection that was created.
    """
    ...

create_item abstractmethod

create_item(
    collection_id: str, item: Union[Item, ItemCollection], **kwargs
) -> Optional[Union[Item, Response, None]]

Create a new item.

Called with POST /collections/{collection_id}/items.

Parameters:

• item (Union[Item, ItemCollection]) –

  the item or item collection

• collection_id (str) –

  the id of the collection from the resource path

Returns:

• Optional[Union[Item, Response, None]] –

  The item that was created or None if item collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def create_item(
    self,
    collection_id: str,
    item: Union[Item, ItemCollection],
    **kwargs,
) -> Optional[Union[stac.Item, Response, None]]:
    """Create a new item.

    Called with `POST /collections/{collection_id}/items`.

    Args:
        item: the item or item collection
        collection_id: the id of the collection from the resource path

    Returns:
        The item that was created or None if item collection.
    """
    ...

delete_collection abstractmethod

delete_collection(collection_id: str, **kwargs) -> Optional[Union[Collection, Response]]

Delete a collection.

Called with DELETE /collections/{collection_id}

Parameters:

• collection_id (str) –

  id of the collection.

Returns:

• Optional[Union[Collection, Response]] –

  The deleted collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def delete_collection(
    self, collection_id: str, **kwargs
) -> Optional[Union[stac.Collection, Response]]:
    """Delete a collection.

    Called with `DELETE /collections/{collection_id}`

    Args:
        collection_id: id of the collection.

    Returns:
        The deleted collection.
    """
    ...

delete_item abstractmethod

delete_item(item_id: str, collection_id: str, **kwargs) -> Optional[Union[Item, Response]]

Delete an item from a collection.

Called with DELETE /collections/{collection_id}/items/{item_id}

Parameters:

• item_id (str) –

  id of the item.

• collection_id (str) –

  id of the collection.

Returns:

• Optional[Union[Item, Response]] –

  The deleted item.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def delete_item(
    self, item_id: str, collection_id: str, **kwargs
) -> Optional[Union[stac.Item, Response]]:
    """Delete an item from a collection.

    Called with `DELETE /collections/{collection_id}/items/{item_id}`

    Args:
        item_id: id of the item.
        collection_id: id of the collection.

    Returns:
        The deleted item.
    """
    ...

patch_collection abstractmethod

patch_collection(
    collection_id: str, patch: Union[PartialCollection, List[PatchOperation]], **kwargs
) -> Optional[Union[Collection, Response]]

Update a collection.

Called with PATCH /collections/{collection_id}

example

convert merge patch item to list of operations

if isinstance(patch, PartialCollection): patch = patch.operations()

collection = backend.patch_collection(collection_id, patch)

return collection

Parameters:

• collection_id (str) –

  id of the collection.

• patch (Union[PartialCollection, List[PatchOperation]]) –

  either the partial collection or list of patch operations.

Returns:

• Optional[Union[Collection, Response]] –

  The patched collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def patch_collection(
    self,
    collection_id: str,
    patch: Union[stac.PartialCollection, List[stac.PatchOperation]],
    **kwargs,
) -> Optional[Union[stac.Collection, Response]]:
    """Update a collection.

    Called with `PATCH /collections/{collection_id}`

    example:
        # convert merge patch item to list of operations
        if isinstance(patch, PartialCollection):
            patch = patch.operations()

        collection = backend.patch_collection(collection_id, patch)

        return collection

    Args:
        collection_id: id of the collection.
        patch: either the partial collection or list of patch operations.

    Returns:
        The patched collection.
    """
    ...

patch_item abstractmethod

patch_item(
    collection_id: str, item_id: str, patch: Union[PartialItem, List[PatchOperation]], **kwargs
) -> Optional[Union[Item, Response]]

Update an item from a collection.

Called with PATCH /collections/{collection_id}/items/{item_id}

example

convert merge patch item to list of operations

if isinstance(patch, PartialItem): patch = patch.operations()

item = backend.patch_item(collection_id, item_id, patch)

return item

Parameters:

• item_id (str) –

  id of the item.

• collection_id (str) –

  id of the collection.

• patch (Union[PartialItem, List[PatchOperation]]) –

  either the partial item or list of patch operations.

Returns:

• Optional[Union[Item, Response]] –

  The patched item.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def patch_item(
    self,
    collection_id: str,
    item_id: str,
    patch: Union[stac.PartialItem, List[stac.PatchOperation]],
    **kwargs,
) -> Optional[Union[stac.Item, Response]]:
    """Update an item from a collection.

    Called with `PATCH /collections/{collection_id}/items/{item_id}`

    example:
        # convert merge patch item to list of operations
        if isinstance(patch, PartialItem):
            patch = patch.operations()

        item = backend.patch_item(collection_id, item_id, patch)

        return item

    Args:
        item_id: id of the item.
        collection_id: id of the collection.
        patch: either the partial item or list of patch operations.

    Returns:
        The patched item.
    """
    ...

update_collection abstractmethod

update_collection(
    collection_id: str, collection: Collection, **kwargs
) -> Optional[Union[Collection, Response]]

Perform a complete update on an existing collection.

Called with PUT /collections/{collection_id}. It is expected that this collection already exists. The update should do a diff against the saved collection and perform any necessary updates. Partial updates are not supported by the transactions extension.

Parameters:

• collection_id (str) –

  id of the existing collection to be updated

• collection (Collection) –

  the updated collection (must be complete)

Returns:

• Optional[Union[Collection, Response]] –

  The updated collection.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def update_collection(
    self, collection_id: str, collection: Collection, **kwargs
) -> Optional[Union[stac.Collection, Response]]:
    """Perform a complete update on an existing collection.

    Called with `PUT /collections/{collection_id}`. It is expected that this
    collection already exists.  The update should do a diff against the saved
    collection and perform any necessary updates.  Partial updates are not
    supported by the transactions extension.

    Args:
        collection_id: id of the existing collection to be updated
        collection: the updated collection (must be complete)

    Returns:
        The updated collection.
    """
    ...

update_item abstractmethod

update_item(
    collection_id: str, item_id: str, item: Item, **kwargs
) -> Optional[Union[Item, Response]]

Perform a complete update on an existing item.

Called with PUT /collections/{collection_id}/items. It is expected that this item already exists. The update should do a diff against the saved item and perform any necessary updates. Partial updates are not supported by the transactions extension.

Parameters:

• item (Item) –

  the item (must be complete)

• collection_id (str) –

  the id of the collection from the resource path

Returns:

• Optional[Union[Item, Response]] –

  The updated item.

Source code in stac_fastapi/types/core.py

@abc.abstractmethod
def update_item(
    self, collection_id: str, item_id: str, item: Item, **kwargs
) -> Optional[Union[stac.Item, Response]]:
    """Perform a complete update on an existing item.

    Called with `PUT /collections/{collection_id}/items`. It is expected
    that this item already exists.  The update should do a diff against the
    saved item and perform any necessary updates.  Partial updates are not
    supported by the transactions extension.

    Args:
        item: the item (must be complete)
        collection_id: the id of the collection from the resource path

    Returns:
        The updated item.
    """
    ...

LandingPageMixin

Bases: ABC

Create a STAC landing page (GET /).

Source code in stac_fastapi/types/core.py

@attr.s
class LandingPageMixin(abc.ABC):
    """Create a STAC landing page (GET /)."""

    stac_version: str = attr.ib(default=STAC_VERSION)
    landing_page_id: str = attr.ib(default=api_settings.stac_fastapi_landing_id)
    title: str = attr.ib(default=api_settings.stac_fastapi_title)
    description: str = attr.ib(default=api_settings.stac_fastapi_description)

    def _landing_page(
        self,
        base_url: str,
        conformance_classes: List[str],
        extension_schemas: List[str],
    ) -> stac.LandingPage:
        landing_page = stac.LandingPage(
            type="Catalog",
            id=self.landing_page_id,
            title=self.title,
            description=self.description,
            stac_version=self.stac_version,
            conformsTo=conformance_classes,
            links=[
                {
                    "rel": Relations.self.value,
                    "type": MimeTypes.json.value,
                    "title": "This document",
                    "href": base_url,
                },
                {
                    "rel": Relations.root.value,
                    "type": MimeTypes.json.value,
                    "title": "Root",
                    "href": base_url,
                },
                {
                    "rel": Relations.data.value,
                    "type": MimeTypes.json.value,
                    "title": "Collections available for this Catalog",
                    "href": urljoin(base_url, "collections"),
                },
                {
                    "rel": Relations.conformance.value,
                    "type": MimeTypes.json.value,
                    "title": "STAC/OGC conformance classes implemented by this server",
                    "href": urljoin(base_url, "conformance"),
                },
                {
                    "rel": Relations.search.value,
                    "type": MimeTypes.geojson.value,
                    "title": "STAC search [GET]",
                    "href": urljoin(base_url, "search"),
                    "method": "GET",
                },
                {
                    "rel": Relations.search.value,
                    "type": MimeTypes.geojson.value,
                    "title": "STAC search [POST]",
                    "href": urljoin(base_url, "search"),
                    "method": "POST",
                },
            ],
            stac_extensions=extension_schemas,
        )

        return landing_page