Skip to content

Commit 9cd15c7

Browse files
committed
chore(docs): format middleware classes
1 parent 1f3d714 commit 9cd15c7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,31 +133,31 @@ While the project is designed to work out-of-the-box as an application, it might
133133

134134
The majority of the proxy's functionality occurs within a chain of middlewares. Each request passes through this chain, wherein each middleware performs a specific task:
135135

136-
1. **EnforceAuthMiddleware**
136+
1. **`EnforceAuthMiddleware`**
137137

138138
- Handles authentication and authorization
139139
- Configurable public/private endpoints
140140
- OIDC integration
141141
- Places auth token payload in request state
142142

143-
2. **BuildCql2FilterMiddleware**
143+
2. **`BuildCql2FilterMiddleware`**
144144

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

148-
3. **ApplyCql2FilterMiddleware**
148+
3. **`ApplyCql2FilterMiddleware`**
149149

150150
- Retrieves [CQL2 expression](http://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) from request state
151151
- Augments request with CQL2 filter:
152152
- Modifies query strings for `GET` requests
153153
- Modifies JSON bodies for `POST`/`PUT`/`PATCH` requests
154154

155-
4. **OpenApiMiddleware**
155+
4. **`OpenApiMiddleware`**
156156

157157
- Modifies OpenAPI specification based on endpoint configuration, adding security requirements
158158
- Only active if `openapi_spec_endpoint` is configured
159159

160-
5. **AddProcessTimeHeaderMiddleware**
160+
5. **`AddProcessTimeHeaderMiddleware`**
161161
- Adds processing time headers
162162
- Useful for monitoring/debugging
163163

0 commit comments

Comments
 (0)