Skip to content

Commit

Permalink
Add documentation for footpath duration
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelKutzner committed Nov 19, 2024
1 parent a871801 commit 7018864
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1303,7 +1303,19 @@ components:
to:
$ref: '#/components/schemas/Place'
duration:
description: Leg duration in seconds
description: |
Leg duration in seconds
If leg is footpath:
The footpath duration is derived from the default footpath
duration using the query parameters `transferTimeFactor` and
`additionalTransferTime` as follows:
`leg.duration = defaultDuration * transferTimeFactor + additionalTransferTime.`
In case the defaultDuration is needed, it can be calculated by
`defaultDuration = (leg.duration - additionalTransferTime) / transferTimeFactor`.
Note that the default values are `transferTimeFactor = 1` and
`additionalTransferTime = 0` in case they are not explicitly
provided in the query.
type: integer
startTime:
type: string
Expand Down

0 comments on commit 7018864

Please sign in to comment.