|
1 | 1 | <div align="center"> |
2 | 2 | <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> |
4 | 4 | </div> |
5 | 5 |
|
6 | 6 | --- |
@@ -32,7 +32,7 @@ uv sync |
32 | 32 | Otherwise, the application can be installed as a standard Python module: |
33 | 33 |
|
34 | 34 | ```sh |
35 | | -pip install -e src |
| 35 | +pip install -e . |
36 | 36 | ``` |
37 | 37 |
|
38 | 38 | ### Running |
@@ -145,23 +145,23 @@ The middleware stack is processed in reverse order (bottom to top): |
145 | 145 | - Handles authentication and authorization |
146 | 146 | - Configurable public/private endpoints |
147 | 147 | - OIDC integration |
| 148 | + - Places auth token payload in request state |
148 | 149 |
|
149 | 150 | 2. **BuildCql2FilterMiddleware** |
150 | 151 |
|
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 |
153 | 154 |
|
154 | 155 | 3. **ApplyCql2FilterMiddleware** |
155 | 156 |
|
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 |
160 | 161 |
|
161 | 162 | 4. **OpenApiMiddleware** |
162 | 163 |
|
163 | | - - Modifies OpenAPI specification |
164 | | - - Adds security requirements |
| 164 | + - Modifies OpenAPI specification based on endpoint configuration, adding security requirements |
165 | 165 | - Only active if `openapi_spec_endpoint` is configured |
166 | 166 |
|
167 | 167 | 5. **AddProcessTimeHeaderMiddleware** |
|
0 commit comments