feat: standardize OpenAPI route docs metadata (#412)

This commit is contained in:
Daniel Volz
2026-03-10 16:52:31 +01:00
committed by GitHub
parent e0a50d01bb
commit 5264c761cf
13 changed files with 208 additions and 67 deletions
+13
View File
@@ -198,6 +198,19 @@ All configuration is done via environment variables in `.env`. Copy `.env.exampl
| `OPENAPI_DOCS_ENABLED` | `auto` | Enables API docs in non-production by default. Set explicitly to `true`/`false` to override. |
| `TZ` | `Europe/Berlin` | Timezone for scheduled reminders |
Recommended values for API docs by environment:
| Environment | Recommendation |
|-------------|----------------|
| Development | `OPENAPI_DOCS_ENABLED=true` |
| Staging/Test | `OPENAPI_DOCS_ENABLED=true` |
| Production | `OPENAPI_DOCS_ENABLED=false` (or keep `auto` with `NODE_ENV=production`) |
Notes:
- `auto` means: docs enabled when `NODE_ENV` is not `production`, disabled when `NODE_ENV=production`.
- Explicitly setting `OPENAPI_DOCS_ENABLED` always overrides `auto` behavior.
### Authentication
| Variable | Default | Description |