doc: Update bookingTime doc.

entur · May 29, 2024 · cd53540 · cd53540
1 parent ae7a20e
commit cd53540
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 10 deletions.
diff --git a/src/main/java/org/opentripplanner/apis/transmodel/model/plan/TripQuery.java b/src/main/java/org/opentripplanner/apis/transmodel/model/plan/TripQuery.java
@@ -51,9 +51,9 @@ public static GraphQLFieldDefinition create(
           .newArgument()
           .name("dateTime")
           .description(
-            "Date and time for the earliest time the user is willing to start the journey " +
-            "(if arriveBy=false/not set) or the latest acceptable time of arriving " +
-            "(arriveBy=true). Defaults to now"
+            "The date and time for the earliest time the user is willing to start the journey " +
+            "(if `false`or not set) or the latest acceptable time of arriving " +
+            "(`true`). Defaults to now"
           )
           .type(gqlUtil.dateTimeScalar)
           .build()
@@ -63,10 +63,14 @@ public static GraphQLFieldDefinition create(
           .newArgument()
           .name("bookingTime")
           .description(
-            "Date and time for the time the user can book the journey. Normally this is when the " +
-            "search is performed, plus a small grace period to complete the booking. Services witch " +
-            "must be booked before this time is excluded. Currently only flex services used as " +
-            "access and egress is supported, not direct flex or other services."
+            """
+            The date and time for the latest time the user is expected to book the journey.
+            Normally this is when the search is performed(now), plus a small grace period to
+            complete the booking. Services witch must be booked before this time is excluded. The
+            `latestBookingTime` and `minimumBookingPeriod` in `BookingArrangement` (flexible
+            services only) is used to enforce this. If this parameter is _not set_, no booking-time
+            restrictions are applied - all journeys are listed.
+            """
           )
           .type(gqlUtil.dateTimeScalar)
           .build()

diff --git a/...org/opentripplanner/routing/algorithm/filterchain/framework/groupids/GroupByDistance.java b/...org/opentripplanner/routing/algorithm/filterchain/framework/groupids/GroupByDistance.java
@@ -10,7 +10,7 @@
 import org.opentripplanner.routing.algorithm.filterchain.framework.spi.GroupId;
 
 /**
- * This class create a group identifier for an itinerary based on the longest legs which together
+ * This class creates a group identifier for an itinerary based on the longest legs which together
  * account for more than 'p' part of the total distance. Transit legs must overlap and ride the
  * same trip, while street-legs only need to have the same mode. We call the set of legs the
  * 'key-set-of-legs' or just 'key-set'.

diff --git a/src/main/resources/org/opentripplanner/apis/transmodel/schema.graphql b/src/main/resources/org/opentripplanner/apis/transmodel/schema.graphql
@@ -792,9 +792,16 @@ type QueryType {
     boardSlackDefault: Int = 0,
     "List of boardSlack for a given set of modes. Defaults: []"
     boardSlackList: [TransportModeSlack],
-    "Date and time for the time the user can book the journey. Normally this is when the search is performed, plus a small grace period to complete the booking. Services witch must be booked before this time is excluded. Currently only flex services used as access and egress is supported, not direct flex or other services."
+    """
+    The date and time for the latest time the user is expected to book the journey.
+    Normally this is when the search is performed(now), plus a small grace period to
+    complete the booking. Services witch must be booked before this time is excluded. The
+    `latestBookingTime` and `minimumBookingPeriod` in `BookingArrangement` (flexible
+    services only) is used to enforce this. If this parameter is _not set_, no booking-time
+    restrictions are applied - all journeys are listed.
+    """
     bookingTime: DateTime,
-    "Date and time for the earliest time the user is willing to start the journey (if arriveBy=false/not set) or the latest acceptable time of arriving (arriveBy=true). Defaults to now"
+    "The date and time for the earliest time the user is willing to start the journey (if `false`or not set) or the latest acceptable time of arriving (`true`). Defaults to now"
     dateTime: DateTime,
     "Debug the itinerary-filter-chain. OTP will attach a system notice to itineraries instead of removing them. This is very convenient when tuning the filters."
     debugItineraryFilter: Boolean = false @deprecated(reason : "Use `itineraryFilter.debug` instead."),