From 50a2834ee3b94d68f96b2ab012004f886475c20b Mon Sep 17 00:00:00 2001 From: rhysrevans3 Date: Tue, 7 Jan 2025 09:52:05 +0000 Subject: [PATCH 1/3] Adding note on default auth dependencies. --- CHANGELOG.md | 4 ++++ examples/auth/README.md | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e41a1462..48e0d8b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +### Changed + +- Added note on the use of the default `*` use in route authentication dependecies. [#](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/) + ## [v3.2.2] - 2024-12-15 ### Changed diff --git a/examples/auth/README.md b/examples/auth/README.md index bd74c439..f9fdda3e 100644 --- a/examples/auth/README.md +++ b/examples/auth/README.md @@ -9,6 +9,11 @@ Authentication is an optional feature that can be enabled through [Route Depende Route dependencies for endpoints can enable through the `STAC_FASTAPI_ROUTE_DEPENDENCIES` environment variable as a path to a JSON file or a JSON string. +***NOTE: default dependencies*** +`*` can be used match all paths. However, if used this must be the only Authentication dependency (multiple can be used through a +single merged dependency). Similarly, `*` can be used to match all methods with a route but must also be the only Authentication +dependency for that route. + #### Route Dependency A Route Dependency must include `routes`, a list of at least one [Route](#routes), and `dependencies` a From 685901826c36b220b9b40ba6af26110c4a3d47b7 Mon Sep 17 00:00:00 2001 From: rhysrevans3 Date: Tue, 7 Jan 2025 10:07:41 +0000 Subject: [PATCH 2/3] Adding pull request number. --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 48e0d8b4..c870900b 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. ### Changed -- Added note on the use of the default `*` use in route authentication dependecies. [#](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/) +- Added note on the use of the default `*` use in route authentication dependecies. [#325](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/325) ## [v3.2.2] - 2024-12-15 From 6fcedb1db6ecf9af5794156583e420967558efa0 Mon Sep 17 00:00:00 2001 From: rhysrevans3 <34507919+rhysrevans3@users.noreply.github.com> Date: Mon, 13 Jan 2025 09:39:33 +0000 Subject: [PATCH 3/3] Update examples/auth/README.md Co-authored-by: Jonathan Healy --- examples/auth/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/auth/README.md b/examples/auth/README.md index f9fdda3e..0bd068e2 100644 --- a/examples/auth/README.md +++ b/examples/auth/README.md @@ -10,7 +10,7 @@ Route dependencies for endpoints can enable through the `STAC_FASTAPI_ROUTE_DEPE environment variable as a path to a JSON file or a JSON string. ***NOTE: default dependencies*** -`*` can be used match all paths. However, if used this must be the only Authentication dependency (multiple can be used through a +`*` can be used to match all paths. However, if used this must be the only Authentication dependency (multiple can be used through a single merged dependency). Similarly, `*` can be used to match all methods with a route but must also be the only Authentication dependency for that route.