Updated the normalized observation schema to remove duplicate and/or unnecessary fields
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
This commit is contained in:
22
API.md
22
API.md
@@ -80,34 +80,18 @@ A `WeatherObservation` represents a point-in-time observation for a station/loca
|
||||
| `stationName` | string | no | Human station name |
|
||||
| `timestamp` | timestamp string | yes | Observation timestamp |
|
||||
| `conditionCode` | int | yes | WMO code (`-1` unknown) |
|
||||
| `conditionText` | string | no | Canonical short condition text |
|
||||
| `isDay` | bool | no | Day/night hint |
|
||||
| `providerRawDescription` | string | no | Provider-specific evidence text |
|
||||
| `textDescription` | string | no | Legacy/transitional text description |
|
||||
| `iconUrl` | string | no | Legacy/transitional icon URL |
|
||||
| `textDescription` | string | no | Human-facing short description |
|
||||
| `temperatureC` | number | no | Celsius |
|
||||
| `dewpointC` | number | no | Celsius |
|
||||
| `windDirectionDegrees` | number | no | Degrees |
|
||||
| `windSpeedKmh` | number | no | km/h |
|
||||
| `windGustKmh` | number | no | km/h |
|
||||
| `barometricPressurePa` | number | no | Pascals |
|
||||
| `seaLevelPressurePa` | number | no | Pascals |
|
||||
| `visibilityMeters` | number | no | Meters |
|
||||
| `relativeHumidityPercent` | number | no | Percent |
|
||||
| `apparentTemperatureC` | number | no | Celsius |
|
||||
| `elevationMeters` | number | no | Meters |
|
||||
| `rawMessage` | string | no | Provider raw message (for example METAR) |
|
||||
| `presentWeather` | array | no | Provider-specific structured weather fragments |
|
||||
| `cloudLayers` | array | no | Cloud layer details |
|
||||
|
||||
### Nested: `cloudLayers[]`
|
||||
|
||||
Each `cloudLayers[]` element:
|
||||
|
||||
| Field | Type | Required | Notes |
|
||||
|---|---:|:---:|---|
|
||||
| `baseMeters` | number | no | Cloud base altitude in meters |
|
||||
| `amount` | string | no | Provider string (e.g. FEW/SCT/BKN/OVC) |
|
||||
|
||||
### Nested: `presentWeather[]`
|
||||
|
||||
@@ -241,7 +225,7 @@ A run may contain zero, one, or many alerts.
|
||||
|
||||
- Consumers **must** ignore unknown fields.
|
||||
- Producers (weatherfeeder) prefer **additive changes** within a schema version.
|
||||
- Renames/removals/semantic breaks require a **schema version bump** (`weather.*.v2`).
|
||||
- Renames/removals/semantic breaks normally require a **schema version bump** (`weather.*.v2`); pre-1.0 projects may choose in-place changes.
|
||||
|
||||
---
|
||||
|
||||
@@ -259,7 +243,7 @@ A run may contain zero, one, or many alerts.
|
||||
"stationId": "KSTL",
|
||||
"timestamp": "2026-01-17T14:00:00Z",
|
||||
"conditionCode": 1,
|
||||
"conditionText": "Mainly Sunny",
|
||||
"textDescription": "Mainly Sunny",
|
||||
"temperatureC": 3.25,
|
||||
"windSpeedKmh": 18.5
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user