Skip to content

Commit fa312c8

Browse files
Adding note on the use of the default * use in route authentication dependecies (#325)
**Related Issue(s):** - #310 **Description:** Using multiple authentication dependencies on a single route can cause clashes if not done correctly (merging them). This is particularly relevant to the default `*` route. My [pull request](stac-utils/stac-fastapi#766) on [stac-fastapi](https://github.com/stac-utils/stac-fastapi) to dynamically merge multiple dependencies was rejected and I don't think it's possible to replicate it here. So I've added a note to the dependency documentation to try to explain what to do in this case. **PR Checklist:** - [x] Code is formatted and linted (run `pre-commit run --all-files`) - [x] Tests pass (run `make test`) - [x] Documentation has been updated to reflect changes, if applicable - [x] Changes are added to the changelog --------- Co-authored-by: Jonathan Healy <[email protected]>
1 parent e45cfea commit fa312c8

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77

88
## [Unreleased]
99

10+
### Changed
11+
12+
- 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)
13+
1014
## [v3.2.2] - 2024-12-15
1115

1216
### Changed

examples/auth/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ Authentication is an optional feature that can be enabled through [Route Depende
99
Route dependencies for endpoints can enable through the `STAC_FASTAPI_ROUTE_DEPENDENCIES`
1010
environment variable as a path to a JSON file or a JSON string.
1111

12+
***NOTE: default dependencies***
13+
`*` can be used to match all paths. However, if used this must be the only Authentication dependency (multiple can be used through a
14+
single merged dependency). Similarly, `*` can be used to match all methods with a route but must also be the only Authentication
15+
dependency for that route.
16+
1217
#### Route Dependency
1318

1419
A Route Dependency must include `routes`, a list of at least one [Route](#routes), and `dependencies` a

0 commit comments

Comments
 (0)