Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding note on the use of the default * use in route authentication dependecies #325

Merged
merged 3 commits into from
Jan 30, 2025
Merged

Adding note on the use of the default * use in route authentication dependecies #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50a2834
Adding note on default auth dependencies.
rhysrevans3 Jan 7, 2025
6859018
Adding pull request number.
rhysrevans3 Jan 7, 2025
6fcedb1
Update examples/auth/README.md
rhysrevans3 Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. [#325](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/325)

## [v3.2.2] - 2024-12-15

### Changed
Expand Down
5 changes: 5 additions & 0 deletions examples/auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.

#### Route Dependency

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