Pagwin/BinghamtonBetterBus-v2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update api_spec.md - fix typo

Browse source
This commit is contained in:
Levi Lesches 2025-03-24 19:52:52 -04:00 committed by GitHub
parent ba76aa55da
commit e41e94ed9f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/api_spec.md
View file

@ -4,7 +4,7 @@
- `/trips/` - `/trips/`
- `/trips/{id}` - `/trips/{id}`
- `/stops/{id}` - `/stops/{id}`
- `/path?start_lat={lattitude}&start_lon={longitude}&end_lat={lattitude}&end_lon={longitude}&time={unix_epoch}` - `/path?start_lat={latitude}&start_lon={longitude}&end_lat={latitude}&end_lon={longitude}&time={unix_epoch}`
## `/trips` ## `/trips`
@ -21,7 +21,7 @@ json object describing a route, I'm planning on this having an infinite cache ti
# stops in order of when the bus reaches them # stops in order of when the bus reaches them
"stops": [{ "stops": [{
"href":"https://$base_domain/stops/{id}", "href":"https://$base_domain/stops/{id}",
"lattitude":{lattitude}, "latitude":{latitude},
"longitude":{longitude}, "longitude":{longitude},
"times":[ "times":[
{"dotw": "Mo, Tu, We, Th, Fr, Sa or Su", "time": "HH:MM"}, {"dotw": "Mo, Tu, We, Th, Fr, Sa or Su", "time": "HH:MM"},
@ -51,17 +51,17 @@ json object describing a route, I'm planning on this having an infinite cache ti
} }
] ]
} }
"lattitude": {lattitude}, "latitude": {latitude},
"longitude": {longitude} "longitude": {longitude}
} }
``` ```
`/path?start_lat={lattitude}&start_lon={longitude}&end_lat={lattitude}&end_lon={longitude}&time={unix_epoch}` `/path?start_lat={latitude}&start_lon={longitude}&end_lat={latitude}&end_lon={longitude}&time={unix_epoch}`
```yaml ```yaml
{ {
"_links":{ "_links":{
"self":{ "self":{
"href": "https://$base_domain/path?start_lat={lattitude}&start_lon={longitude}&end_lat={lattitude}&end_lon={longitude}&time={unix_epoch}" "href": "https://$base_domain/path?start_lat={latitude}&start_lon={longitude}&end_lat={latitude}&end_lon={longitude}&time={unix_epoch}"
} }
"path":[ "path":[
{ {
@ -71,13 +71,13 @@ json object describing a route, I'm planning on this having an infinite cache ti
}, },
"enter_bus":{ "enter_bus":{
"href":"https://$base_domain/stops/{id}", "href":"https://$base_domain/stops/{id}",
"lattitude": # {lattitude}, "latitude": # {latitude},
"longitude": # {longitude}, "longitude": # {longitude},
"time": "same format as above", "time": "same format as above",
}, },
"exit_bus":{ "exit_bus":{
"href":"https://$base_domain/stops/{id}", "href":"https://$base_domain/stops/{id}",
"lattitude": # {lattitude}, "latitude": # {latitude},
"longitude": # {longitude}, "longitude": # {longitude},
"time": "same format as above", "time": "same format as above",
}, },