Skip to content

Commit 8d9726a

Browse files
committed
docs: refine maps and stations guidance
1 parent 7ff8dda commit 8d9726a

8 files changed

Lines changed: 19 additions & 9 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ use yet.
1919
- [One Call 4.0](docs/one-call.md)
2020
- [Air Pollution](docs/air-pollution.md)
2121
- [Weather](docs/weather.md)
22-
- [Weather Maps](docs/maps.md)
23-
- [Weather Stations](docs/stations.md)
22+
- [Maps](docs/maps.md)
23+
- [Stations](docs/stations.md)
2424
- [Geocoding](docs/geocoding.md)
2525

2626
## License

docs/maps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Weather Maps
1+
# Maps
22

33
Weather Maps API 1.0 provides current cloud, precipitation, sea-level pressure,
44
wind-speed, and temperature overlays. It is available on OpenWeather's standard

docs/stations.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Weather Stations
1+
# Stations
22

33
The Weather Stations API lets you register and manage personal weather stations
44
associated with your OpenWeather account.
@@ -161,6 +161,11 @@ standard METAR codes. See the
161161
[NOAA METAR reference](https://aviationweather.gov/help/data/#metar) for their
162162
meanings.
163163

164+
> **Upstream inconsistency:** OpenWeather documents `visibilityPrefix` as a
165+
> compass-direction string, but its live API rejected a documented string value
166+
> during verification. Omit this value unless OpenWeather clarifies or corrects
167+
> the accepted type.
168+
164169
Each `CloudLayer` represents one entry in OpenWeather's `clouds` array. Its
165170
distance, METAR cloud condition, and cumulus type are optional, but at least one
166171
value must be provided.
@@ -170,6 +175,11 @@ available METAR precipitation, descriptor, intensity, proximity, obscuration,
170175
and other codes. At least one value must be provided, and codes are kept as
171176
strings so additional values accepted by OpenWeather are not restricted.
172177

178+
METAR visibility, cloud, and weather values appear to be write-only in this API.
179+
A successful submission has no response body, and OpenWeather does not document
180+
a method for retrieving the original measurement payload. These values
181+
therefore could not be read back or verified after submission.
182+
173183
## Retrieve Measurements
174184

175185
Use `measurements()` to retrieve measurements aggregated by minute, hour, or

tests/Fixtures/stations/delete.meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@
1313
"query": {}
1414
},
1515
"sanitization": [],
16-
"notes": "The generated identifier belongs to the deleted temporary fixture station and is unchanged. The successful response had no body or Content-Type header, and a following list request confirmed the account returned from zero stations to zero."
16+
"notes": "The generated identifier belongs to the deleted temporary fixture station and is unchanged. The successful response had no body or Content-Type header, and a following list request confirmed the account returned from one station to zero."
1717
}

tests/Fixtures/stations/measurements/aggregate-day-success.meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@
1818
}
1919
},
2020
"sanitization": [],
21-
"notes": "The first aggregate appeared between 23 hours 43 minutes and 31 hours 43 minutes after its three source measurements were accepted. The second aggregate appeared approximately 30 hours after its fully populated source measurement was accepted. Its decimal pressure and rain and snow totals are preserved exactly; submitted METAR structures are absent from the aggregate response."
21+
"notes": "The first aggregate appeared between 23 hours 43 minutes and 31 hours 43 minutes after its three source measurements were accepted. The second aggregate appeared approximately 30 hours after its fully populated source measurement was accepted. Its decimal pressure and rain and snow totals are preserved exactly; submitted METAR structures are absent from the aggregate response. The retained station was deleted after capture, and a following list request confirmed that no stations remained."
2222
}

tests/Fixtures/stations/measurements/aggregate-hour-success.meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@
1818
}
1919
},
2020
"sanitization": [],
21-
"notes": "The first aggregate appeared between 23 hours 43 minutes and 31 hours 43 minutes after its three source measurements were accepted. The second aggregate appeared approximately 30 hours after its fully populated source measurement was accepted. Its decimal pressure and rain and snow totals are preserved exactly; submitted METAR structures are absent from the aggregate response."
21+
"notes": "The first aggregate appeared between 23 hours 43 minutes and 31 hours 43 minutes after its three source measurements were accepted. The second aggregate appeared approximately 30 hours after its fully populated source measurement was accepted. Its decimal pressure and rain and snow totals are preserved exactly; submitted METAR structures are absent from the aggregate response. The retained station was deleted after capture, and a following list request confirmed that no stations remained."
2222
}

tests/Fixtures/stations/measurements/aggregate-minute-success.meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@
1818
}
1919
},
2020
"sanitization": [],
21-
"notes": "The first aggregate appeared between 23 hours 43 minutes and 31 hours 43 minutes after its three source measurements were accepted. The second aggregate appeared approximately 30 hours after its fully populated source measurement was accepted. Both empty precipitation objects are preserved exactly."
21+
"notes": "The first aggregate appeared between 23 hours 43 minutes and 31 hours 43 minutes after its three source measurements were accepted. The second aggregate appeared approximately 30 hours after its fully populated source measurement was accepted. Both empty precipitation objects are preserved exactly. The retained station was deleted after capture, and a following list request confirmed that no stations remained."
2222
}

tests/Fixtures/stations/register.meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@
2424
"action": "replaced private account identifier with user-fixture"
2525
}
2626
],
27-
"notes": "The deliberately public fixture metadata and generated station identifier are unchanged. The temporary station was deleted and the account returned from zero stations to zero."
27+
"notes": "The deliberately public fixture metadata and generated station identifier are unchanged. The temporary station was deleted and the account returned from one station to zero."
2828
}

0 commit comments

Comments
 (0)