Add documentation

entur · May 7, 2024 · 63bce5e · 63bce5e
1 parent dfe36ef
commit 63bce5e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/src/main/java/org/opentripplanner/apis/transmodel/model/stop/QuayType.java b/src/main/java/org/opentripplanner/apis/transmodel/model/stop/QuayType.java
@@ -216,6 +216,9 @@ public static GraphQLObjectType create(
             GraphQLArgument
               .newArgument()
               .name("timeRange")
+              .description(
+                "Duration in seconds from start time to search forward for estimated calls. Must be a positive value. Default value is 24 hours"
+              )
               .type(Scalars.GraphQLInt)
               .defaultValue(24 * 60 * 60)
               .build()

diff --git a/src/main/java/org/opentripplanner/apis/transmodel/model/stop/StopPlaceType.java b/src/main/java/org/opentripplanner/apis/transmodel/model/stop/StopPlaceType.java
@@ -290,6 +290,9 @@ public static GraphQLObjectType create(
             GraphQLArgument
               .newArgument()
               .name("timeRange")
+              .description(
+                "Duration in seconds from start time to search forward for estimated calls. Must be a positive value. Default value is 24 hours"
+              )
               .type(Scalars.GraphQLInt)
               .defaultValue(24 * 60 * 60)
               .build()

diff --git a/src/main/resources/org/opentripplanner/apis/transmodel/schema.graphql b/src/main/resources/org/opentripplanner/apis/transmodel/schema.graphql
@@ -571,6 +571,7 @@ type Quay implements PlaceInterface {
     omitNonBoarding: Boolean = false @deprecated(reason : "Non-functional. Use arrivalDeparture instead."),
     "DateTime for when to fetch estimated calls from. Default value is current time"
     startTime: DateTime,
+    "Duration in seconds from start time to search forward for estimated calls. Must be a positive value. Default value is 24 hours"
     timeRange: Int = 86400,
     "Parameters for indicating the only authorities and/or lines or quays to list estimatedCalls for"
     whiteListed: InputWhiteListed,
@@ -1132,6 +1133,7 @@ type StopPlace implements PlaceInterface {
     numberOfDeparturesPerLineAndDestinationDisplay: Int,
     "DateTime for when to fetch estimated calls from. Default value is current time"
     startTime: DateTime,
+    "Duration in seconds from start time to search forward for estimated calls. Must be a positive value. Default value is 24 hours"
     timeRange: Int = 86400,
     "Parameters for indicating the only authorities and/or lines or quays to list estimatedCalls for"
     whiteListed: InputWhiteListed,