Added a /conditions/current endpoint with computed best-guess values for current conditions
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:
13
README.md
13
README.md
@@ -22,13 +22,18 @@ Example:
|
||||
|
||||
## Endpoints
|
||||
|
||||
- `GET /observations/current`
|
||||
- `GET /conditions/current`
|
||||
- `GET /observations?count=<1..100>&units=<us|metric>`
|
||||
- `GET /forecast?timestamp=<RFC3339 timestamp>`
|
||||
- `GET /alerts/current`
|
||||
|
||||
By default, API output is US units for temperature and wind speed:
|
||||
- temperature fields: Fahrenheit (`*F`)
|
||||
- wind fields: mph (`*Mph`)
|
||||
Default unit behavior:
|
||||
- `/conditions/current`: US units
|
||||
- `/observations`: metric units
|
||||
- `/forecast`: US units
|
||||
|
||||
`/conditions/current`, `/observations`, and `/forecast` support `?units=us|metric`.
|
||||
`/observations` defaults to `count=5` and validates `count` strictly in range `1..100`.
|
||||
|
||||
## Run
|
||||
|
||||
|
||||
Reference in New Issue
Block a user