Skip to content

Commit 7684925

Browse files
authored
docs: correct swagger UI config details
1 parent ca913a0 commit 7684925

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ The application is configurable via environment variables.
132132
- **Type:** boolean
133133
- **Required:** No, defaults to `true`
134134
- **Example:** `false`, `1`, `True`
135-
- OpenAPI
135+
- OpenAPI / Swagger UI
136136
- **`OPENAPI_SPEC_ENDPOINT`**, path of OpenAPI specification, used for augmenting spec response with auth configuration
137137
- **Type:** string or null
138138
- **Required:** No, defaults to `null` (disabled)
@@ -145,11 +145,11 @@ 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_ENDPOINT`**, path of Swagger UI, used for augmenting spec response with auth configuration
148+
- **`SWAGGER_UI_ENDPOINT`**, path of Swagger UI, used to indicate that a custom Swagger UI should be hosted, typically useful when providing accompanying `SWAGGER_UI_INIT_OAUTH` arguments
149149
- **Type:** string or null
150-
- **Required:** No, defaults to `/api.html`
151-
- **Example:** `/api`
152-
- **`SWAGGER_UI_INIT_OAUTH`**, initialization options for the [Swagger UI OAuth2 configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/)
150+
- **Required:** No, defaults to `null` (disabled)
151+
- **Example:** `/api.html`
152+
- **`SWAGGER_UI_INIT_OAUTH`**, initialization options for the [Swagger UI OAuth2 configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/) on custom Swagger UI
153153
- **Type:** JSON object
154154
- **Required:** No, defaults to `null` (disabled)
155155
- **Example:** `{"clientId": "stac-auth-proxy", "usePkceWithAuthorizationCodeGrant": true}`

0 commit comments

Comments
 (0)