From b621a6d56b0d356e7acbbd0cd7e08ca0d80d199f Mon Sep 17 00:00:00 2001 From: Leonard Ehrenfried Date: Thu, 2 Jan 2025 23:07:39 +0100 Subject: [PATCH] Update documentation --- .../opentripplanner/apis/gtfs/schema.graphqls | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/application/src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls b/application/src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls index 6ac56be3d1d..06af4055abf 100644 --- a/application/src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls +++ b/application/src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls @@ -3535,15 +3535,29 @@ enum RealtimeState { UPDATED } -"Actions to take relative to the current position when engaging a walking/driving step." +""" +A direction that is not absolute but rather fuzzy and context-dependent. +It provides the passenger with information what they should do in this step depending on where they +were in the previous one. +""" enum RelativeDirection { CIRCLE_CLOCKWISE CIRCLE_COUNTERCLOCKWISE + """ + Moving straight ahead in one of these cases + + - Passing through a crossing or intersection. + - Passing through a station entrance or exit when it is not know whether the passenger is + entering or exiting. If known then entrance information is in the `step.entity` field. + """ CONTINUE DEPART ELEVATOR + "Entering a public transport station. If known then entrance information is in the `step.entity` field." ENTER_STATION + "Exiting a public transport station. If known then entrance information is in the `step.entity` field." EXIT_STATION + """Follow the signs indicating a specific location like "platform 1" or "exit B".""" FOLLOW_SIGNS HARD_LEFT HARD_RIGHT