Skip to content

Commit 2931caf

Browse files
committed
chore(docs): rework filters descriptions
1 parent f2a3149 commit 2931caf

File tree

1 file changed

+62
-14
lines changed

1 file changed

+62
-14
lines changed

README.md

Lines changed: 62 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -192,17 +192,65 @@ sequenceDiagram
192192

193193
#### Filters
194194

195-
| Supported | Method | Endpoint | Action | Filter | Strategy |
196-
| -------------------------------------------------------- | -------- | ---------------------------------------------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------ |
197-
|| `POST` | `/search` | Read | Item | Append body with generated CQL2 query. |
198-
|| `GET` | `/search` | Read | Item | Append query params with generated CQL2 query. |
199-
| ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22)) | `POST` | `/collections/` | Create | Collection | Validate body with generated CQL2 query. |
200-
| ❌ ([#23](https://github.com/developmentseed/stac-auth-proxy/issues/23)) | `GET` | `/collections/{collection_id}` | Read | Collection | Append query params with generated CQL2 query. |
201-
| ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22)) | `PUT` | `/collections/{collection_id}}` | Update | Collection | Fetch Collection and validate CQL2 query; merge Item with body and validate with generated CQL2 query. |
202-
| ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22)) | `DELETE` | `/collections/{collection_id}` | Delete | Collection | Fetch Collectiion and validate with CQL2 query. |
203-
|| `GET` | `/collections/{collection_id}/items` | Read | Item | Append query params with generated CQL2 query. |
204-
| ❌ ([#25](https://github.com/developmentseed/stac-auth-proxy/issues/25)) | `GET` | `/collections/{collection_id}/items/{item_id}` | Read | Item | Validate response against CQL2 query. |
205-
| ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21)) | `POST` | `/collections/{collection_id}/items` | Create | Item | Validate body with generated CQL2 query. |
206-
| ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21)) | `PUT` | `/collections/{collection_id}/items/{item_id}` | Update | Item | Fetch Item and validate CQL2 query; merge Item with body and validate with generated CQL2 query. |
207-
| ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21)) | `DELETE` | `/collections/{collection_id}/items/{item_id}` | Delete | Item | Fetch Item and validate with CQL2 query. |
208-
| ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21)) | `POST` | `/collections/{collection_id}/bulk_items` | Create | Item | Validate items in body with generated CQL2 query. |
195+
If enabled, filters are intended to be applied to the following endpoints:
196+
197+
- `GET /search`
198+
- **Supported:**
199+
- **Action:** Read Item
200+
- **Applied Filter:** `ITEMS_FILTER`
201+
- **Strategy:** Append query params with generated CQL2 query.
202+
- `POST /search`
203+
- **Supported:**
204+
- **Action:** Read Item
205+
- **Applied Filter:** `ITEMS_FILTER`
206+
- **Strategy:** Append body with generated CQL2 query.
207+
- `GET /collections/{collection_id}`
208+
- **Supported:** ❌ ([#23](https://github.com/developmentseed/stac-auth-proxy/issues/23))
209+
- **Action:** Read Collection
210+
- **Applied Filter:** `COLLECTIONS_FILTER`
211+
- **Strategy:** Append query params with generated CQL2 query.
212+
- `GET /collections/{collection_id}/items`
213+
- **Supported:**
214+
- **Action:** Read Item
215+
- **Applied Filter:** `ITEMS_FILTER`
216+
- **Strategy:** Append query params with generated CQL2 query.
217+
- `GET /collections/{collection_id}/items/{item_id}`
218+
- **Supported:** ❌ ([#25](https://github.com/developmentseed/stac-auth-proxy/issues/25))
219+
- **Action:** Read Item
220+
- **Applied Filter:** `ITEMS_FILTER`
221+
- **Strategy:** Validate response against CQL2 query.
222+
- `POST /collections/`
223+
- **Supported:** ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22))
224+
- **Action:** Create Collection
225+
- **Applied Filter:** `COLLECTIONS_FILTER`
226+
- **Strategy:** Validate body with generated CQL2 query.
227+
- `PUT /collections/{collection_id}}`
228+
- **Supported:** ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22))
229+
- **Action:** Update Collection
230+
- **Applied Filter:** `COLLECTIONS_FILTER`
231+
- **Strategy:** Fetch Collection and validate CQL2 query; merge Item with body and validate with generated CQL2 query.
232+
- `DELETE /collections/{collection_id}`
233+
- **Supported:** ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22))
234+
- **Action:** Delete Collection
235+
- **Applied Filter:** `COLLECTIONS_FILTER`
236+
- **Strategy:** Fetch Collectiion and validate with CQL2 query.
237+
- `POST /collections/{collection_id}/items`
238+
- **Supported:** ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21))
239+
- **Action:** Create Item
240+
- **Applied Filter:** `ITEMS_FILTER`
241+
- **Strategy:** Validate body with generated CQL2 query.
242+
- `PUT /collections/{collection_id}/items/{item_id}`
243+
- **Supported:** ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21))
244+
- **Action:** Update Item
245+
- **Applied Filter:** `ITEMS_FILTER`
246+
- **Strategy:** Fetch Item and validate CQL2 query; merge Item with body and validate with generated CQL2 query.
247+
- `DELETE /collections/{collection_id}/items/{item_id}`
248+
- **Supported:** ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21))
249+
- **Action:** Delete Item
250+
- **Applied Filter:** `ITEMS_FILTER`
251+
- **Strategy:** Fetch Item and validate with CQL2 query.
252+
- `POST /collections/{collection_id}/bulk_items`
253+
- **Supported:** ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21))
254+
- **Action:** Create Items
255+
- **Applied Filter:** `ITEMS_FILTER`
256+
- **Strategy:** Validate items in body with generated CQL2 query.

0 commit comments

Comments
 (0)