You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**`HEALTHZ_PREFIX`**, path prefix for health check endpoints
88
-
-**Type:** string
89
-
-**Required:** No, defaults to `/healthz`
90
-
-**Example:**`''` (disabled)
91
-
-**`OVERRIDE_HOST`**, override the host header for the upstream API
92
-
-**Type:** boolean
93
-
-**Required:** No, defaults to `true`
94
-
-**Example:**`false`, `1`, `True`
95
-
-**`ROOT_PATH`**, path prefix for the proxy API
96
-
-**Type:** string
97
-
-**Required:** No, defaults to `''` (root path)
98
-
-**Example:**`/api/v1`
99
-
-**Note:** This is independent of the upstream API's path. The proxy will handle removing this prefix from incoming requests and adding it to outgoing links.
- **`PUBLIC_ENDPOINTS`**, endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
126
-
- **Type:** JSON object mapping regex patterns to HTTP methods
127
-
- **Required:** No, defaults to the following:
128
-
```json
129
-
{
130
-
"^/api.html$": ["GET"],
131
-
"^/api$": ["GET"],
132
-
"^/docs/oauth2-redirect": ["GET"],
133
-
"^/healthz": ["GET"]
134
-
}
135
-
```
136
-
- **`ENABLE_AUTHENTICATION_EXTENSION`**, enable authentication extension in STAC API responses
137
-
- **Type:** boolean
138
-
- **Required:** No, defaults to `true`
139
-
- **Example:** `false`, `1`, `True`
140
-
- OpenAPI / Swagger UI
141
-
- **`OPENAPI_SPEC_ENDPOINT`**, path of OpenAPI specification, used for augmenting spec response with auth configuration
142
-
- **Type:** string or null
143
-
- **Required:** No, defaults to `null` (disabled)
144
-
- **Example:** `/api`
145
-
- **`OPENAPI_AUTH_SCHEME_NAME`**, name of the auth scheme to use in the OpenAPI spec
146
-
- **Type:** string
147
-
- **Required:** No, defaults to `oidcAuth`
148
-
- **Example:** `jwtAuth`
149
-
- **`OPENAPI_AUTH_SCHEME_OVERRIDE`**, override for the auth scheme in the OpenAPI spec
150
-
- **Type:** JSON object
151
-
- **Required:** No, defaults to `null` (disabled)
152
-
- **Example:** `{"type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Paste your raw JWT here. This API uses Bearer token authorization.\n"}`
153
-
- **`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
154
-
- **Type:** string or null
155
-
- **Required:** No, defaults to `null` (disabled)
156
-
- **Example:** `/api.html`
157
-
- **`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
-**`HEALTHZ_PREFIX`**, path prefix for health check endpoints
88
+
-**Type:** string
89
+
-**Required:** No, defaults to `/healthz`
90
+
-**Example:**`''` (disabled)
91
+
-**`OVERRIDE_HOST`**, override the host header for the upstream API
92
+
-**Type:** boolean
93
+
-**Required:** No, defaults to `true`
94
+
-**Example:**`false`, `1`, `True`
95
+
-**`ROOT_PATH`**, path prefix for the proxy API
96
+
-**Type:** string
97
+
-**Required:** No, defaults to `''` (root path)
98
+
-**Example:**`/api/v1`
99
+
-**Note:** This is independent of the upstream API's path. The proxy will handle removing this prefix from incoming requests and adding it to outgoing links.
- **`PUBLIC_ENDPOINTS`**, endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
127
+
- **Type:** JSON object mapping regex patterns to HTTP methods
128
+
- **Required:** No, defaults to the following:
129
+
```json
130
+
{
131
+
"^/api.html$": ["GET"],
132
+
"^/api$": ["GET"],
133
+
"^/docs/oauth2-redirect": ["GET"],
134
+
"^/healthz": ["GET"]
135
+
}
136
+
```
137
+
- **`ENABLE_AUTHENTICATION_EXTENSION`**, enable authentication extension in STAC API responses
138
+
- **Type:** boolean
139
+
- **Required:** No, defaults to `true`
140
+
- **Example:** `false`, `1`, `True`
141
+
142
+
#### OpenAPI / Swagger UI
143
+
- **`OPENAPI_SPEC_ENDPOINT`**, path of OpenAPI specification, used for augmenting spec response with auth configuration
144
+
- **Type:** string or null
145
+
- **Required:** No, defaults to `null` (disabled)
146
+
- **Example:** `/api`
147
+
- **`OPENAPI_AUTH_SCHEME_NAME`**, name of the auth scheme to use in the OpenAPI spec
148
+
- **Type:** string
149
+
- **Required:** No, defaults to `oidcAuth`
150
+
- **Example:** `jwtAuth`
151
+
- **`OPENAPI_AUTH_SCHEME_OVERRIDE`**, override for the auth scheme in the OpenAPI spec
152
+
- **Type:** JSON object
153
+
- **Required:** No, defaults to `null` (disabled)
154
+
- **Example:** `{"type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Paste your raw JWT here. This API uses Bearer token authorization.\n"}`
155
+
- **`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
156
+
- **Type:** string or null
157
+
- **Required:** No, defaults to `null` (disabled)
158
+
- **Example:** `/api.html`
159
+
- **`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
0 commit comments