Document convective outlook endpoints

This commit is contained in:
2026-06-11 15:46:00 +00:00
parent e897ae52df
commit 993621e3b3
7 changed files with 228 additions and 20 deletions

View File

@@ -2,8 +2,8 @@
`weatherapi` is a read-only HTTP API for weather data already stored by
`weatherfeeder` in PostgreSQL. It exposes the latest observations, current
conditions, alerts, forecasts, discussions, and weather stories as JSON, XML,
or text.
conditions, alerts, forecasts, discussions, weather stories, and convective
outlooks as JSON, XML, or text.
## Quickstart
@@ -26,6 +26,11 @@ database credentials through your normal secret-management process.
- Hourly and narrative forecasts
- Forecast discussions
- Weather stories
- Convective outlooks
Common query parameters include `format`, `units`, and route-specific options
such as forecast `precision`, timezone `tz` / `TZ`, and outlook filters
`day`, `outlookType`, and `containsLocation`.
See [`docs/api.md`](docs/api.md) for the HTTP contract.