Skip to content

Commit e462d3c

Browse files
committed
Merge branch 'main' into feature/s3-url-signing
2 parents e377d23 + 1be912c commit e462d3c

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22
<h1 style="font-family: monospace">stac auth proxy</h1>
3-
<p align="center">Reverse proxy to apply auth*n scenarios to STAC APIs.</p>
3+
<p align="center">Reverse proxy to apply auth*n to STAC APIs.</p>
44
</div>
55

66
---
@@ -32,7 +32,7 @@ uv sync
3232
Otherwise, the application can be installed as a standard Python module:
3333

3434
```sh
35-
pip install -e src
35+
pip install -e .
3636
```
3737

3838
### Running
@@ -145,23 +145,23 @@ The middleware stack is processed in reverse order (bottom to top):
145145
- Handles authentication and authorization
146146
- Configurable public/private endpoints
147147
- OIDC integration
148+
- Places auth token payload in request state
148149

149150
2. **BuildCql2FilterMiddleware**
150151

151-
- Builds CQL2 filters based on request context
152-
- Stores filter in request state
152+
- Builds CQL2 filters based on request context/state
153+
- Places [CQL2 expression](http://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) in request state
153154

154155
3. **ApplyCql2FilterMiddleware**
155156

156-
- Retrieves filter from request state
157-
- Applies the built CQL2 filter to requests
158-
- Modifies query strings for GET requests
159-
- Modifies JSON bodies for POST/PUT/PATCH requests
157+
- Retrieves [CQL2 expression](http://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) from request state
158+
- Augments request with CQL2 filter:
159+
- Modifies query strings for GET requests
160+
- Modifies JSON bodies for POST/PUT/PATCH requests
160161

161162
4. **OpenApiMiddleware**
162163

163-
- Modifies OpenAPI specification
164-
- Adds security requirements
164+
- Modifies OpenAPI specification based on endpoint configuration, adding security requirements
165165
- Only active if `openapi_spec_endpoint` is configured
166166

167167
5. **AddProcessTimeHeaderMiddleware**

0 commit comments

Comments
 (0)