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

rebuild API docs 📝

Browse source
This commit is contained in:
Jannis R 2022-06-16 13:30:30 +02:00
parent 2cdd7dc172
commit ef3760ffd3
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api.md
View file

@ -381,7 +381,7 @@ parameter | description | type | default value
`remarks` | Parse & return hints & warnings? | boolean | `true` `remarks` | Parse & return hints & warnings? | boolean | `true`
`scheduledDays` | Parse & return dates each journey is valid on? | boolean | `false` `scheduledDays` | Parse & return dates each journey is valid on? | boolean | `false`
`language` | Language of the results. | string | `en` `language` | Language of the results. | string | `en`
`loyaltyCard` | Type of loyalty card in use. See https://github.com/public-transport/hafas-client/blob/68ecd7c5e976dd2f51c5c64a81600e7e181a8996/p/db/loyalty-cards.js#L6-L11. | string | *none* `loyaltyCard` | Type of loyalty card in use. | string | *none*
`firstClass` | Search for first-class options? | boolean | `false` `firstClass` | Search for first-class options? | 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`