Skip to content

Commit a7f5b1b

Browse files
committed
docs: update filter class path syntax
1 parent 5c5c856 commit a7f5b1b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/user-guide/record-level-auth.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,11 @@ Configure filters using environment variables:
134134

135135
```bash
136136
# Basic configuration
137-
ITEMS_FILTER_CLS=stac_auth_proxy.filters.Template
137+
ITEMS_FILTER_CLS=stac_auth_proxy.filters:Template
138138
ITEMS_FILTER_ARGS='["collection IN ('public')"]'
139139

140140
# With keyword arguments
141-
ITEMS_FILTER_CLS=stac_auth_proxy.filters.Opa
141+
ITEMS_FILTER_CLS=stac_auth_proxy.filters:Opa
142142
ITEMS_FILTER_ARGS='["http://opa:8181", "stac/items/allow"]'
143143
ITEMS_FILTER_KWARGS='{"cache_ttl": 30.0}'
144144
```
@@ -156,7 +156,7 @@ ITEMS_FILTER_KWARGS='{"cache_ttl": 30.0}'
156156
Generate CQL2 expressions using the [Jinja](https://jinja.palletsprojects.com/en/stable/) templating engine. Given the request context, the Jinja template expression should render a valid CQL2 expression (likely in `cql2-text` format).
157157

158158
```bash
159-
ITEMS_FILTER_CLS=stac_auth_proxy.filters.Template
159+
ITEMS_FILTER_CLS=stac_auth_proxy.filters:Template
160160
ITEMS_FILTER_ARGS='["{{ \"true\" if payload else \"(preview IS NULL) OR (preview = false)\" }}"]'
161161
```
162162

@@ -169,7 +169,7 @@ ITEMS_FILTER_ARGS='["{{ \"true\" if payload else \"(preview IS NULL) OR (preview
169169
Delegate authorization to [Open Policy Agent](https://www.openpolicyagent.org/). For each request, we call out to an OPA decision with the request context, expecting that OPA will return a valid CQL2 expression.
170170

171171
```bash
172-
ITEMS_FILTER_CLS=stac_auth_proxy.filters.opa.Opa
172+
ITEMS_FILTER_CLS=stac_auth_proxy.filters:opa.Opa
173173
ITEMS_FILTER_ARGS='["http://opa:8181","stac/items_cql2"]'
174174
```
175175

0 commit comments

Comments
 (0)