Skip to content

sort

stac_fastapi.extensions.core.sort.sort

Sort extension.

SortConformanceClasses

Bases: str, Enum

Conformance classes for the Sort extension.

See stac-api-extensions/sort

Source code in stac_fastapi/extensions/core/sort/sort.py 
14
15
16
17
18
19
20
21
22
23
class SortConformanceClasses(str, Enum):
    """Conformance classes for the Sort extension.

    See https://github.com/stac-api-extensions/sort

    """

    SEARCH = "https://api.stacspec.org/v1.0.0/item-search#sort"
    ITEMS = "https://api.stacspec.org/v1.0.0/ogcapi-features#sort"
    COLLECTIONS = "https://api.stacspec.org/v1.0.0-rc.1/collection-search#sort"

SortExtension

Bases: ApiExtension

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

Source code in stac_fastapi/extensions/core/sort/sort.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@attr.s
class SortExtension(ApiExtension):
    """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.
    https://github.com/stac-api-extensions/sort
    """

    GET = SortExtensionGetRequest
    POST = SortExtensionPostRequest

    conformance_classes: List[str] = attr.ib(
        factory=lambda: [
            SortConformanceClasses.SEARCH,
        ]
    )
    schema_href: Optional[str] = attr.ib(default=None)

    def register(self, app: FastAPI) -> None:
        """Register the extension with a FastAPI application.

        Args:
            app: target FastAPI application.

        Returns:
            None
        """
        pass

register 

register(app: FastAPI) -> None

Register the extension with a FastAPI application.

Parameters:

  • app (FastAPI) –

    target FastAPI application.

Returns:

  • None –

    None

Source code in stac_fastapi/extensions/core/sort/sort.py 
45
46
47
48
49
50
51
52
53
54
def register(self, app: FastAPI) -> None:
    """Register the extension with a FastAPI application.

    Args:
        app: target FastAPI application.

    Returns:
        None
    """
    pass