diff --git a/docs/journeys.md b/docs/journeys.md index 73466b55..8b576890 100644 --- a/docs/journeys.md +++ b/docs/journeys.md @@ -75,7 +75,9 @@ With `opt`, you can override the default options, which look like this: subStops: true, // not supported entrances: true, // not supported remarks: true, // parse & expose hints & warnings? - scheduledDays: false, // not yet supported + scheduledDays: false, // returns a field `serviceDays` (instead of `scheduledDays` in hafas-client!) with a different, human-readable structure + notOnlyFastRoutes: false, // if true, also show journeys that are mathematically non-optimal + bestprice: false, // search for lowest prices across the entire day, returns list of journeys sorted by price firstClass: false, // first or second class for tickets loyaltyCard: null, // BahnCards etc., see below language: 'en', // language to get results in diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 42e525d9..665a9ae5 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -365,7 +365,19 @@ paths: default: true - name: scheduledDays in: query - description: Parse & return dates each journey is valid on? + description: Parse & return dates the journey is valid on?, returns a field `serviceDays` (instead of `scheduledDays` in hafas-client!) with a different, human-readable structure + schema: + type: boolean + default: false + - name: notOnlyFastRoutes + in: query + description: if true, also show journeys that are mathematically non-optimal + schema: + type: boolean + default: false + - name: bestprice + in: query + description: search for lowest prices across the entire day schema: type: boolean default: false @@ -683,7 +695,19 @@ paths: default: true - name: scheduledDays in: query - description: Parse & return dates the journey is valid on? + description: Parse & return dates the journey is valid on?, returns a field `serviceDays` (instead of `scheduledDays` in hafas-client!) with a different, human-readable structure + schema: + type: boolean + default: false + - name: notOnlyFastRoutes + in: query + description: if true, also show journeys that are mathematically non-optimal + schema: + type: boolean + default: false + - name: bestprice + in: query + description: search for lowest prices across the entire day schema: type: boolean default: false diff --git a/readme.md b/readme.md index 5c28a2fb..068d8aaa 100644 --- a/readme.md +++ b/readme.md @@ -8,14 +8,14 @@ This is an early version. What works: -* `journeys()`, `refreshJourney()` including tickets +* `journeys()`, `refreshJourney()` including tickets and bestprice option * `locations()`, `nearby()`, * `departures()`, `arrivals()` boards * `trip()` What doesn't work: -* `journeys()` details like scheduledDays, stop/station groups, some line details ... +* `journeys()` details like stop/station groups, some line details ... * loadFactor and other details in boards * certain stop details like products for `locations()` and geopositions for boards – this can be remedied with `enrichStations` in the config (turned on by default), enriching stop info with [db-hafas-stations](https://github.com/derhuerst/db-hafas-stations). * some query options/filters (e.g. routingMode for journeys, direction for boards)