Skip to content

Commit 76729f7

Browse files
committed
chore(docs): add docs for healthz_prefix and wait_for_upstream
1 parent d164646 commit 76729f7

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,18 @@ The application is configurable via environment variables.
6565
- **Type:** HTTP(S) URL
6666
- **Required:** No, defaults to the value of `OIDC_DISCOVERY_URL`
6767
- **Example:** `http://auth/.well-known/openid-configuration`
68+
- `WAIT_FOR_UPSTREAM`, wait for upstream API to become available before starting proxy
69+
- **Type:** boolean
70+
- **Required:** No, defaults to `true`
71+
- **Example:** `false`, `1`, `True`
72+
- `HEALTHZ_PREFIX`, prefix for health check endpoints
73+
- **Type:** string
74+
- **Required:** No, defaults to `/healthz`
75+
- **Example:** `''` (disabled)
76+
- `OPENAPI_SPEC_ENDPOINT`, path of OpenAPI specification, used for augment spec response with auth configuration
77+
- **Type:** string or null
78+
- **Required:** No, defaults to `null` (disabled)
79+
- **Example:** `/api`
6880
- `DEFAULT_PUBLIC`, default access policy for endpoints
6981
- **Type:** boolean
7082
- **Required:** No, defaults to `false`
@@ -90,10 +102,6 @@ The application is configurable via environment variables.
90102
"^/api$": ["GET"]
91103
}
92104
```
93-
- `OPENAPI_SPEC_ENDPOINT`, path of OpenAPI specification, used for augment spec response with auth configuration
94-
- **Type:** string or null
95-
- **Required:** No, defaults to `null` (disabled)
96-
- **Example:** `/api`
97105
- `ITEMS_FILTER`, cql2 expression generator for item-level filtering
98106
- **Type:** JSON object with class configuration
99107
- **Required:** No, defaults to `null` (disabled)

0 commit comments

Comments
 (0)