Merge branch 'stac-utils:main' into aggregation

CHANGES.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## [Unreleased]
+## [3.0.0a0] - 2024-05-06
 
 ### Added
 
@@ -14,6 +14,7 @@
 * Fix response model validation ([#625](https://github.com/stac-utils/stac-fastapi/pull/625))
 * Use status code 201 for Item/Collection creation ([#625](https://github.com/stac-utils/stac-fastapi/pull/625))
 * Replace Black with Ruff Format ([#625](https://github.com/stac-utils/stac-fastapi/pull/625))
+* add `response_class` in the route definitions for `FilterExtension`
 
 ## [2.5.5.post1] - 2024-04-25
 
@@ -360,7 +361,8 @@
 
 * First PyPi release!
 
-[Unreleased]: <https://github.com/stac-utils/stac-fastapi/compare/2.5.5.post1..main>
+[Unreleased]: <https://github.com/stac-utils/stac-fastapi/compare/3.0.0a0..main>
+[3.0.0a0]: <https://github.com/stac-utils/stac-fastapi/compare/2.5.5.post1..3.0.0a0>
 [2.5.5.post1]: <https://github.com/stac-utils/stac-fastapi/compare/2.5.5..2.5.5.post1>
 [2.5.5]: <https://github.com/stac-utils/stac-fastapi/compare/2.5.4..2.5.5>
 [2.5.4]: <https://github.com/stac-utils/stac-fastapi/compare/2.5.3..2.5.4>

RELEASING.md

@@ -5,6 +5,12 @@ This is a checklist for releasing a new version of **stac-fastapi**.
 1. Determine the next version. We currently do not have published versioning guidelines, but there is some text on the subject here: <https://github.com/radiantearth/stac-spec/discussions/1184>.
 2. Create a release branch named `release/vX.Y.Z`, where `X.Y.Z` is the new version.
 3. Search and replace all instances of the current version number with the new version. As of this writing, there's 3 different `version.py` files, and one `VERSION` file, in the repo.
+
+    Note: You can use [`bump-my-version`](https://github.com/callowayproject/bump-my-version) CLI
+    ```
+    bump-my-version bump --new-version 3.1.0
+    ```
+
 4. Update [CHANGES.md](./CHANGES.md) for the new version. Add the appropriate header, and update the links at the bottom of the file.
 5. Audit CHANGES.md for completeness and accuracy. Also, ensure that the changes in this version are appropriate for the version number change (i.e. if you're making breaking changes, you should be increasing the `MAJOR` version number).
 6. (optional) If you have permissions, run `scripts/publish --test` to test your PyPI publish. If successful, the published packages will be available on <http://test.pypy.org>.

VERSION

@@ -1 +1 @@
-2.5.5.post1
+3.0.0a0

pyproject.toml

@@ -22,3 +22,50 @@ section-order = ["future", "standard-library", "third-party", "first-party", "lo
 
 [tool.ruff.format]
 quote-style = "double"
+
+[tool.bumpversion]
+current_version = "3.0.0a0"
+parse = """(?x)
+    (?P<major>\\d+)\\.
+    (?P<minor>\\d+)\\.
+    (?P<patch>\\d+)
+    (?:
+        (?P<pre_l>a|b|rc)   # pre-release label
+        (?P<pre_n>\\d+)     # pre-release version number
+    )?                      # pre-release section is optional
+    (?:
+        \\.post
+        (?P<post_n>\\d+)    # post-release version number
+    )?                      # post-release section is optional
+"""
+serialize = [
+    "{major}.{minor}.{patch}.post{post_n}",
+    "{major}.{minor}.{patch}{pre_l}{pre_n}",
+    "{major}.{minor}.{patch}",
+]
+
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+tag = false
+commit = true
+
+[[tool.bumpversion.files]]
+filename = "VERSION"
+search = "{current_version}"
+replace = "{new_version}"
+
+[[tool.bumpversion.files]]
+filename = "stac_fastapi/api/stac_fastapi/api/version.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "stac_fastapi/extensions/stac_fastapi/extensions/version.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "stac_fastapi/types/stac_fastapi/types/version.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'

stac_fastapi/api/stac_fastapi/api/version.py

@@ -1,2 +1,2 @@
 """Library version."""
-__version__ = "2.5.5.post1"
+__version__ = "3.0.0a0"

stac_fastapi/extensions/stac_fastapi/extensions/core/filter/filter.py

@@ -97,16 +97,30 @@ def register(self, app: FastAPI) -> None:
             name="Queryables",
             path="/queryables",
             methods=["GET"],
-            endpoint=create_async_endpoint(
-                self.client.get_queryables, EmptyRequest, self.response_class
-            ),
+            responses={
+                200: {
+                    "content": {
+                        "application/schema+json": {},
+                    },
+                    # TODO: add output model in stac-pydantic
+                },
+            },
+            response_class=self.response_class,
+            endpoint=create_async_endpoint(self.client.get_queryables, EmptyRequest),
         )
         self.router.add_api_route(
             name="Collection Queryables",
             path="/collections/{collection_id}/queryables",
             methods=["GET"],
-            endpoint=create_async_endpoint(
-                self.client.get_queryables, CollectionUri, self.response_class
-            ),
+            responses={
+                200: {
+                    "content": {
+                        "application/schema+json": {},
+                    },
+                    # TODO: add output model in stac-pydantic
+                },
+            },
+            response_class=self.response_class,
+            endpoint=create_async_endpoint(self.client.get_queryables, CollectionUri),
         )
         app.include_router(self.router, tags=["Filter Extension"])

stac_fastapi/extensions/stac_fastapi/extensions/version.py

@@ -1,2 +1,2 @@
 """Library version."""
-__version__ = "2.5.5.post1"
+__version__ = "3.0.0a0"

stac_fastapi/types/stac_fastapi/types/version.py

@@ -1,2 +1,2 @@
 """Library version."""
-__version__ = "2.5.5.post1"
+__version__ = "3.0.0a0"