Skip to content

Commit 091e4ed

Browse files
leonardehrenfriedleonardehrenfried
committed
Update documentation
1 parent f2a76c2 commit 091e4ed

File tree

2 files changed

+51
-51
lines changed

2 files changed

+51
-51
lines changed

‎docs/sandbox/VehicleParking.md

+50-50
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,17 @@ All updaters have the following parameters in common:
3333
<!-- hsl-park BEGIN -->
3434
<!-- NOTE! This section is auto-generated. Do not change, change doc in code instead. -->
3535

36-
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
37-
|---------------------------------|:-----------:|----------------------------------------------|:----------:|---------------|:-----:|
38-
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
39-
| facilitiesFrequencySec | `integer` | How often the facilities should be updated. | *Optional* | `3600` | 2.2 |
40-
| facilitiesUrl | `string` | URL of the facilities. | *Optional* | | 2.2 |
41-
| [feedId](#u__2__feedId) | `string` | The name of the data source. | *Required* | | 2.2 |
42-
| hubsUrl | `string` | Hubs URL | *Optional* | | 2.2 |
43-
| [sourceType](#u__2__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
44-
| [timeZone](#u__2__timeZone) | `time-zone` | The time zone of the feed. | *Optional* | | 2.2 |
45-
| utilizationsFrequencySec | `integer` | How often the utilization should be updated. | *Optional* | `600` | 2.2 |
46-
| utilizationsUrl | `string` | URL of the utilization data. | *Optional* | | 2.2 |
36+
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
37+
|---------------------------------|:-----------:|------------------------------------------------------------------------------|:----------:|---------------|:-----:|
38+
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
39+
| facilitiesFrequencySec | `integer` | How often the facilities should be updated. | *Optional* | `3600` | 2.2 |
40+
| facilitiesUrl | `string` | URL of the facilities. | *Optional* | | 2.2 |
41+
| [feedId](#u__2__feedId) | `string` | The id of the data source, which will be the prefix of the parking lot's id. | *Required* | | 2.2 |
42+
| hubsUrl | `string` | Hubs URL | *Optional* | | 2.2 |
43+
| [sourceType](#u__2__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
44+
| [timeZone](#u__2__timeZone) | `time-zone` | The time zone of the feed. | *Optional* | | 2.2 |
45+
| utilizationsFrequencySec | `integer` | How often the utilization should be updated. | *Optional* | `600` | 2.2 |
46+
| utilizationsUrl | `string` | URL of the utilization data. | *Optional* | | 2.2 |
4747

4848

4949
#### Details
@@ -53,7 +53,7 @@ All updaters have the following parameters in common:
5353
**Since version:** `2.2` ∙ **Type:** `string` ∙ **Cardinality:** `Required`
5454
**Path:** /updaters/[2]
5555

56-
The name of the data source.
56+
The id of the data source, which will be the prefix of the parking lot's id.
5757

5858
This will end up in the API responses as the feed id of of the parking lot.
5959

@@ -104,16 +104,16 @@ Used for converting abstract opening hours into concrete points in time.
104104
<!-- park-api BEGIN -->
105105
<!-- NOTE! This section is auto-generated. Do not change, change doc in code instead. -->
106106

107-
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
108-
|---------------------------------|:---------------:|----------------------------------------------------------------------------|:----------:|---------------|:-----:|
109-
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
110-
| [feedId](#u__3__feedId) | `string` | The name of the data source. | *Required* | | 2.2 |
111-
| frequency | `duration` | How often to update the source. | *Optional* | `"PT1M"` | 2.2 |
112-
| [sourceType](#u__3__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
113-
| [timeZone](#u__3__timeZone) | `time-zone` | The time zone of the feed. | *Optional* | | 2.2 |
114-
| url | `string` | URL of the resource. | *Required* | | 2.2 |
115-
| [headers](#u__3__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.2 |
116-
| [tags](#u__3__tags) | `string[]` | Tags to add to the parking lots. | *Optional* | | 2.2 |
107+
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
108+
|---------------------------------|:---------------:|------------------------------------------------------------------------------|:----------:|---------------|:-----:|
109+
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
110+
| [feedId](#u__3__feedId) | `string` | The id of the data source, which will be the prefix of the parking lot's id. | *Required* | | 2.2 |
111+
| frequency | `duration` | How often to update the source. | *Optional* | `"PT1M"` | 2.2 |
112+
| [sourceType](#u__3__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
113+
| [timeZone](#u__3__timeZone) | `time-zone` | The time zone of the feed. | *Optional* | | 2.2 |
114+
| url | `string` | URL of the resource. | *Required* | | 2.2 |
115+
| [headers](#u__3__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.2 |
116+
| [tags](#u__3__tags) | `string[]` | Tags to add to the parking lots. | *Optional* | | 2.2 |
117117

118118

119119
#### Details
@@ -123,7 +123,7 @@ Used for converting abstract opening hours into concrete points in time.
123123
**Since version:** `2.2` ∙ **Type:** `string` ∙ **Cardinality:** `Required`
124124
**Path:** /updaters/[3]
125125

126-
The name of the data source.
126+
The id of the data source, which will be the prefix of the parking lot's id.
127127

128128
This will end up in the API responses as the feed id of of the parking lot.
129129

@@ -191,14 +191,14 @@ Tags to add to the parking lots.
191191
<!-- bikely BEGIN -->
192192
<!-- NOTE! This section is auto-generated. Do not change, change doc in code instead. -->
193193

194-
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
195-
|---------------------------------|:---------------:|----------------------------------------------------------------------------|:----------:|---------------|:-----:|
196-
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
197-
| [feedId](#u__4__feedId) | `string` | The name of the data source. | *Required* | | 2.2 |
198-
| frequency | `duration` | How often to update the source. | *Optional* | `"PT1M"` | 2.3 |
199-
| [sourceType](#u__4__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
200-
| url | `uri` | URL of the locations endpoint. | *Required* | | 2.3 |
201-
| [headers](#u__4__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.3 |
194+
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
195+
|---------------------------------|:---------------:|------------------------------------------------------------------------------|:----------:|---------------|:-----:|
196+
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
197+
| [feedId](#u__4__feedId) | `string` | The id of the data source, which will be the prefix of the parking lot's id. | *Required* | | 2.2 |
198+
| frequency | `duration` | How often to update the source. | *Optional* | `"PT1M"` | 2.3 |
199+
| [sourceType](#u__4__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
200+
| url | `uri` | URL of the locations endpoint. | *Required* | | 2.3 |
201+
| [headers](#u__4__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.3 |
202202

203203

204204
#### Details
@@ -208,7 +208,7 @@ Tags to add to the parking lots.
208208
**Since version:** `2.2` ∙ **Type:** `string` ∙ **Cardinality:** `Required`
209209
**Path:** /updaters/[4]
210210

211-
The name of the data source.
211+
The id of the data source, which will be the prefix of the parking lot's id.
212212

213213
This will end up in the API responses as the feed id of of the parking lot.
214214

@@ -256,14 +256,14 @@ HTTP headers to add to the request. Any header key, value can be inserted.
256256
<!-- noi-open-data-hub BEGIN -->
257257
<!-- NOTE! This section is auto-generated. Do not change, change doc in code instead. -->
258258

259-
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
260-
|---------------------------------|:---------------:|----------------------------------------------------------------------------|:----------:|---------------|:-----:|
261-
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
262-
| [feedId](#u__5__feedId) | `string` | The name of the data source. | *Required* | | 2.2 |
263-
| frequency | `duration` | How often to update the source. | *Optional* | `"PT1M"` | 2.6 |
264-
| [sourceType](#u__5__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
265-
| url | `uri` | URL of the locations endpoint. | *Required* | | 2.6 |
266-
| [headers](#u__5__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.6 |
259+
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
260+
|---------------------------------|:---------------:|------------------------------------------------------------------------------|:----------:|---------------|:-----:|
261+
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
262+
| [feedId](#u__5__feedId) | `string` | The id of the data source, which will be the prefix of the parking lot's id. | *Required* | | 2.2 |
263+
| frequency | `duration` | How often to update the source. | *Optional* | `"PT1M"` | 2.6 |
264+
| [sourceType](#u__5__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
265+
| url | `uri` | URL of the locations endpoint. | *Required* | | 2.6 |
266+
| [headers](#u__5__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.6 |
267267

268268

269269
#### Details
@@ -273,7 +273,7 @@ HTTP headers to add to the request. Any header key, value can be inserted.
273273
**Since version:** `2.2` ∙ **Type:** `string` ∙ **Cardinality:** `Required`
274274
**Path:** /updaters/[5]
275275

276-
The name of the data source.
276+
The id of the data source, which will be the prefix of the parking lot's id.
277277

278278
This will end up in the API responses as the feed id of of the parking lot.
279279

@@ -317,14 +317,14 @@ HTTP headers to add to the request. Any header key, value can be inserted.
317317
<!-- bikeep BEGIN -->
318318
<!-- NOTE! This section is auto-generated. Do not change, change doc in code instead. -->
319319

320-
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
321-
|----------------------------------|:---------------:|----------------------------------------------------------------------------|:----------:|---------------|:-----:|
322-
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
323-
| [feedId](#u__13__feedId) | `string` | The name of the data source. | *Required* | | 2.2 |
324-
| frequency | `duration` | How often to update the source. | *Optional* | `"PT1M"` | 2.6 |
325-
| [sourceType](#u__13__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
326-
| url | `uri` | URL of the locations endpoint. | *Required* | | 2.6 |
327-
| [headers](#u__13__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.6 |
320+
| Config Parameter | Type | Summary | Req./Opt. | Default Value | Since |
321+
|----------------------------------|:---------------:|------------------------------------------------------------------------------|:----------:|---------------|:-----:|
322+
| type = "vehicle-parking" | `enum` | The type of the updater. | *Required* | | 1.5 |
323+
| [feedId](#u__13__feedId) | `string` | The id of the data source, which will be the prefix of the parking lot's id. | *Required* | | 2.2 |
324+
| frequency | `duration` | How often to update the source. | *Optional* | `"PT1M"` | 2.6 |
325+
| [sourceType](#u__13__sourceType) | `enum` | The source of the vehicle updates. | *Required* | | 2.2 |
326+
| url | `uri` | URL of the locations endpoint. | *Required* | | 2.6 |
327+
| [headers](#u__13__headers) | `map of string` | HTTP headers to add to the request. Any header key, value can be inserted. | *Optional* | | 2.6 |
328328

329329

330330
#### Details
@@ -334,7 +334,7 @@ HTTP headers to add to the request. Any header key, value can be inserted.
334334
**Since version:** `2.2` ∙ **Type:** `string` ∙ **Cardinality:** `Required`
335335
**Path:** /updaters/[13]
336336

337-
The name of the data source.
337+
The id of the data source, which will be the prefix of the parking lot's id.
338338

339339
This will end up in the API responses as the feed id of of the parking lot.
340340

‎src/main/java/org/opentripplanner/standalone/config/routerconfig/updaters/VehicleParkingUpdaterConfig.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public static VehicleParkingUpdaterParameters create(String updaterRef, NodeAdap
2828
var feedId = c
2929
.of("feedId")
3030
.since(V2_2)
31-
.summary("The name of the data source.")
31+
.summary("The id of the data source, which will be the prefix of the parking lot's id.")
3232
.description("This will end up in the API responses as the feed id of of the parking lot.")
3333
.asString();
3434
return switch (sourceType) {

0 commit comments

Comments
 (0)