From 55e7913f5e8e9340ea56237ace241c64cc0681d3 Mon Sep 17 00:00:00 2001 From: sharhio Date: Thu, 7 Nov 2024 13:58:46 +0200 Subject: [PATCH] Updater config documentation --- doc/user/UpdaterConfig.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/user/UpdaterConfig.md b/doc/user/UpdaterConfig.md index cc5e1d75901..6638c1e95b4 100644 --- a/doc/user/UpdaterConfig.md +++ b/doc/user/UpdaterConfig.md @@ -317,6 +317,7 @@ GBFS form factors: |---------------------------------------------------------------------------------------|:---------------:|---------------------------------------------------------------------------------|:----------:|---------------|:-----:| | type = "vehicle-rental" | `enum` | The type of the updater. | *Required* | | 1.5 | | [allowKeepingRentedVehicleAtDestination](#u_1_allowKeepingRentedVehicleAtDestination) | `boolean` | If a vehicle should be allowed to be kept at the end of a station-based rental. | *Optional* | `false` | 2.1 | +| [allowedRentalType](#u_1_allowedRentalType) | `enum` | The type of rental data to include. | *Optional* | `"all"` | 2.7 | | frequency | `duration` | How often the data should be updated. | *Optional* | `"PT1M"` | 1.5 | | [geofencingZones](#u_1_geofencingZones) | `boolean` | Compute rental restrictions based on GBFS 2.2 geofencing zones. | *Optional* | `false` | 2.3 | | language | `string` | TODO | *Optional* | | 2.1 | @@ -346,6 +347,21 @@ For this to be possible three things need to be configured: - If keeping the vehicle at the destination should be discouraged, then `keepingRentedVehicleAtDestinationCost` (default: 0) may also be set in the routing defaults. +

allowedRentalType

+ +**Since version:** `2.7` ∙ **Type:** `enum` ∙ **Cardinality:** `Optional` ∙ **Default value:** `"all"` +**Path:** /updaters/[1] +**Enum values:** `stations` | `vehicles` | `all` + +The type of rental data to include. + +The type of rental data to include. This can be one of the following: + +- `ALL`: Include all data types. +- `STATIONS`: Include station data only. +- `VEHICLES`: Include floating vehicle data only. + +

geofencingZones

**Since version:** `2.3` ∙ **Type:** `boolean` ∙ **Cardinality:** `Optional` ∙ **Default value:** `false`