You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-12Lines changed: 19 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ pip install -e .
33
33
```
34
34
35
35
> [!NOTE]
36
-
> This project will be available on PyPi in the near future ([#30](https://github.com/developmentseed/stac-auth-proxy/issues/30)).
36
+
> This project will be available on PyPi in the near future[^30].
37
37
38
38
### Running
39
39
@@ -108,7 +108,7 @@ The application is configurable via environment variables.
108
108
"^/api.html$": ["GET"],
109
109
"^/api$": ["GET"],
110
110
"^/docs/oauth2-redirect": ["GET"],
111
-
"^/healthz": ["GET"],
111
+
"^/healthz": ["GET"]
112
112
}
113
113
```
114
114
- **`OPENAPI_SPEC_ENDPOINT`**, path of OpenAPI specification, used for augmenting spec response with auth configuration
@@ -172,7 +172,7 @@ The majority of the proxy's functionality occurs within a chain of middlewares.
172
172
The system supports generating CQL2 filters based on request context to provide row-level content filtering. These CQL2 filters are then set on outgoing requests prior to the upstream API.
173
173
174
174
> [!IMPORTANT]
175
-
> The upstream STAC API must support the [STAC API Filter Extension](https://github.com/stac-api-extensions/filter/blob/main/README.md), including the [Features Filter](http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter) conformance class on to the Features resource (`/collections/{cid}/items`) [#37](https://github.com/developmentseed/stac-auth-proxy/issues/37).
175
+
> The upstream STAC API must support the [STAC API Filter Extension](https://github.com/stac-api-extensions/filter/blob/main/README.md), including the [Features Filter](http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter) conformance class on to the Features resource (`/collections/{cid}/items`)[^37].
176
176
177
177
> [!TIP]
178
178
> Integration with external authorization systems (e.g. [Open Policy Agent](https://www.openpolicyagent.org/)) can be achieved by specifying an `ITEMS_FILTER` that points to a class/function that, once initialized, returns a [`cql2.Expr` object](https://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) when called with the request context.
@@ -192,7 +192,7 @@ If enabled, filters are intended to be applied to the following endpoints:
192
192
- **Applied Filter:** `ITEMS_FILTER`
193
193
- **Strategy:** Append body with generated CQL2 query.
0 commit comments