Merge pull request #223 from OneBusAway/release-please--branches--mai…

…n--changes--next

release: 0.1.0-alpha.56

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.55"
+  ".": "0.1.0-alpha.56"
 }

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.1.0-alpha.56 (2025-01-03)
+
+Full Changelog: [v0.1.0-alpha.55...v0.1.0-alpha.56](https://github.com/OneBusAway/kotlin-sdk/compare/v0.1.0-alpha.55...v0.1.0-alpha.56)
+
+### Features
+
+* updates ([34909c3](https://github.com/OneBusAway/kotlin-sdk/commit/34909c394eb58bb7fed3a870b73a75f6432588cf))
+
+
+### Chores
+
+* fix formatting ([6f7d23b](https://github.com/OneBusAway/kotlin-sdk/commit/6f7d23bd2da0ac7607c790fbdb36c5e1a34bed8b))
+
 ## 0.1.0-alpha.55 (2025-01-02)
 
 Full Changelog: [v0.1.0-alpha.54...v0.1.0-alpha.55](https://github.com/OneBusAway/kotlin-sdk/compare/v0.1.0-alpha.54...v0.1.0-alpha.55)

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Onebusaway SDK
+   Copyright 2025 Onebusaway SDK
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -21,7 +21,7 @@ The REST API documentation can be found on [developer.onebusaway.org](https://d
 <!-- x-release-please-start-version -->
 
 ```kotlin
-implementation("org.onebusaway:onebusaway-sdk-kotlin:0.1.0-alpha.55")
+implementation("org.onebusaway:onebusaway-sdk-kotlin:0.1.0-alpha.56")
 ```
 
 #### Maven
@@ -30,7 +30,7 @@ implementation("org.onebusaway:onebusaway-sdk-kotlin:0.1.0-alpha.55")
 <dependency>
     <groupId>org.onebusaway</groupId>
     <artifactId>onebusaway-sdk-kotlin</artifactId>
-    <version>0.1.0-alpha.55</version>
+    <version>0.1.0-alpha.56</version>
 </dependency>
 ```
 

build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 
 allprojects {
     group = "org.onebusaway"
-    version = "0.1.0-alpha.55" // x-release-please-version
+    version = "0.1.0-alpha.56" // x-release-please-version
 }
 
 nexusPublishing {

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/ArrivalAndDepartureListParams.kt

@@ -21,10 +21,13 @@ constructor(
 
     fun stopId(): String = stopId
 
+    /** Include vehicles arriving or departing in the next n minutes. */
     fun minutesAfter(): Long? = minutesAfter
 
+    /** Include vehicles having arrived or departed in the previous n minutes. */
     fun minutesBefore(): Long? = minutesBefore
 
+    /** The specific time for querying the system status. */
     fun time(): OffsetDateTime? = time
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithStopRetrieveParams.kt

@@ -25,14 +25,19 @@ constructor(
 
     fun stopId(): String = stopId
 
+    /** A string code identifying the nature of the problem */
     fun code(): Code? = code
 
+    /** Additional comment text supplied by the user describing the problem */
     fun userComment(): String? = userComment
 
+    /** The reporting user’s current latitude */
     fun userLat(): Double? = userLat
 
+    /** The reporting user’s location accuracy, in meters */
     fun userLocationAccuracy(): Double? = userLocationAccuracy
 
+    /** The reporting user’s current longitude */
     fun userLon(): Double? = userLon
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithTripRetrieveParams.kt

@@ -30,24 +30,34 @@ constructor(
 
     fun tripId(): String = tripId
 
+    /** A string code identifying the nature of the problem */
     fun code(): Code? = code
 
+    /** The service date of the trip */
     fun serviceDate(): Long? = serviceDate
 
+    /** A stop ID indicating where the user is experiencing the problem */
     fun stopId(): String? = stopId
 
+    /** Additional comment text supplied by the user describing the problem */
     fun userComment(): String? = userComment
 
+    /** The reporting user’s current latitude */
     fun userLat(): Double? = userLat
 
+    /** The reporting user’s location accuracy, in meters */
     fun userLocationAccuracy(): Double? = userLocationAccuracy
 
+    /** The reporting user’s current longitude */
     fun userLon(): Double? = userLon
 
+    /** Indicator if the user is on the transit vehicle experiencing the problem */
     fun userOnVehicle(): Boolean? = userOnVehicle
 
+    /** The vehicle number, as reported by the user */
     fun userVehicleNumber(): String? = userVehicleNumber
 
+    /** The vehicle actively serving the trip */
     fun vehicleId(): String? = vehicleId
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/ScheduleForRouteRetrieveParams.kt

@@ -18,6 +18,10 @@ constructor(
 
     fun routeId(): String = routeId
 
+    /**
+     * The date for which you want to request a schedule in the format YYYY-MM-DD (optional,
+     * defaults to current date)
+     */
     fun date(): LocalDate? = date
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/ScheduleForStopRetrieveParams.kt

@@ -18,6 +18,10 @@ constructor(
 
     fun stopId(): String = stopId
 
+    /**
+     * The date for which you want to request a schedule in the format YYYY-MM-DD (optional,
+     * defaults to the current date)
+     */
     fun date(): LocalDate? = date
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/SearchForRouteListParams.kt

@@ -15,8 +15,10 @@ constructor(
     private val additionalQueryParams: QueryParams,
 ) {
 
+    /** The string to search for. */
     fun input(): String = input
 
+    /** The max number of results to return. Defaults to 20. */
     fun maxCount(): Long? = maxCount
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/SearchForStopListParams.kt

@@ -15,8 +15,10 @@ constructor(
     private val additionalQueryParams: QueryParams,
 ) {
 
+    /** The string to search for. */
     fun input(): String = input
 
+    /** The max number of results to return. Defaults to 20. */
     fun maxCount(): Long? = maxCount
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/SearchForStopListResponse.kt

@@ -308,7 +308,8 @@ private constructor(
             private val routeIds: JsonField<kotlin.collections.List<String>> = JsonMissing.of(),
             @JsonProperty("staticRouteIds")
             @ExcludeMissing
-            private val staticRouteIds: JsonField<kotlin.collections.List<String>> = JsonMissing.of(),
+            private val staticRouteIds: JsonField<kotlin.collections.List<String>> =
+                JsonMissing.of(),
             @JsonProperty("wheelchairBoarding")
             @ExcludeMissing
             private val wheelchairBoarding: JsonField<String> = JsonMissing.of(),

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/StopsForLocationListParams.kt

@@ -23,12 +23,16 @@ constructor(
 
     fun lon(): Double = lon
 
+    /** An alternative to radius to set the search bounding box (optional) */
     fun latSpan(): Double? = latSpan
 
+    /** An alternative to radius to set the search bounding box (optional) */
     fun lonSpan(): Double? = lonSpan
 
+    /** A search query string to filter the results */
     fun query(): String? = query
 
+    /** The radius in meters to search within */
     fun radius(): Double? = radius
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/StopsForLocationListResponse.kt

@@ -308,7 +308,8 @@ private constructor(
             private val routeIds: JsonField<kotlin.collections.List<String>> = JsonMissing.of(),
             @JsonProperty("staticRouteIds")
             @ExcludeMissing
-            private val staticRouteIds: JsonField<kotlin.collections.List<String>> = JsonMissing.of(),
+            private val staticRouteIds: JsonField<kotlin.collections.List<String>> =
+                JsonMissing.of(),
             @JsonProperty("wheelchairBoarding")
             @ExcludeMissing
             private val wheelchairBoarding: JsonField<String> = JsonMissing.of(),

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/StopsForRouteListParams.kt

@@ -18,8 +18,10 @@ constructor(
 
     fun routeId(): String = routeId
 
+    /** Include polyline elements in the response (default true) */
     fun includePolylines(): Boolean? = includePolylines
 
+    /** Specify service date (YYYY-MM-DD or epoch) (default today) */
     fun time(): String? = time
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/TripDetailRetrieveParams.kt

@@ -21,14 +21,21 @@ constructor(
 
     fun tripId(): String = tripId
 
+    /**
+     * Whether to include the full schedule element in the tripDetails section (defaults to true).
+     */
     fun includeSchedule(): Boolean? = includeSchedule
 
+    /** Whether to include the full status element in the tripDetails section (defaults to true). */
     fun includeStatus(): Boolean? = includeStatus
 
+    /** Whether to include the full trip element in the references section (defaults to true). */
     fun includeTrip(): Boolean? = includeTrip
 
+    /** Service date for the trip as Unix time in milliseconds (optional). */
     fun serviceDate(): Long? = serviceDate
 
+    /** Time parameter to query the system at a specific time (optional). */
     fun time(): Long? = time
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/TripForVehicleRetrieveParams.kt

@@ -20,12 +20,25 @@ constructor(
 
     fun vehicleId(): String = vehicleId
 
+    /**
+     * Determines whether full <schedule/> element is included in the <tripDetails/> section.
+     * Defaults to false.
+     */
     fun includeSchedule(): Boolean? = includeSchedule
 
+    /**
+     * Determines whether the full <status/> element is included in the <tripDetails/> section.
+     * Defaults to true.
+     */
     fun includeStatus(): Boolean? = includeStatus
 
+    /**
+     * Determines whether full <trip/> element is included in the <references/> section. Defaults to
+     * false.
+     */
     fun includeTrip(): Boolean? = includeTrip
 
+    /** Time parameter to query the system at a specific time (optional). */
     fun time(): Long? = time
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/TripsForLocationListParams.kt

@@ -20,18 +20,25 @@ constructor(
     private val additionalQueryParams: QueryParams,
 ) {
 
+    /** The latitude coordinate of the search center */
     fun lat(): Double = lat
 
+    /** Latitude span of the search bounding box */
     fun latSpan(): Double = latSpan
 
+    /** The longitude coordinate of the search center */
     fun lon(): Double = lon
 
+    /** Longitude span of the search bounding box */
     fun lonSpan(): Double = lonSpan
 
+    /** Whether to include full schedule elements in the tripDetails section. Defaults to false. */
     fun includeSchedule(): Boolean? = includeSchedule
 
+    /** Whether to include full trip elements in the references section. Defaults to false. */
     fun includeTrip(): Boolean? = includeTrip
 
+    /** Specific time for the query. Defaults to the current time. */
     fun time(): Long? = time
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/TripsForLocationListResponse.kt

@@ -458,7 +458,8 @@ private constructor(
                 private val previousTripId: JsonField<String> = JsonMissing.of(),
                 @JsonProperty("stopTimes")
                 @ExcludeMissing
-                private val stopTimes: JsonField<kotlin.collections.List<StopTime>> = JsonMissing.of(),
+                private val stopTimes: JsonField<kotlin.collections.List<StopTime>> =
+                    JsonMissing.of(),
                 @JsonProperty("timeZone")
                 @ExcludeMissing
                 private val timeZone: JsonField<String> = JsonMissing.of(),
@@ -882,7 +883,8 @@ private constructor(
                 private val serviceDate: JsonField<Long> = JsonMissing.of(),
                 @JsonProperty("situationIds")
                 @ExcludeMissing
-                private val situationIds: JsonField<kotlin.collections.List<String>> = JsonMissing.of(),
+                private val situationIds: JsonField<kotlin.collections.List<String>> =
+                    JsonMissing.of(),
                 @JsonProperty("status")
                 @ExcludeMissing
                 private val status: JsonField<String> = JsonMissing.of(),

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/TripsForRouteListParams.kt

@@ -19,10 +19,16 @@ constructor(
 
     fun routeId(): String = routeId
 
+    /** Determine whether full schedule elements are included. Defaults to false. */
     fun includeSchedule(): Boolean? = includeSchedule
 
+    /**
+     * Determine whether full tripStatus elements with real-time information are included. Defaults
+     * to false.
+     */
     fun includeStatus(): Boolean? = includeStatus
 
+    /** Query the system at a specific time. Useful for testing. */
     fun time(): Long? = time
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/TripsForRouteListResponse.kt

@@ -435,7 +435,8 @@ private constructor(
                 private val previousTripId: JsonField<String> = JsonMissing.of(),
                 @JsonProperty("stopTimes")
                 @ExcludeMissing
-                private val stopTimes: JsonField<kotlin.collections.List<StopTime>> = JsonMissing.of(),
+                private val stopTimes: JsonField<kotlin.collections.List<StopTime>> =
+                    JsonMissing.of(),
                 @JsonProperty("timeZone")
                 @ExcludeMissing
                 private val timeZone: JsonField<String> = JsonMissing.of(),
@@ -859,7 +860,8 @@ private constructor(
                 private val serviceDate: JsonField<Long> = JsonMissing.of(),
                 @JsonProperty("situationIds")
                 @ExcludeMissing
-                private val situationIds: JsonField<kotlin.collections.List<String>> = JsonMissing.of(),
+                private val situationIds: JsonField<kotlin.collections.List<String>> =
+                    JsonMissing.of(),
                 @JsonProperty("status")
                 @ExcludeMissing
                 private val status: JsonField<String> = JsonMissing.of(),

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/VehiclesForAgencyListParams.kt

@@ -17,6 +17,7 @@ constructor(
 
     fun agencyId(): String = agencyId
 
+    /** Specific time for querying the status (timestamp format) */
     fun time(): String? = time
 
     fun _additionalHeaders(): Headers = additionalHeaders

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/models/VehiclesForAgencyListResponse.kt

@@ -698,7 +698,8 @@ private constructor(
                 private val serviceDate: JsonField<Long> = JsonMissing.of(),
                 @JsonProperty("situationIds")
                 @ExcludeMissing
-                private val situationIds: JsonField<kotlin.collections.List<String>> = JsonMissing.of(),
+                private val situationIds: JsonField<kotlin.collections.List<String>> =
+                    JsonMissing.of(),
                 @JsonProperty("status")
                 @ExcludeMissing
                 private val status: JsonField<String> = JsonMissing.of(),