mirror of
https://github.com/public-transport/db-vendo-client.git
synced 2025-02-22 14:49:36 +02:00
docs
This commit is contained in:
parent
177a3cab3f
commit
f1302b0a7b
2 changed files with 10 additions and 9 deletions
|
@ -24,7 +24,7 @@ With `opt`, you can override the default options, which look like this:
|
|||
```js
|
||||
{
|
||||
when: new Date(),
|
||||
direction: null, // not supported
|
||||
direction: null, // only supported in `dbweb` and with `enrichStations=true` (experimental)
|
||||
line: null, // not supported
|
||||
duration: 10, // show departures for the next n minutes
|
||||
results: null, // max. number of results; `null` means "whatever HAFAS wants"
|
||||
|
@ -35,7 +35,7 @@ With `opt`, you can override the default options, which look like this:
|
|||
stopovers: false, // fetch & parse previous/next stopovers?, only supported with `dbweb` profile
|
||||
// departures at related stations
|
||||
// e.g. those that belong together on the metro map.
|
||||
includeRelatedStations: true, // only true supported
|
||||
includeRelatedStations: true,
|
||||
language: 'en' // language to get results in
|
||||
}
|
||||
```
|
||||
|
|
|
@ -385,13 +385,14 @@ paths:
|
|||
- bahncard-2nd-25
|
||||
- bahncard-1st-50
|
||||
- bahncard-2nd-50
|
||||
- bahncard-1st-100
|
||||
- bahncard-2nd-100
|
||||
- vorteilscard
|
||||
- halbtaxabo-railplus
|
||||
- halbtaxabo
|
||||
- voordeelurenabo-railplus
|
||||
- voordeelurenabo
|
||||
- shcard
|
||||
- generalabonnement
|
||||
- generalabonnement-1st
|
||||
- generalabonnement-2nd
|
||||
- nl-40
|
||||
- at-klimaticket
|
||||
- name: firstClass
|
||||
in: query
|
||||
description: Search for first-class options?
|
||||
|
@ -2087,7 +2088,7 @@ components:
|
|||
type: string
|
||||
format: date-time
|
||||
direction:
|
||||
description: only show departures heading to this station
|
||||
description: only show departures heading to this station, only supported for `dbweb` profile
|
||||
default: undefined
|
||||
type: string
|
||||
line:
|
||||
|
@ -2124,7 +2125,7 @@ components:
|
|||
type: boolean
|
||||
includeRelatedStations:
|
||||
description: departures at related stations
|
||||
default: false
|
||||
default: true
|
||||
type: boolean
|
||||
products:
|
||||
$ref: '#/components/schemas/Products'
|
||||
|
|
Loading…
Add table
Reference in a new issue