Document current outlook schema behavior
This commit is contained in:
@@ -9,8 +9,8 @@ import "gitea.maximumdirect.net/ejr/weatherfeeder/model"
|
||||
## Purpose
|
||||
|
||||
Package `model` defines `weatherfeeder`'s canonical weather payload structs.
|
||||
These structs are emitted as the `payload` of canonical `weather.*.v1` events
|
||||
and are also the domain types consumed by downstream applications such as
|
||||
These structs are emitted as the `payload` of canonical `weather.*` events and
|
||||
are also the domain types consumed by downstream applications such as
|
||||
`weatherapi`.
|
||||
|
||||
The JSON field tags on these structs are part of the wire contract. For the full
|
||||
@@ -27,7 +27,7 @@ Current canonical schema families map to these public types:
|
||||
| `weather.forecast_discussion.v1` | `WeatherForecastDiscussion` |
|
||||
| `weather.weather_story.v1` | `WeatherStoryRun` |
|
||||
| `weather.alert.v1` | `WeatherAlertRun` |
|
||||
| `weather.outlook.v1` | `WeatherOutlookRun` |
|
||||
| `weather.outlook.v2` | `WeatherOutlookRun` |
|
||||
|
||||
Related child types include:
|
||||
|
||||
@@ -41,6 +41,9 @@ Related child types include:
|
||||
- `WeatherOutlookDiscussion`
|
||||
- `WMOCode`
|
||||
|
||||
`WeatherOutlookRun` includes `WeatherOutlookDiscussion` entries as run-level
|
||||
SPC day discussions.
|
||||
|
||||
## Wire And Compatibility Rules
|
||||
|
||||
- JSON tags define canonical payload field names.
|
||||
|
||||
Reference in New Issue
Block a user