kbruen/db-vendo-client
1
0
Fork 0
mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-02-22 22:59:35 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

docs

Browse source
This commit is contained in:
Traines 2025-02-13 23:33:45 +00:00
parent 177a3cab3f
commit f1302b0a7b
2 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/departures.md
View file

@ -24,7 +24,7 @@ With `opt`, you can override the default options, which look like this:
```js ```js
{ {
when: new Date(), when: new Date(),
direction: null, // not supported direction: null, // only supported in `dbweb` and with `enrichStations=true` (experimental)
line: null, // not supported line: null, // not supported
duration: 10, // show departures for the next n minutes duration: 10, // show departures for the next n minutes
results: null, // max. number of results; `null` means "whatever HAFAS wants" 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 stopovers: false, // fetch & parse previous/next stopovers?, only supported with `dbweb` profile
// departures at related stations // departures at related stations
// e.g. those that belong together on the metro map. // e.g. those that belong together on the metro map.
includeRelatedStations: true, // only true supported includeRelatedStations: true,
language: 'en' // language to get results in language: 'en' // language to get results in
} }
``` ```

15
docs/openapi.yaml
View file

@ -385,13 +385,14 @@ paths:
- bahncard-2nd-25 - bahncard-2nd-25
- bahncard-1st-50 - bahncard-1st-50
- bahncard-2nd-50 - bahncard-2nd-50
- bahncard-1st-100
- bahncard-2nd-100
- vorteilscard - vorteilscard
- halbtaxabo-railplus
- halbtaxabo - halbtaxabo
- voordeelurenabo-railplus - generalabonnement-1st
- voordeelurenabo - generalabonnement-2nd
- shcard - nl-40
- generalabonnement - at-klimaticket
- name: firstClass - name: firstClass
in: query in: query
description: Search for first-class options? description: Search for first-class options?
@ -2087,7 +2088,7 @@ components:
type: string type: string
format: date-time format: date-time
direction: direction:
description: only show departures heading to this station description: only show departures heading to this station, only supported for `dbweb` profile
default: undefined default: undefined
type: string type: string
line: line:
@ -2124,7 +2125,7 @@ components:
type: boolean type: boolean
includeRelatedStations: includeRelatedStations:
description: departures at related stations description: departures at related stations
default: false default: true
type: boolean type: boolean
products: products:
$ref: '#/components/schemas/Products' $ref: '#/components/schemas/Products'