Merge branch 'main' of github.com:stac-utils/stac-fastapi into patch_endpoints

Author: rhysrevans3

.github/workflows/cicd.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     timeout-minutes: 20
 
     steps:
@@ -24,7 +24,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Lint code
-        if: ${{ matrix.python-version == 3.8 }}
+        if: ${{ matrix.python-version == 3.13 }}
         run: |
           python -m pip install pre-commit
           pre-commit run --all-files
@@ -63,7 +63,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.13"
 
       - name: Install types
         run: |

.github/workflows/publish.yml

@@ -27,4 +27,4 @@ jobs:
           TWINE_USERNAME: ${{ secrets.PYPI_STACUTILS_USERNAME }}
           TWINE_PASSWORD: ${{ secrets.PYPI_STACUTILS_PASSWORD }}
         run: |
-          scripts/publish
+          scripts/publish

CHANGES.md

@@ -4,9 +4,134 @@
 
 * Add Item and Collection `PATCH` endpoints with support for [RFC 6902](https://tools.ietf.org/html/rfc6902) and [RFC 7396](https://tools.ietf.org/html/rfc7386)
 
+## [5.1.1] - 2025-03-17
+
+### Fixed
+
+- allow bbox with 6 coordinates (3D) in `GET` requests
+
+## [5.1.0] - 2025-03-07
+
+### Added
+
+- titles in `Landing` page links
+
+### Changed
+
+- remove `child` links (`collections`) in landing page response
+
+## [5.0.3] - 2025-03-03
+
+### Added
+
+- added descriptive message to `types.search.str2bbox` length assert
+
+### Fixed
+
+- fix collection-search POST request model:
+  - fix pydantic model to make sure class variables `_start_date` and `_end_date` not edited (ported from stac-pydantic)
+  - fix bbox validation to allow anti-meridian crossing (ported from stac-pydantic)
+
+## [5.0.2] - 2025-01-30
+
+### Fixed
+
+- forward `prefix` to `ItemCollectionFilterExtension.router`
+
+## [5.0.1] - 2025-01-30
+
+### Fixed
+
+- add `Queryables` links when `SearchFilterExtension` is enabled
+
+## [5.0.0] - 2025-01-30
+
+### Changed
+
+- refactored conformance classes for extensions
+
+  - renamed `collection_search.ConformanceClasses` -> `collection_search.CollectionSearchConformanceClasses`
+  - removed `FREETEXT`, `FILTER`, `QUERY`, `SORT` and `FIELDS` entries from the `CollectionSearchConformanceClasses` Enum (and moved to each extension's Enum)
+  - changed `collection_search.CollectionSearchPostExtension.from_extension(ext)` to use the conformance classes from the input extensions to derive the output conformance classes.
+  - added `fields.FieldsConformanceClasses` Enum
+  - renamed `filter.FilterConformanceClasses.FEATURES_FILTER` -> `filter.FilterConformanceClasses.ITEMS`
+  - renamed `filter.FilterConformanceClasses.ITEM_SEARCH_FILTER` -> `filter.FilterConformanceClasses.SEARCH`
+  - added `filter.FilterConformanceClasses.COLLECTIONS`
+  - added `filter.SearchFilterExtension`, `filter.ItemCollectionFilterExtension` and `filter.CollectionSearchFilterExtension` endpoint specific extensions
+  - removed `FreeTextConformanceClasses.COLLECTIONS` and `FreeTextConformanceClasses.ITEMS` in `FreeTextExtension` and `FreeTextAdvancedExtension` default conformances classes
+  - added `query.QueryConformanceClasses` Enum
+  - added `SortConformanceClasses` Enum
+
+- removed `StacApi.customize_openapi` method
+- reordered `StacApi` attributes (moved `title`, `api_version` and `description` before `app`)
+
+### Added
+
+* forward `StacApi.title`, `StacApi.api_version` and `Stac.Api.description` to the FastAPI application
+
+## [4.0.1] - 2025-01-23
+
+### Changed
+
+- sort conformance classes
+
+### Fixed
+
+* support `forwarded` headers in `ProxyHeaderMiddleware` that do not contain a host key ([#788](https://github.com/stac-utils/stac-fastapi/pull/788))
+
+## [4.0.0] - 2025-01-17
+
+### Changed
+
+* use `string` type instead of python `datetime.datetime` for datetime parameter in `BaseSearchGetRequest`, `ItemCollectionUri` and `BaseCollectionSearchGetRequest` GET models
+* rename `filter` to `filter_expr` for `FilterExtensionGetRequest` and `FilterExtensionPostRequest` attributes to avoid conflict with python filter method
+* remove deprecated `post_request_model` attribute in `BaseCoreClient` and `AsyncBaseCoreClient`
+* remove `python3.8` support
+
+### Fixed
+
+* Support multiple proxy servers in the `forwarded` header in `ProxyHeaderMiddleware` ([#782](https://github.com/stac-utils/stac-fastapi/pull/782))
+
+## [3.0.5] - 2025-01-10
+
+### Removed
+
+* Remove `warnings` in `CollectionSearchExtension.from_extensions()` methods when passing `unknown` extensions
+
+## [3.0.4] - 2025-01-08
+
+### Removed
+
+* Remove deprecated `context` property in `types.stac.ItemCollection` model
+
+### Added
+
+* Add `numberMatched` and `numberReturned` properties in `types.stac.ItemCollection` model
+* Add `numberMatched` and `numberReturned` properties in `types.stac.Collections` model
+* Add `root_path` to `stac_fastapi.types.config.ApiSettings` and use it in the default FastAPI application
+* Add `python3.13` support
+
+## Changed
+
+* Use `stac_pydantic.version.STAC_VERSION` instead of `stac_pydantic.api.version.STAC_API_VERSION` as application `stac_version`
+* Return more informations from pydantic validation errors
+* Add deprecation notice for `post_request_model` attribute in `BaseCoreClient` and `AsyncBaseCoreClient`
+
+## [3.0.3] - 2024-10-09
+
+### Removed
+
+* Removed `cql2-text` in supported `filter-lang` for `FilterExtensionPostRequest` model (as per specification)
+
+### Added
+
+* Add `OffsetPaginationExtension` extension to add `offset` query/body parameter to endpoints
+
+## [3.0.2] - 2024-09-20
+
 ### Added
 
-* Add `from_extensions()` method to `CollectionSearchExtension` and `CollectionSearchPostExtension` extensions to build the class based on a list of available extensions.
+* Add `from_extensions()` method to `CollectionSearchExtension` and `CollectionSearchPostExtension` extensions to build the class based on a list of available extensions ([#745](https://github.com/stac-utils/stac-fastapi/pull/745))
 
 ## [3.0.1] - 2024-08-27
 
@@ -479,7 +604,19 @@ Full changelog: https://stac-utils.github.io/stac-fastapi/migrations/v3.0.0/#cha
 
 * First PyPi release!
 
-[Unreleased]: <https://github.com/stac-utils/stac-fastapi/compare/3.0.1..main>
+[Unreleased]: <https://github.com/stac-utils/stac-fastapi/compare/5.1.1..main>
+[5.1.1]: <https://github.com/stac-utils/stac-fastapi/compare/5.1.0..5.1.1>
+[5.1.0]: <https://github.com/stac-utils/stac-fastapi/compare/5.0.3..5.1.0>
+[5.0.3]: <https://github.com/stac-utils/stac-fastapi/compare/5.0.2..5.0.3>
+[5.0.2]: <https://github.com/stac-utils/stac-fastapi/compare/5.0.1..5.0.2>
+[5.0.1]: <https://github.com/stac-utils/stac-fastapi/compare/5.0.0..5.0.1>
+[5.0.0]: <https://github.com/stac-utils/stac-fastapi/compare/4.0.1..5.0.0>
+[4.0.1]: <https://github.com/stac-utils/stac-fastapi/compare/4.0.0..4.0.1>
+[4.0.0]: <https://github.com/stac-utils/stac-fastapi/compare/3.0.5..4.0.0>
+[3.0.5]: <https://github.com/stac-utils/stac-fastapi/compare/3.0.4..3.0.5>
+[3.0.4]: <https://github.com/stac-utils/stac-fastapi/compare/3.0.3..3.0.4>
+[3.0.3]: <https://github.com/stac-utils/stac-fastapi/compare/3.0.2..3.0.3>
+[3.0.2]: <https://github.com/stac-utils/stac-fastapi/compare/3.0.1..3.0.2>
 [3.0.1]: <https://github.com/stac-utils/stac-fastapi/compare/3.0.0..3.0.1>
 [3.0.0]: <https://github.com/stac-utils/stac-fastapi/compare/2.5.5.post1..3.0.0>
 [2.5.5.post1]: <https://github.com/stac-utils/stac-fastapi/compare/2.5.5..2.5.5.post1>

README.md

@@ -8,9 +8,6 @@
   <a href="https://github.com/stac-utils/stac-fastapi/actions?query=workflow%3Acicd" target="_blank">
       <img src="https://github.com/stac-utils/stac-fastapi/workflows/stac-fastapi/badge.svg" alt="Test">
   </a>
-  <a href="https://pypi.org/project/stac-fastapi" target="_blank">
-      <img src="https://img.shields.io/pypi/v/stac-fastapi.api?color=%2334D058&label=pypi%20package" alt="Package version">
-  </a>
   <a href="https://github.com/stac-utils/stac-fastapi/blob/main/LICENSE" target="_blank">
       <img src="https://img.shields.io/github/license/stac-utils/stac-fastapi.svg" alt="License">
   </a>
@@ -27,17 +24,19 @@
 Python library for building a STAC compliant FastAPI application.  The project is split up into several namespace
 packages:
 
-- **stac_fastapi.api**: An API layer which enforces the [stac-api-spec](https://github.com/radiantearth/stac-api-spec).
-- **stac_fastapi.extensions**: Abstract base classes for [STAC API extensions](https://github.com/radiantearth/stac-api-spec/blob/master/extensions.md) and third-party extensions.
-- **stac_fastapi.types**: Shared types and abstract base classes used by the library.
+| Package |  Description | Version
+| ------- |------------- | -------
+[**stac_fastapi.api**](https://github.com/stac-utils/stac-fastapi/tree/main/stac_fastapi/api) | An API layer which enforces the [stac-api-spec](https://github.com/radiantearth/stac-api-spec). | [![stac-fastapi.api](https://img.shields.io/pypi/v/stac-fastapi.api?color=%2334D058&label=pypi)](https://pypi.org/project/stac-fastapi.api)
+[**stac_fastapi.extensions**](https://github.com/stac-utils/stac-fastapi/tree/main/stac_fastapi/extensions) | Abstract base classes for [STAC API extensions](https://github.com/radiantearth/stac-api-spec/blob/master/extensions.md) and third-party extensions. | [![stac-fastapi.extensions](https://img.shields.io/pypi/v/stac-fastapi.extensions?color=%2334D058&label=pypi)](https://pypi.org/project/stac-fastapi.extensions)
+[**stac_fastapi.types**](https://github.com/stac-utils/stac-fastapi/tree/main/stac_fastapi/types) | Shared types and abstract base classes used by the library. | [![stac-fastapi.types](https://img.shields.io/pypi/v/stac-fastapi.types?color=%2334D058&label=pypi)](https://pypi.org/project/stac-fastapi.types)
 
 #### Backends
 
 Backends are hosted in their own repositories:
 
 - [stac-fastapi-pgstac](https://github.com/stac-utils/stac-fastapi-pgstac): Postgres backend implementation with [PgSTAC](https://github.com/stac-utils/pgstac).
+- [stac-fastapi-elasticsearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch): Backend implementation with [Elasticsearch](https://github.com/elastic/elasticsearch).
 - [stac-fastapi-sqlalchemy](https://github.com/stac-utils/stac-fastapi-sqlalchemy): Postgres backend implementation with [sqlalchemy](https://www.sqlalchemy.org/).
-- [stac-fastapi-elasticsearch](https://github.com/stac-utils/stac-fastapi-elasticsearch): Backend implementation with [Elasticsearch](https://github.com/elastic/elasticsearch).
 
 `stac-fastapi` was initially developed by [arturo-ai](https://github.com/arturo-ai).
 

VERSION

@@ -1 +1 @@
-3.0.1
+5.1.1

docs/mkdocs.yml

@@ -80,6 +80,7 @@ nav:
           - version: api/stac_fastapi/types/version.md
   - Migration Guides:
     - v2.5 -> v3.0: migrations/v3.0.0.md
+    - v3.0 -> v4.0: migrations/v4.0.0.md
   - Performance Benchmarks: benchmarks.html
   - Development - Contributing: "contributing.md"
   - Release Notes: "release-notes.md"