Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardehrenfried committed Apr 16, 2024
1 parent 60f46bd commit d654f73
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 2 deletions.
5 changes: 4 additions & 1 deletion doc-templates/VehicleParking.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Contact Info

- For HSL Park and Ride updater: Digitransit team, HSL, Helsinki, Finland
- For Bikely and NOI updater: Leonard Ehrenfried, [[email protected]](mailto:[email protected])
- For Bikely, NOI and Bikeep updater: Leonard Ehrenfried, [[email protected]](mailto:[email protected])


## Documentation
Expand Down Expand Up @@ -44,6 +44,9 @@ All updaters have the following parameters in common:

<!-- INSERT: noi-open-data-hub -->

## Bikeep

<!-- INSERT: bikeep -->

## Changelog

Expand Down
6 changes: 6 additions & 0 deletions docs/RouterConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -844,6 +844,12 @@ Used to group requests when monitoring OTP.
"fromDateTime" : "-P1D",
"timeout" : 300000
}
},
{
"type" : "vehicle-parking",
"feedId" : "bikeep",
"sourceType" : "bikeep",
"url" : "https://services.bikeep.com/location/v1/public-areas/no-baia-mobility/locations"
}
],
"rideHailingServices" : [
Expand Down
62 changes: 61 additions & 1 deletion docs/sandbox/VehicleParking.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Contact Info

- For HSL Park and Ride updater: Digitransit team, HSL, Helsinki, Finland
- For Bikely and NOI updater: Leonard Ehrenfried, [[email protected]](mailto:[email protected])
- For Bikely, NOI and Bikeep updater: Leonard Ehrenfried, [[email protected]](mailto:[email protected])


## Documentation
Expand Down Expand Up @@ -312,6 +312,66 @@ HTTP headers to add to the request. Any header key, value can be inserted.

<!-- noi-open-data-hub END -->

## Bikeep

<!-- bikeep BEGIN -->
<!-- NOTE! This section is auto-generated. Do not change, change doc in code instead. -->

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


#### Details

<h4 id="u__13__feedId">feedId</h4>

**Since version:** `2.2`**Type:** `string`**Cardinality:** `Required`
**Path:** /updaters/[13]

The name of the data source.

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

<h4 id="u__13__sourceType">sourceType</h4>

**Since version:** `2.2`**Type:** `enum`**Cardinality:** `Required`
**Path:** /updaters/[13]
**Enum values:** `park-api` | `bicycle-park-api` | `hsl-park` | `bikely` | `noi-open-data-hub` | `bikeep`

The source of the vehicle updates.

<h4 id="u__13__headers">headers</h4>

**Since version:** `2.6`**Type:** `map of string`**Cardinality:** `Optional`
**Path:** /updaters/[13]

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



##### Example configuration

```JSON
// router-config.json
{
"updaters" : [
{
"type" : "vehicle-parking",
"feedId" : "bikeep",
"sourceType" : "bikeep",
"url" : "https://services.bikeep.com/location/v1/public-areas/no-baia-mobility/locations"
}
]
}
```

<!-- bikeep END -->

## Changelog

Expand Down
6 changes: 6 additions & 0 deletions src/test/resources/standalone/config/router-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,12 @@
"fromDateTime": "-P1D",
"timeout": 300000
}
},
{
"type": "vehicle-parking",
"feedId": "bikeep",
"sourceType": "bikeep",
"url": "https://services.bikeep.com/location/v1/public-areas/no-baia-mobility/locations"
}
],
"rideHailingServices": [
Expand Down

0 comments on commit d654f73

Please sign in to comment.