simono41/db-rest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rebuild API docs 📝

Browse source 
opt.{includeRelatedStations,stopovers} are not supported by most HAFAS endpoints anymore.
This commit is contained in:
Jannis R 2022-03-25 18:13:05 +01:00
parent 202160f0a9
commit 97b1c10d7c
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
1 changed files with 0 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api.md
View file

@ -255,8 +255,6 @@ parameter | description | type | default value
`linesOfStops` | Parse & return lines of each stop/station? | boolean | `false` `linesOfStops` | Parse & return lines of each stop/station? | boolean | `false`
`remarks` | Parse & return hints & warnings? | boolean | `true` `remarks` | Parse & return hints & warnings? | boolean | `true`
`language` | Language of the results. | string | `en` `language` | Language of the results. | string | `en`
`includeRelatedStations` | Fetch departures at related stops, e.g. those that belong together on the metro map? | boolean | `true`
`stopovers` | Fetch & parse next stopovers of each departure? | boolean | `false`
`nationalExpress` | Include InterCityExpress (ICE)? | boolean | `true` `nationalExpress` | Include InterCityExpress (ICE)? | boolean | `true`
`national` | Include InterCity & EuroCity (IC/EC)? | boolean | `true` `national` | Include InterCity & EuroCity (IC/EC)? | boolean | `true`
`regionalExp` | Include RegionalExpress & InterRegio (RE/IR)? | boolean | `true` `regionalExp` | Include RegionalExpress & InterRegio (RE/IR)? | boolean | `true`
@ -326,8 +324,6 @@ parameter | description | type | default value
`linesOfStops` | Parse & return lines of each stop/station? | boolean | `false` `linesOfStops` | Parse & return lines of each stop/station? | boolean | `false`
`remarks` | Parse & return hints & warnings? | boolean | `true` `remarks` | Parse & return hints & warnings? | boolean | `true`
`language` | Language of the results. | string | `en` `language` | Language of the results. | string | `en`
`includeRelatedStations` | Fetch departures at related stops, e.g. those that belong together on the metro map? | boolean | `true`
`stopovers` | Fetch & parse next stopovers of each departure? | boolean | `false`
`nationalExpress` | Include InterCityExpress (ICE)? | boolean | `true` `nationalExpress` | Include InterCityExpress (ICE)? | boolean | `true`
`national` | Include InterCity & EuroCity (IC/EC)? | boolean | `true` `national` | Include InterCity & EuroCity (IC/EC)? | boolean | `true`
`regionalExp` | Include RegionalExpress & InterRegio (RE/IR)? | boolean | `true` `regionalExp` | Include RegionalExpress & InterRegio (RE/IR)? | boolean | `true`