Skip to content

Commit 97b40be

Browse files
optionsomet2gran
andauthored
Apply suggestions from code review
Co-authored-by: Thomas Gran <t2gran@gmail.com>
1 parent 782b808 commit 97b40be

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

doc/dev/Dictionary.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Dictionary
1+
# Dictionary - OTP Internal Domain Language
2+
3+
The target audience for this document are developers and product owners working with OTP. API and data-feed specific terminology is excluded, unless it is relevant for understanding the internal model.
24

35
Usually, we use transit terms from
46
the [GTFS specification](https://gtfs.org/documentation/schedule/reference/#) when possible. Terms
@@ -15,13 +17,14 @@ this document will be updated over time, and it does not yet cover everything it
1517

1618
| Term | Description |
1719
|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
18-
| Running date | The actual calendar date. One departure can start and end on a different running date. |
20+
| Running date | The actual calendar date. One departure can start and end on a different running date. A trip or trip-pattern may have more than one running date. If the first departure is 2025-01-31 and the last arrival is on 2025-02-02, then 2025-01-31, 2025-02-01 and 2025-02-02 are all running dates for the given trip. |
1921
| Service date | Service dates are used in transit data and they are partly based on how the transit authorities operate. They typically in practice start and end later than a running date, but the starting point for the time of the service date is noon - 12 hours. For example, a trip starting at 1am is often still considered to be part of the previous "calendar date's" service date and in service date terminology, the starting time would be 25:00. There can be trips that last for 24+ hours, but each departure only has one service date and its chosen based on when the trip starts. |
2022

21-
## Stops in patterns
23+
## Stop references
2224

2325
| Term | Description |
2426
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
27+
| Stop id | A global unique id, frequently used by the APIs and data feeds to reference a stop |
2528
| Stop position | Zero-based index, incremented by 1 for each stop in the stop pattern. |
2629
| GTFS stop sequence | Comes from the GTFS data. Can be used for real-time data matching but also be fetched from the APIs. |
2730
| Stop index | The global integer index of stops used internally in OTP and in Raptor to reference stops by a single integer. There is a 1-to-1 mapping between stop index and Stop:id. |

0 commit comments

Comments
 (0)