Skip to content

Commit 1e3d823

Browse files
committed
Expand README
1 parent de777a9 commit 1e3d823

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,25 @@ STAC Auth Proxy is a proxy API that mediates between the client and and some int
1010
- 🔐 Selectively apply OIDC auth to some or all endpoints & methods
1111
- 📖 Augments [OpenAPI](https://swagger.io/specification/) with auth information, keeping auto-generated docs (e.g. [Swagger UI](https://swagger.io/tools/swagger-ui/)) accurate
1212

13+
### CQL2 Filters
14+
15+
| Method | Endpoint | Action | Filter | Strategy |
16+
| -------- | ---------------------------------------------- | ------ | ------ | ---------------------------------------------------------------------------------------------------------- |
17+
| `POST` | `/search` | Read | Item | Append body with generated CQL2 query. |
18+
| `GET` | `/search` | Read | Item | Append query params with generated CQL2 query. |
19+
| `GET` | `/collections/{collection_id}/items` | Read | Item | Append query params with generated CQL2 query. |
20+
| `POST` | `/collections/{collection_id}/items` | Create | Item | Validate body with generated CQL2 query. |
21+
| `PUT` | `/collections/{collection_id}/items/{item_id}` | Update | Item | Fetch STAC Item and validate CQL2 query; merge STAC Item with body and validate with generated CQL2 query. |
22+
| `DELETE` | `/collections/{collection_id}/items/{item_id}` | Delete | Item | Fetch STAC Item and validate with CQL2 query. |
23+
24+
#### Recipes
25+
26+
Only return collections that are mentioned in a `collections` array encoded within the auth token.
27+
28+
```
29+
"A_CONTAINEDBY(id, ('{{ token.collections | join(\"', '\") }}' ))"
30+
```
31+
1332
## Installation
1433

1534
Set up connection to upstream STAC API and the OpenID Connect provider by setting the following environment variables:

0 commit comments

Comments
 (0)