Skip to content

Commit

Permalink
Add nicer toString
Browse files Browse the repository at this point in the history
  • Loading branch information
@leonardehrenfried
leonardehrenfried committed Mar 26, 2024
1 parent 999f28b commit 95c4f6c
Show file tree
Hide file tree
Showing 6 changed files with 91 additions and 71 deletions.
6 changes: 6 additions & 0 deletions docs/RouterConfiguration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,12 @@ Used to group requests when monitoring OTP.
"Authorization" : "${BIKELY_AUTHORIZATION}"
}
},
{
"type" : "vehicle-parking",
"feedId" : "noi",
"sourceType" : "noi-open-data-hub",
"url" : "https://parking.otp.opendatahub.com/parking/all.json"
},
{
"type" : "stop-time-updater",
"frequency" : "1m",
Expand Down
36 changes: 18 additions & 18 deletions docs/UpdaterConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,20 +92,20 @@ The information is downloaded in a single HTTP request and polled regularly.
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
|-----------------------------------------------------------------------|:---------------:|----------------------------------------------------------------------------|:----------:|----------------------|:-----:|
| type = "stop-time-updater" | `enum` | The type of the updater. | *Required* | | 1.5 |
| [backwardsDelayPropagationType](#u__5__backwardsDelayPropagationType) | `enum` | How backwards propagation should be handled. | *Optional* | `"required-no-data"` | 2.2 |
| [backwardsDelayPropagationType](#u__6__backwardsDelayPropagationType) | `enum` | How backwards propagation should be handled. | *Optional* | `"required-no-data"` | 2.2 |
| feedId | `string` | Which feed the updates apply to. | *Required* | | 1.5 |
| frequency | `duration` | How often the data should be downloaded. | *Optional* | `"PT1M"` | 1.5 |
| fuzzyTripMatching | `boolean` | If the trips should be matched fuzzily. | *Optional* | `false` | 1.5 |
| [url](#u__5__url) | `string` | The URL of the GTFS-RT resource. | *Required* | | 1.5 |
| [headers](#u__5__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.3 |
| [url](#u__6__url) | `string` | The URL of the GTFS-RT resource. | *Required* | | 1.5 |
| [headers](#u__6__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.3 |


##### Parameter details

<h4 id="u__5__backwardsDelayPropagationType">backwardsDelayPropagationType</h4>
<h4 id="u__6__backwardsDelayPropagationType">backwardsDelayPropagationType</h4>

**Since version:** `2.2` ∙ **Type:** `enum` ∙ **Cardinality:** `Optional` ∙ **Default value:** `"required-no-data"`
**Path:** /updaters/[5]
**Path:** /updaters/[6]
**Enum values:** `required-no-data` | `required` | `always`

How backwards propagation should be handled.
Expand All @@ -124,19 +124,19 @@ How backwards propagation should be handled.
The updated times are exposed through APIs.


<h4 id="u__5__url">url</h4>
<h4 id="u__6__url">url</h4>

**Since version:** `1.5` ∙ **Type:** `string` ∙ **Cardinality:** `Required`
**Path:** /updaters/[5]
**Path:** /updaters/[6]

The URL of the GTFS-RT resource.

`file:` URLs are also supported if you want to read a file from the local disk.

<h4 id="u__5__headers">headers</h4>
<h4 id="u__6__headers">headers</h4>

**Since version:** `2.3` ∙ **Type:** `map of string` ∙ **Cardinality:** `Optional`
**Path:** /updaters/[5]
**Path:** /updaters/[6]

HTTP headers to add to the request. Any header key, value can be inserted.

Expand Down Expand Up @@ -178,7 +178,7 @@ This system powers the realtime updates in Helsinki and more information can be
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
|-----------------------------------------------------------------------|:---------:|----------------------------------------------|:----------:|----------------------|:-----:|
| type = "mqtt-gtfs-rt-updater" | `enum` | The type of the updater. | *Required* | | 1.5 |
| [backwardsDelayPropagationType](#u__6__backwardsDelayPropagationType) | `enum` | How backwards propagation should be handled. | *Optional* | `"required-no-data"` | 2.2 |
| [backwardsDelayPropagationType](#u__7__backwardsDelayPropagationType) | `enum` | How backwards propagation should be handled. | *Optional* | `"required-no-data"` | 2.2 |
| feedId | `string` | The feed id to apply the updates to. | *Required* | | 2.0 |
| fuzzyTripMatching | `boolean` | Whether to match trips fuzzily. | *Optional* | `false` | 2.0 |
| qos | `integer` | QOS level. | *Optional* | `0` | 2.0 |
Expand All @@ -188,10 +188,10 @@ This system powers the realtime updates in Helsinki and more information can be

##### Parameter details

<h4 id="u__6__backwardsDelayPropagationType">backwardsDelayPropagationType</h4>
<h4 id="u__7__backwardsDelayPropagationType">backwardsDelayPropagationType</h4>

**Since version:** `2.2` ∙ **Type:** `enum` ∙ **Cardinality:** `Optional` ∙ **Default value:** `"required-no-data"`
**Path:** /updaters/[6]
**Path:** /updaters/[7]
**Enum values:** `required-no-data` | `required` | `always`

How backwards propagation should be handled.
Expand Down Expand Up @@ -247,24 +247,24 @@ The information is downloaded in a single HTTP request and polled regularly.
| frequency | `duration` | How often the positions should be updated. | *Optional* | `"PT1M"` | 2.2 |
| fuzzyTripMatching | `boolean` | Whether to match trips fuzzily. | *Optional* | `false` | 2.5 |
| url | `uri` | The URL of GTFS-RT protobuf HTTP resource to download the positions from. | *Required* | | 2.2 |
| [features](#u__7__features) | `enum set` | Which features of GTFS RT vehicle positions should be loaded into OTP. | *Optional* | | 2.5 |
| [headers](#u__7__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.3 |
| [features](#u__8__features) | `enum set` | Which features of GTFS RT vehicle positions should be loaded into OTP. | *Optional* | | 2.5 |
| [headers](#u__8__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.3 |


##### Parameter details

<h4 id="u__7__features">features</h4>
<h4 id="u__8__features">features</h4>

**Since version:** `2.5` ∙ **Type:** `enum set` ∙ **Cardinality:** `Optional`
**Path:** /updaters/[7]
**Path:** /updaters/[8]
**Enum values:** `position` | `stop-position` | `occupancy`

Which features of GTFS RT vehicle positions should be loaded into OTP.

<h4 id="u__7__headers">headers</h4>
<h4 id="u__8__headers">headers</h4>

**Since version:** `2.3` ∙ **Type:** `map of string` ∙ **Cardinality:** `Optional`
**Path:** /updaters/[7]
**Path:** /updaters/[8]

HTTP headers to add to the request. Any header key, value can be inserted.

Expand Down
48 changes: 24 additions & 24 deletions docs/sandbox/siri/SiriAzureUpdater.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ To enable the SIRI updater you need to add it to the updaters section of the `ro
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
|------------------------------------------------------------|:----------:|------------------------------------------------------------------|:----------:|---------------------|:-----:|
| type = "siri-azure-et-updater" | `enum` | The type of the updater. | *Required* | | 1.5 |
| [authenticationType](#u__11__authenticationType) | `enum` | Which authentication type to use | *Optional* | `"sharedaccesskey"` | 2.5 |
| [authenticationType](#u__12__authenticationType) | `enum` | Which authentication type to use | *Optional* | `"sharedaccesskey"` | 2.5 |
| autoDeleteOnIdle | `duration` | The time after which an inactive subscription is removed. | *Optional* | `"PT1H"` | 2.5 |
| [customMidnight](#u__11__customMidnight) | `integer` | Time on which time breaks into new day. | *Optional* | `0` | 2.2 |
| [customMidnight](#u__12__customMidnight) | `integer` | Time on which time breaks into new day. | *Optional* | `0` | 2.2 |
| feedId | `string` | The ID of the feed to apply the updates to. | *Optional* | | 2.2 |
| [fullyQualifiedNamespace](#u__11__fullyQualifiedNamespace) | `string` | Service Bus fully qualified namespace used for authentication. | *Optional* | | 2.5 |
| [fullyQualifiedNamespace](#u__12__fullyQualifiedNamespace) | `string` | Service Bus fully qualified namespace used for authentication. | *Optional* | | 2.5 |
| fuzzyTripMatching | `boolean` | Whether to apply fuzzyTripMatching on the updates | *Optional* | `false` | 2.2 |
| prefetchCount | `integer` | The number of messages to fetch from the subscription at a time. | *Optional* | `10` | 2.5 |
| [servicebus-url](#u__11__servicebus_url) | `string` | Service Bus connection used for authentication. | *Optional* | | 2.2 |
| [servicebus-url](#u__12__servicebus_url) | `string` | Service Bus connection used for authentication. | *Optional* | | 2.2 |
| topic | `string` | Service Bus topic to connect to. | *Optional* | | 2.2 |
| history | `object` | Configuration for fetching historical data on startup | *Optional* | | 2.2 |
|    fromDateTime | `string` | Datetime boundary for historical data | *Optional* | `"-P1D"` | 2.2 |
Expand All @@ -41,36 +41,36 @@ To enable the SIRI updater you need to add it to the updaters section of the `ro

##### Parameter details

<h4 id="u__11__authenticationType">authenticationType</h4>
<h4 id="u__12__authenticationType">authenticationType</h4>

**Since version:** `2.5` ∙ **Type:** `enum` ∙ **Cardinality:** `Optional` ∙ **Default value:** `"sharedaccesskey"`
**Path:** /updaters/[11]
**Path:** /updaters/[12]
**Enum values:** `sharedaccesskey` | `federatedidentity`

Which authentication type to use

<h4 id="u__11__customMidnight">customMidnight</h4>
<h4 id="u__12__customMidnight">customMidnight</h4>

**Since version:** `2.2` ∙ **Type:** `integer` ∙ **Cardinality:** `Optional` ∙ **Default value:** `0`
**Path:** /updaters/[11]
**Path:** /updaters/[12]

Time on which time breaks into new day.

It is common that operating day date breaks a little bit later than midnight so that the switch happens when traffic is at the lowest point. Parameter uses 24-hour format. If the switch happens on 4 am then set this field to 4.

<h4 id="u__11__fullyQualifiedNamespace">fullyQualifiedNamespace</h4>
<h4 id="u__12__fullyQualifiedNamespace">fullyQualifiedNamespace</h4>

**Since version:** `2.5` ∙ **Type:** `string` ∙ **Cardinality:** `Optional`
**Path:** /updaters/[11]
**Path:** /updaters/[12]

Service Bus fully qualified namespace used for authentication.

Has to be present for authenticationMethod FederatedIdentity.

<h4 id="u__11__servicebus_url">servicebus-url</h4>
<h4 id="u__12__servicebus_url">servicebus-url</h4>

**Since version:** `2.2` ∙ **Type:** `string` ∙ **Cardinality:** `Optional`
**Path:** /updaters/[11]
**Path:** /updaters/[12]

Service Bus connection used for authentication.

Expand Down Expand Up @@ -112,14 +112,14 @@ Has to be present for authenticationMethod SharedAccessKey. This should be Prima
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
|------------------------------------------------------------|:----------:|------------------------------------------------------------------|:----------:|---------------------|:-----:|
| type = "siri-azure-sx-updater" | `enum` | The type of the updater. | *Required* | | 1.5 |
| [authenticationType](#u__10__authenticationType) | `enum` | Which authentication type to use | *Optional* | `"sharedaccesskey"` | 2.5 |
| [authenticationType](#u__11__authenticationType) | `enum` | Which authentication type to use | *Optional* | `"sharedaccesskey"` | 2.5 |
| autoDeleteOnIdle | `duration` | The time after which an inactive subscription is removed. | *Optional* | `"PT1H"` | 2.5 |
| [customMidnight](#u__10__customMidnight) | `integer` | Time on which time breaks into new day. | *Optional* | `0` | 2.2 |
| [customMidnight](#u__11__customMidnight) | `integer` | Time on which time breaks into new day. | *Optional* | `0` | 2.2 |
| feedId | `string` | The ID of the feed to apply the updates to. | *Optional* | | 2.2 |
| [fullyQualifiedNamespace](#u__10__fullyQualifiedNamespace) | `string` | Service Bus fully qualified namespace used for authentication. | *Optional* | | 2.5 |
| [fullyQualifiedNamespace](#u__11__fullyQualifiedNamespace) | `string` | Service Bus fully qualified namespace used for authentication. | *Optional* | | 2.5 |
| fuzzyTripMatching | `boolean` | Whether to apply fuzzyTripMatching on the updates | *Optional* | `false` | 2.2 |
| prefetchCount | `integer` | The number of messages to fetch from the subscription at a time. | *Optional* | `10` | 2.5 |
| [servicebus-url](#u__10__servicebus_url) | `string` | Service Bus connection used for authentication. | *Optional* | | 2.2 |
| [servicebus-url](#u__11__servicebus_url) | `string` | Service Bus connection used for authentication. | *Optional* | | 2.2 |
| topic | `string` | Service Bus topic to connect to. | *Optional* | | 2.2 |
| history | `object` | Configuration for fetching historical data on startup | *Optional* | | 2.2 |
|    fromDateTime | `string` | Datetime boundary for historical data. | *Optional* | `"-P1D"` | 2.2 |
Expand All @@ -130,36 +130,36 @@ Has to be present for authenticationMethod SharedAccessKey. This should be Prima

##### Parameter details

<h4 id="u__10__authenticationType">authenticationType</h4>
<h4 id="u__11__authenticationType">authenticationType</h4>

**Since version:** `2.5` ∙ **Type:** `enum` ∙ **Cardinality:** `Optional` ∙ **Default value:** `"sharedaccesskey"`
**Path:** /updaters/[10]
**Path:** /updaters/[11]
**Enum values:** `sharedaccesskey` | `federatedidentity`

Which authentication type to use

<h4 id="u__10__customMidnight">customMidnight</h4>
<h4 id="u__11__customMidnight">customMidnight</h4>

**Since version:** `2.2` ∙ **Type:** `integer` ∙ **Cardinality:** `Optional` ∙ **Default value:** `0`
**Path:** /updaters/[10]
**Path:** /updaters/[11]

Time on which time breaks into new day.

It is common that operating day date breaks a little bit later than midnight so that the switch happens when traffic is at the lowest point. Parameter uses 24-hour format. If the switch happens on 4 am then set this field to 4.

<h4 id="u__10__fullyQualifiedNamespace">fullyQualifiedNamespace</h4>
<h4 id="u__11__fullyQualifiedNamespace">fullyQualifiedNamespace</h4>

**Since version:** `2.5` ∙ **Type:** `string` ∙ **Cardinality:** `Optional`
**Path:** /updaters/[10]
**Path:** /updaters/[11]

Service Bus fully qualified namespace used for authentication.

Has to be present for authenticationMethod FederatedIdentity.

<h4 id="u__10__servicebus_url">servicebus-url</h4>
<h4 id="u__11__servicebus_url">servicebus-url</h4>

**Since version:** `2.2` ∙ **Type:** `string` ∙ **Cardinality:** `Optional`
**Path:** /updaters/[10]
**Path:** /updaters/[11]

Service Bus connection used for authentication.

Expand Down
Loading

0 comments on commit 95c4f6c

Please sign in to comment.