ejr/weatherapi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document active alert filtering behavior

Browse Source
This commit is contained in:
Eric Rakestraw
2026-06-12 14:10:16 +00:00
parent 8d0bc90f9d
commit cdfe8881d9
4 changed files with 23 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api.md
View File

@@ -194,10 +194,14 @@ GET /conditions/current?format=json&precision=0
GET /alerts/active
```
Returns the latest active-alert snapshot.
Returns the latest stored alert run filtered to alerts active at request time.
Query parameters: `format`, `units`.
When no latest alert run exists, `data` is null. When a latest run exists but
no alerts are currently active, `data` remains an object and `alerts` is an
empty array.
Run `data` fields:
| Field | Type | Notes |
@@ -207,6 +211,10 @@ Run `data` fields:
| `latitude`, `longitude` | number | optional |
| `alerts` | array | active alerts, possibly empty |
Alerts are active when `messageType` is not `Cancel`, `effective` is absent or
at or before request time, and `expires` is absent or after request time.
`onset` is presented when available but is not used as the active boundary.
Alert fields include `id`, `event`, `headline`, `severity`, `urgency`,
`certainty`, `status`, `messageType`, `category`, `response`, `description`,
`instruction`, `sent`, `effective`, `onset`, `expires`, `areaDescription`,