From d62e029d0d0a3b49b0cf60b218523fa1faefa45d Mon Sep 17 00:00:00 2001 From: James Date: Mon, 11 Mar 2024 11:53:23 -0400 Subject: [PATCH 1/8] set title and description with env vars --- stac_fastapi/elasticsearch/README.md | 4 +++- .../elasticsearch/stac_fastapi/elasticsearch/app.py | 4 ++++ stac_fastapi/opensearch/README.md | 6 +++++- stac_fastapi/opensearch/stac_fastapi/opensearch/app.py | 4 ++++ 4 files changed, 16 insertions(+), 2 deletions(-) diff --git a/stac_fastapi/elasticsearch/README.md b/stac_fastapi/elasticsearch/README.md index becdb4d70..85e9dd1d0 100644 --- a/stac_fastapi/elasticsearch/README.md +++ b/stac_fastapi/elasticsearch/README.md @@ -1,3 +1,5 @@ -# Requirements +# stac-fastapi-elasticsearch + +## Requirements The Elasticsearch backend requires **elasticsearch**. diff --git a/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py b/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py index 0d8965349..032378f5d 100644 --- a/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py +++ b/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py @@ -1,5 +1,7 @@ """FastAPI application.""" +import os + from stac_fastapi.api.app import StacApi from stac_fastapi.api.models import create_get_request_model, create_post_request_model from stac_fastapi.core.core import ( @@ -60,6 +62,8 @@ post_request_model = create_post_request_model(extensions) api = StacApi( + title=os.getenv("STAC_API_TITLE", "stac-fastapi"), + description=os.getenv("STAC_API_DESCRIPTION", "stac-fastapi"), settings=settings, extensions=extensions, client=CoreClient( diff --git a/stac_fastapi/opensearch/README.md b/stac_fastapi/opensearch/README.md index 6b1f8391f..a855d5001 100644 --- a/stac_fastapi/opensearch/README.md +++ b/stac_fastapi/opensearch/README.md @@ -1 +1,5 @@ -# stac-fastapi-opensearch \ No newline at end of file +# stac-fastapi-opensearch + +## Requirements + +The Elasticsearch backend requires **opensearch**. \ No newline at end of file diff --git a/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py b/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py index ebb2921e6..ec3a179ea 100644 --- a/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py +++ b/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py @@ -1,5 +1,7 @@ """FastAPI application.""" +import os + from stac_fastapi.api.app import StacApi from stac_fastapi.api.models import create_get_request_model, create_post_request_model from stac_fastapi.core.core import ( @@ -60,6 +62,8 @@ post_request_model = create_post_request_model(extensions) api = StacApi( + title=os.getenv("STAC_API_TITLE", "stac-fastapi"), + description=os.getenv("STAC_API_DESCRIPTION", "stac-fastapi"), settings=settings, extensions=extensions, client=CoreClient( From 3ce432687aaa75cfbb00b3ccd505667c8aece353 Mon Sep 17 00:00:00 2001 From: James Date: Mon, 11 Mar 2024 11:54:37 -0400 Subject: [PATCH 2/8] opensearch readme update --- stac_fastapi/opensearch/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stac_fastapi/opensearch/README.md b/stac_fastapi/opensearch/README.md index a855d5001..2b1e991f4 100644 --- a/stac_fastapi/opensearch/README.md +++ b/stac_fastapi/opensearch/README.md @@ -2,4 +2,4 @@ ## Requirements -The Elasticsearch backend requires **opensearch**. \ No newline at end of file +The Opensearch backend requires **opensearch**. \ No newline at end of file From 85b8c2906840219b803449c4b7ea10a6c801bc7b Mon Sep 17 00:00:00 2001 From: James Date: Mon, 11 Mar 2024 12:16:50 -0400 Subject: [PATCH 3/8] chagelog update --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 63e8b7968..f465d384e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added +- Added API `title` and `description` parameters from environment variables `STAC_API_TITLE` and `STAC_API_DESCRIPTION`, respectively. [#207](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/207) + ### Changed ### Fixed From d2347afe7f244275899516d331bc07928a41bf5a Mon Sep 17 00:00:00 2001 From: James Date: Mon, 11 Mar 2024 18:59:30 -0400 Subject: [PATCH 4/8] rename env vars --- stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py b/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py index 032378f5d..d11f013f2 100644 --- a/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py +++ b/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py @@ -62,8 +62,8 @@ post_request_model = create_post_request_model(extensions) api = StacApi( - title=os.getenv("STAC_API_TITLE", "stac-fastapi"), - description=os.getenv("STAC_API_DESCRIPTION", "stac-fastapi"), + title=os.getenv("STAC_FASTAPI_TITLE", "stac-fastapi"), + description=os.getenv("STAC_FASTAPI_DESCRIPTION", "stac-fastapi"), settings=settings, extensions=extensions, client=CoreClient( From 23513cd76daa236daa9aadbec767f96e404df340 Mon Sep 17 00:00:00 2001 From: James Date: Mon, 11 Mar 2024 19:55:48 -0400 Subject: [PATCH 5/8] update opensearch env var name --- stac_fastapi/opensearch/stac_fastapi/opensearch/app.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py b/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py index ec3a179ea..8164385eb 100644 --- a/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py +++ b/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py @@ -62,8 +62,8 @@ post_request_model = create_post_request_model(extensions) api = StacApi( - title=os.getenv("STAC_API_TITLE", "stac-fastapi"), - description=os.getenv("STAC_API_DESCRIPTION", "stac-fastapi"), + title=os.getenv("STAC_FASTAPI_TITLE", "stac-fastapi"), + description=os.getenv("STAC_FASTAPI_DESCRIPTION", "stac-fastapi"), settings=settings, extensions=extensions, client=CoreClient( From ce01cc97335b6ce87023008f69e1c6f11545fe9d Mon Sep 17 00:00:00 2001 From: James Date: Tue, 12 Mar 2024 11:03:35 -0400 Subject: [PATCH 6/8] api version and default info --- .../elasticsearch/stac_fastapi/elasticsearch/app.py | 5 +++-- stac_fastapi/opensearch/stac_fastapi/opensearch/app.py | 9 +++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py b/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py index d11f013f2..6f204ed8d 100644 --- a/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py +++ b/stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py @@ -62,8 +62,9 @@ post_request_model = create_post_request_model(extensions) api = StacApi( - title=os.getenv("STAC_FASTAPI_TITLE", "stac-fastapi"), - description=os.getenv("STAC_FASTAPI_DESCRIPTION", "stac-fastapi"), + title=os.getenv("STAC_FASTAPI_TITLE", "stac-fastapi-elasticsearch"), + description=os.getenv("STAC_FASTAPI_DESCRIPTION", "stac-fastapi-elasticsearch"), + api_version=os.getenv("STAC_FASTAPI_VERSION", "2.1"), settings=settings, extensions=extensions, client=CoreClient( diff --git a/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py b/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py index 8164385eb..bb0f18a25 100644 --- a/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py +++ b/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py @@ -62,8 +62,9 @@ post_request_model = create_post_request_model(extensions) api = StacApi( - title=os.getenv("STAC_FASTAPI_TITLE", "stac-fastapi"), - description=os.getenv("STAC_FASTAPI_DESCRIPTION", "stac-fastapi"), + title=os.getenv("STAC_FASTAPI_TITLE", "stac-fastapi-opensearch"), + description=os.getenv("STAC_FASTAPI_DESCRIPTION", "stac-fastapi-opensearch"), + api_version=os.getenv("STAC_FASTAPI_VERSION", "2.1"), settings=settings, extensions=extensions, client=CoreClient( @@ -96,8 +97,8 @@ def run() -> None: raise RuntimeError("Uvicorn must be installed in order to use command") -if __name__ == "__main__": - run() +# if __name__ == "__main__": +# run() def create_handler(app): From 4e92c237a39ee70dd9307483e2abcb38c1f0a8e7 Mon Sep 17 00:00:00 2001 From: James Date: Tue, 12 Mar 2024 12:50:58 -0400 Subject: [PATCH 7/8] api info env vars example --- CHANGELOG.md | 2 +- docker-compose.yml | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f465d384e..5f32cea9c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added -- Added API `title` and `description` parameters from environment variables `STAC_API_TITLE` and `STAC_API_DESCRIPTION`, respectively. [#207](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/207) +- Added API `title`, `version`, and `description` parameters from environment variables `STAC_FASTAPI_TITLE`, `STAC_FASTAPI_VERSION` and `STAC_FASTAPI_DESCRIPTION`, respectively. [#207](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/207) ### Changed diff --git a/docker-compose.yml b/docker-compose.yml index ee6e995f8..8b5e2f073 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,6 +9,9 @@ services: context: . dockerfile: dockerfiles/Dockerfile.dev.es environment: + - STAC_FASTAPI_TITLE=stac-fastapi-elasticsearch + - STAC_FASTAPI_DESCRIPTION=A STAC FastAPI with an Elasticsearch backend + - STAC_FASTAPI_VERSION=2.1 - APP_HOST=0.0.0.0 - APP_PORT=8080 - RELOAD=true @@ -38,6 +41,9 @@ services: context: . dockerfile: dockerfiles/Dockerfile.dev.os environment: + - STAC_FASTAPI_TITLE=stac-fastapi-opensearch + - STAC_FASTAPI_DESCRIPTION=A STAC FastAPI with an Opensearch backend + - STAC_FASTAPI_VERSION=2.1 - APP_HOST=0.0.0.0 - APP_PORT=8082 - RELOAD=true From b69e9838295d2189991e44a1c6cd399d95fcdedf Mon Sep 17 00:00:00 2001 From: James Date: Tue, 12 Mar 2024 12:52:33 -0400 Subject: [PATCH 8/8] fix uncomment --- stac_fastapi/opensearch/stac_fastapi/opensearch/app.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py b/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py index bb0f18a25..79a95a903 100644 --- a/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py +++ b/stac_fastapi/opensearch/stac_fastapi/opensearch/app.py @@ -97,8 +97,8 @@ def run() -> None: raise RuntimeError("Uvicorn must be installed in order to use command") -# if __name__ == "__main__": -# run() +if __name__ == "__main__": + run() def create_handler(app):