Skip to content

Commit 5b94c7d

Browse files
committed
docs: use footnotes for issue links
1 parent f217216 commit 5b94c7d

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ pip install -e .
3333
```
3434

3535
> [!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].
3737
3838
### Running
3939

@@ -108,7 +108,7 @@ The application is configurable via environment variables.
108108
"^/api.html$": ["GET"],
109109
"^/api$": ["GET"],
110110
"^/docs/oauth2-redirect": ["GET"],
111-
"^/healthz": ["GET"],
111+
"^/healthz": ["GET"]
112112
}
113113
```
114114
- **`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.
172172
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.
173173

174174
> [!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].
176176

177177
> [!TIP]
178178
> 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:
192192
- **Applied Filter:** `ITEMS_FILTER`
193193
- **Strategy:** Append body with generated CQL2 query.
194194
- `GET /collections/{collection_id}`
195-
- **Supported:** ❌ ([#23](https://github.com/developmentseed/stac-auth-proxy/issues/23))
195+
- **Supported:** ❌[^23]
196196
- **Action:** Read Collection
197197
- **Applied Filter:** `COLLECTIONS_FILTER`
198198
- **Strategy:** Append query params with generated CQL2 query.
@@ -202,42 +202,42 @@ If enabled, filters are intended to be applied to the following endpoints:
202202
- **Applied Filter:** `ITEMS_FILTER`
203203
- **Strategy:** Append query params with generated CQL2 query.
204204
- `GET /collections/{collection_id}/items/{item_id}`
205-
- **Supported:** ❌ ([#25](https://github.com/developmentseed/stac-auth-proxy/issues/25))
205+
- **Supported:** ❌[^25]
206206
- **Action:** Read Item
207207
- **Applied Filter:** `ITEMS_FILTER`
208208
- **Strategy:** Validate response against CQL2 query.
209209
- `POST /collections/`
210-
- **Supported:** ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22))
210+
- **Supported:** ❌[^22]
211211
- **Action:** Create Collection
212212
- **Applied Filter:** `COLLECTIONS_FILTER`
213213
- **Strategy:** Validate body with generated CQL2 query.
214214
- `PUT /collections/{collection_id}}`
215-
- **Supported:** ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22))
215+
- **Supported:** ❌[^22]
216216
- **Action:** Update Collection
217217
- **Applied Filter:** `COLLECTIONS_FILTER`
218218
- **Strategy:** Fetch Collection and validate CQL2 query; merge Item with body and validate with generated CQL2 query.
219219
- `DELETE /collections/{collection_id}`
220-
- **Supported:** ❌ ([#22](https://github.com/developmentseed/stac-auth-proxy/issues/22))
220+
- **Supported:** ❌[^22]
221221
- **Action:** Delete Collection
222222
- **Applied Filter:** `COLLECTIONS_FILTER`
223223
- **Strategy:** Fetch Collectiion and validate with CQL2 query.
224224
- `POST /collections/{collection_id}/items`
225-
- **Supported:** ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21))
225+
- **Supported:** ❌[^21]
226226
- **Action:** Create Item
227227
- **Applied Filter:** `ITEMS_FILTER`
228228
- **Strategy:** Validate body with generated CQL2 query.
229229
- `PUT /collections/{collection_id}/items/{item_id}`
230-
- **Supported:** ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21))
230+
- **Supported:** ❌[^21]
231231
- **Action:** Update Item
232232
- **Applied Filter:** `ITEMS_FILTER`
233233
- **Strategy:** Fetch Item and validate CQL2 query; merge Item with body and validate with generated CQL2 query.
234234
- `DELETE /collections/{collection_id}/items/{item_id}`
235-
- **Supported:** ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21))
235+
- **Supported:** ❌[^21]
236236
- **Action:** Delete Item
237237
- **Applied Filter:** `ITEMS_FILTER`
238238
- **Strategy:** Fetch Item and validate with CQL2 query.
239239
- `POST /collections/{collection_id}/bulk_items`
240-
- **Supported:** ❌ ([#21](https://github.com/developmentseed/stac-auth-proxy/issues/21))
240+
- **Supported:** ❌[^21]
241241
- **Action:** Create Items
242242
- **Applied Filter:** `ITEMS_FILTER`
243243
- **Strategy:** Validate items in body with generated CQL2 query.
@@ -253,3 +253,10 @@ sequenceDiagram
253253
Proxy->>STAC API: GET /collection?filter=(collection=landsat)
254254
STAC API->>Client: Response
255255
```
256+
257+
[^21]: [#21](https://github.com/developmentseed/stac-auth-proxy/issues/21)
258+
[^22]: [#22](https://github.com/developmentseed/stac-auth-proxy/issues/21)
259+
[^23]: [#23](https://github.com/developmentseed/stac-auth-proxy/issues/23)
260+
[^25]: [#25](https://github.com/developmentseed/stac-auth-proxy/issues/21)
261+
[^30]: [#30](https://github.com/developmentseed/stac-auth-proxy/issues/30)
262+
[^37]: [#37](https://github.com/developmentseed/stac-auth-proxy/issues/37)

0 commit comments

Comments
 (0)