Skip to content

Commit d3d3769

Browse files
committed
docs: update middleware descriptions
1 parent 86f6d17 commit d3d3769

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -233,25 +233,32 @@ The majority of the proxy's functionality occurs within a chain of middlewares.
233233
- OIDC integration
234234
- Places auth token payload in request state
235235

236-
2. **`BuildCql2FilterMiddleware`**
236+
2. **`Cql2BuildFilterMiddleware`**
237237

238238
- Builds CQL2 filters based on request context/state
239239
- Places [CQL2 expression](http://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) in request state
240240

241-
3. **`ApplyCql2FilterMiddleware`**
241+
3. **`Cql2ApplyFilterQueryStringMiddleware`**
242+
243+
- Retrieves [CQL2 expression](http://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) from request state
244+
- Augments `GET` requests with CQL2 filter by appending to querystring
245+
246+
4. **`Cql2ApplyFilterBodyMiddleware`**
247+
248+
- Retrieves [CQL2 expression](http://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) from request state
249+
- Augments `` POST`/`PUT`/`PATCH `` requests with CQL2 filter by modifying body
250+
251+
5. **`Cql2ValidateResponseBodyMiddleware`**
242252

243253
- Retrieves [CQL2 expression](http://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) from request state
244-
- Augments request with CQL2 filter:
245-
- Modifies query strings for `GET` requests
246-
- Modifies JSON bodies for `POST`/`PUT`/`PATCH` requests
247254
- Validates response against CQL2 filter for non-filterable endpoints
248255

249-
4. **`OpenApiMiddleware`**
256+
6. **`OpenApiMiddleware`**
250257

251258
- Modifies OpenAPI specification based on endpoint configuration, adding security requirements
252259
- Only active if `openapi_spec_endpoint` is configured
253260

254-
5. **`AddProcessTimeHeaderMiddleware`**
261+
7. **`AddProcessTimeHeaderMiddleware`**
255262
- Adds processing time headers
256263
- Useful for monitoring/debugging
257264

0 commit comments

Comments
 (0)