From f1302b0a7b5c2fe574ff2aea5426dbfe5e87bf73 Mon Sep 17 00:00:00 2001 From: Traines Date: Thu, 13 Feb 2025 23:33:45 +0000 Subject: [PATCH] docs --- docs/departures.md | 4 ++-- docs/openapi.yaml | 15 ++++++++------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/departures.md b/docs/departures.md index 41954a96..07f647b8 100644 --- a/docs/departures.md +++ b/docs/departures.md @@ -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 } ``` diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 8599d8df..3ff865d7 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -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'