From a34fe93230c63b786c51f0244ad4649caf6e523d Mon Sep 17 00:00:00 2001 From: Jannis R Date: Thu, 4 Feb 2021 19:20:03 +0100 Subject: [PATCH] =?UTF-8?q?hafas-rest-api@3.6,=20rebuild=20docs=20?= =?UTF-8?q?=F0=9F=93=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api.md | 30 +++++++++++++++--------------- package.json | 2 +- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/api.md b/docs/api.md index 528a5a9..be40eaf 100644 --- a/docs/api.md +++ b/docs/api.md @@ -37,7 +37,7 @@ parameter | description | type | default value ----------|-------------|------|-------------- `query` | **Required.** | string | – `fuzzy` | Find more than exact matches? | boolean | `true` -`results` | How many stations shall be shown? | number | `10` +`results` | How many stations shall be shown? | integer | `10` `stops` | Show stops/stations? | boolean | `true` `addresses` | Show points of interest? | boolean | `true` `poi` | Show addresses? | boolean | `true` @@ -82,8 +82,8 @@ parameter | description | type | default value ----------|-------------|------|-------------- `latitude` | **Required.** | number | – `longitude` | **Required.** | number | – -`results` | maximum number of results | number | `8` -`distance` | maximum walking distance in meters | number | – +`results` | maximum number of results | integer | `8` +`distance` | maximum walking distance in meters | integer | – `stops` | Return stops/stations? | boolean | `true` `poi` | Return points of interest? | boolean | `false` `linesOfStops` | Parse & expose lines at each stop/station? | boolean | `false` @@ -141,8 +141,8 @@ parameter | description | type | default value `longitude` | **Required.** | number | – `address` | **Required.** | string | – `when` | Date & time to compute the reachability for. See [date/time parameters](#datetime-parameters). | date+time | *now* -`maxTransfers` | Maximum number of transfers. | number | `5` -`maxDuration` | Maximum travel duration, in minutes. | number | *infinite* +`maxTransfers` | Maximum number of transfers. | integer | `5` +`maxDuration` | Maximum travel duration, in minutes. | integer | *infinite* `language` | Language of the results. | string | `en` `nationalExpress` | Include InterCityExpress (ICE)? | boolean | `true` `national` | Include InterCity & EuroCity (IC/EC)? | boolean | `true` @@ -244,8 +244,8 @@ parameter | description | type | default value ----------|-------------|------|-------------- `when` | Date & time to get departures for. See [date/time parameters](#datetime-parameters). | date+time | *now* `direction` | Filter departures by direction. | string |   -`duration` | Show departures for how many minutes? | number | `10` -`results` | Max. number of departures. | number | *whatever HAFAS wants +`duration` | Show departures for how many minutes? | integer | `10` +`results` | Max. number of departures. | integer | *whatever HAFAS wants `linesOfStops` | Parse & return lines of each stop/station? | boolean | `false` `remarks` | Parse & return hints & warnings? | boolean | `true` `language` | Language of the results. | string | `en` @@ -314,8 +314,8 @@ parameter | description | type | default value ----------|-------------|------|-------------- `when` | Date & time to get departures for. See [date/time parameters](#datetime-parameters). | date+time | *now* `direction` | Filter departures by direction. | string |   -`duration` | Show departures for how many minutes? | number | `10` -`results` | Max. number of departures. | number | *whatever HAFAS wants* +`duration` | Show departures for how many minutes? | integer | `10` +`results` | Max. number of departures. | integer | *whatever HAFAS wants* `linesOfStops` | Parse & return lines of each stop/station? | boolean | `false` `remarks` | Parse & return hints & warnings? | boolean | `true` `language` | Language of the results. | string | `en` @@ -364,10 +364,10 @@ parameter | description | type | default value `arrival` | Compute journeys arriving at this date/time. Mutually exclusive with `departure`. See [date/time parameters](#datetime-parameters). | date+time | *now* `earlierThan` | Compute journeys "before" an `ealierRef`. | string |   `laterThan` | Compute journeys "after" an `laterRef`. | string |   -`results` | Max. number of journeys. | number | `3` +`results` | Max. number of journeys. | integer | `3` `stopovers` | Fetch & parse stopovers on the way? | boolean | `false` -`transfers` | Maximum number of transfers. | number | *let HAFAS decide* -`transferTime` | Minimum time in minutes for a single transfer. | number | `0` +`transfers` | Maximum number of transfers. | integer | *let HAFAS decide* +`transferTime` | Minimum time in minutes for a single transfer. | integer | `0` `accessibility` | `partial` or `complete`. | string | *not accessible* `bike` | Compute only bike-friendly journeys? | boolean | `false` `startWithWalking` | Consider walking to nearby stations at the beginning of a journey? | boolean | `true` @@ -587,9 +587,9 @@ parameter | description | type | default value `west` | **Required.** Western longitude. | number | – `south` | **Required.** Southern latitude. | number | – `east` | **Required.** Eastern longitude. | number | – -`results` | Max. number of vehicles. | number | `256` -`duration` | Compute frames for the next `n` seconds. | number | `30` -`frames` | Number of frames to compute. | number | `3` +`results` | Max. number of vehicles. | integer | `256` +`duration` | Compute frames for the next `n` seconds. | integer | `30` +`frames` | Number of frames to compute. | integer | `3` `polylines` | Fetch & parse a geographic shape for the movement of each vehicle? | boolean | `true` `language` | Language of the results. | string | `en` diff --git a/package.json b/package.json index 30757b8..21111c7 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,7 @@ "db-stations-autocomplete": "^2.2.0", "etag": "^1.8.1", "hafas-client-health-check": "^2.1.1", - "hafas-rest-api": "^3.3.0", + "hafas-rest-api": "^3.6.0", "redis": "^3.0.2", "serve-buffer": "^2.0.0", "serve-static": "^1.14.1"