Skip to content

Commit 0d999f7

Browse files
committed
Add documentation
1 parent 08e21b5 commit 0d999f7

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,18 @@ The application is configurable via environment variables.
145145
- **Type:** JSON object
146146
- **Required:** No, defaults to `null` (disabled)
147147
- **Example:** `{"type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Paste your raw JWT here. This API uses Bearer token authorization.\n"}`
148+
- **`SWAGGER_UI_URL`**, path of Swagger UI, used for augmenting spec response with auth configuration
149+
- **Type:** string or null
150+
- **Required:** No, defaults to `/api.html`
151+
- **Example:** `/api`
152+
- **`SWAGGER_UI_TITLE`**, title of the Swagger UI
153+
- **Type:** string
154+
- **Required:** No, defaults to `STAC API`
155+
- **Example:** `Foo API`
156+
- **`SWAGGER_UI_INIT_OAUTH`**, initialization options for the [Swagger UI OAuth2 configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/)
157+
- **Type:** JSON object
158+
- **Required:** No, defaults to `null` (disabled)
159+
- **Example:** `{"clientId": "stac-auth-proxy", "usePkceWithAuthorizationCodeGrant": true}`
148160
- Filtering
149161
- **`ITEMS_FILTER_CLS`**, CQL2 expression generator for item-level filtering
150162
- **Type:** JSON object with class configuration

0 commit comments

Comments
 (0)