Skip to content

Commit 612c979

Browse files
committed
enable direct response to readme
1 parent 900a5dd commit 612c979

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,12 @@
2929
- There is [Postman](https://documenter.getpostman.com/view/12888943/2s8ZDSdRHA) documentation here for examples on how to run some of the API routes locally - after starting the elasticsearch backend via the compose.yml file.
3030
- The `/examples` folder shows an example of running stac-fastapi-elasticsearch from PyPI in docker without needing any code from the repository. There is also a Postman collection here that you can load into Postman for testing the API routes.
3131

32-
- For changes, see the [Changelog](CHANGELOG.md)
33-
- We are always welcoming contributions. For the development notes: [Contributing](CONTRIBUTING.md)
32+
33+
### Performance Note
34+
35+
The `enable_direct_response` option is provided by the stac-fastapi core library (introduced in stac-fastapi 5.2.0) and is available in this project starting from v4.0.0. When enabled, it allows endpoints to return Starlette Response objects directly, bypassing FastAPI's default serialization for improved performance.
36+
37+
See: [issue #347](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/issues/347)
3438

3539

3640
### To install from PyPI:

0 commit comments

Comments
 (0)