add numberMatched/Returned properties in model (#759)

Author: vincentsarago

CHANGES.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+### Removed
+
+* Remove deprecated `context` property in `types.stac.ItemCollection` model
+
+### Added
+
+* Add `numberMatched` and `numberReturned` properties in `types.stac.ItemCollection` model
+
 ## [3.0.3] - 2024-10-09
 
 ### Removed

docs/src/tips-and-tricks.md

@@ -20,23 +20,6 @@ middlewares=[lambda app: CORSMiddleware(app, allow_origins=["*"])]
 
 If needed, you can edit the `allow_origins` parameter to only allow CORS requests from specific origins.
 
-## Enable the Context extension
-
-!!! Warning
-
-    The `ContextExtension` is deprecated and will be removed in 3.0. See https://github.com/radiantearth/stac-api-spec/issues/396
-
-The Context STAC extension provides information on the number of items matched and returned from a STAC search.
-This is required by various other STAC-related tools, such as the pystac command-line client.
-To enable the extension, edit your backend's `app.py` and add the following import:
-
-```python
-from stac_fastapi.extensions.core.context import ContextExtension
-```
-
-
-and then edit the `api = StacApi(...` call to add `ContextExtension()` to the list given as the `extensions` parameter.
-
 ## Set API title, description and version
 
 For the landing page, you can set the API title, description and version using environment variables.

stac_fastapi/types/stac_fastapi/types/stac.py

@@ -73,7 +73,8 @@ class ItemCollection(TypedDict, total=False):
     type: Literal["FeatureCollection"]
     features: List[Item]
     links: List[Dict[str, Any]]
-    context: Optional[Dict[str, int]]
+    numberMatched: Optional[int]
+    numberReturned: Optional[int]
 
 
 class Collections(TypedDict, total=False):