replace wheelchair with pedestrianProfile and useRoutedTransfers para…

…meters
motis-project · Dec 10, 2024 · 41e0331 · 41e0331
1 parent 9505e01
commit 41e0331
Show file tree

Hide file tree

Showing 5 changed files with 127 additions and 33 deletions.
diff --git a/openapi.yaml b/openapi.yaml
@@ -410,7 +410,7 @@ paths:
 
         - name: maxMatchingDistance
           in: query
-          required: true
+          required: false
           description: |
             Optional. Default is 25 meters.
             
@@ -419,10 +419,25 @@ paths:
             type: number
             default: 25
 
-        - name: wheelchair
+        - name: pedestrianProfile
+          in: query
+          required: false
+          description: |
+            Optional. Default is `FOOT`.
+            
+            Accessibility profile to use for pedestrian routing in transfers
+            between transit connections, on the first mile, and last mile.
+          schema:
+            $ref: '#/components/schemas/PedestrianProfile'
+            default: FOOT
+
+        - name: useRoutedTransfers
           in: query
-          description: Whether the trip must be wheelchair accessible.
           required: false
+          description: |
+            Optional. Default is `false`.
+            
+            Whether to use transfers routed on OpenStreetMap data.
           schema:
             type: boolean
             default: false
@@ -500,6 +515,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies to direct connections.
             
             A list of vehicle type form factors that are allowed to be used for direct connections.
@@ -515,6 +532,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalFormFactors`).
             
             A list of vehicle type form factors that are allowed to be used from the `from` coordinate to the first transit stop.
@@ -530,6 +549,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalFormFactors`).
 
             A list of vehicle type form factors that are allowed to be used from the last transit stop to the `to` coordinate.
@@ -545,6 +566,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies to direct connections.
             
             A list of vehicle type form factors that are allowed to be used for direct connections.
@@ -560,6 +583,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalPropulsionTypes`).
             
             A list of vehicle propulsion types that are allowed to be used from the `from` coordinate to the first transit stop.
@@ -575,6 +600,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalPropulsionTypes`).
             
             A list of vehicle propulsion types that are allowed to be used from the last transit stop to the `to` coordinate.
@@ -590,6 +617,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies to direct connections.
             
             A list of rental providers that are allowed to be used for direct connections.
@@ -603,6 +632,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviders`).
             
             A list of rental providers that are allowed to be used from the `from` coordinate to the first transit stop.
@@ -616,6 +647,8 @@ paths:
           in: query
           required: false
           description: |
+            Experimental. Expect unannounced breaking changes (without version bumps).
+            
             Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviders`).
             
             A list of rental providers that are allowed to be used from the last transit stop to the `to` coordinate.
@@ -1070,13 +1103,20 @@ components:
           description: score according to the internal scoring system (the scoring algorithm might change in the future)
           type: number
 
+    PedestrianProfile:
+      description: Different accessibility profiles for pedestrians.
+      type: string
+      enum:
+        - FOOT
+        - WHEELCHAIR
+
     Mode:
       description: |
         # Street modes
         
           - `WALK`
           - `BIKE`
-          - `RENTAL`
+          - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps).
           - `CAR`
           - `CAR_PARKING`
 

diff --git a/src/endpoints/routing.cc b/src/endpoints/routing.cc
@@ -445,7 +445,9 @@ api::plan_response routing::operator()(boost::urls::url_view const& url) const {
           ? route_direct(e, gbfs_rd, from_p, to_p, direct_modes,
                          query.directRentalFormFactors_,
                          query.directRentalPropulsionTypes_,
-                         query.directRentalProviders_, *t, query.wheelchair_,
+                         query.directRentalProviders_, *t,
+                         query.pedestrianProfile_ ==
+                             api::PedestrianProfileEnum::WHEELCHAIR,
                          std::chrono::seconds{query.maxDirectTime_})
           : std::pair{std::vector<api::Itinerary>{}, kInfinityDuration};
   UTL_STOP_TIMING(direct);
@@ -469,7 +471,8 @@ api::plan_response routing::operator()(boost::urls::url_view const& url) const {
                   return get_offsets(
                       pos, dir, start_modes, start_form_factors,
                       start_propulsion_types, start_rental_providers,
-                      query.wheelchair_,
+                      query.pedestrianProfile_ ==
+                          api::PedestrianProfileEnum::WHEELCHAIR,
                       std::chrono::seconds{query.maxPreTransitTime_},
                       query.maxMatchingDistance_, gbfs_rd);
                 }},
@@ -483,7 +486,8 @@ api::plan_response routing::operator()(boost::urls::url_view const& url) const {
                   return get_offsets(
                       pos, dir, dest_modes, dest_form_factors,
                       dest_propulsion_types, dest_rental_providers,
-                      query.wheelchair_,
+                      query.pedestrianProfile_ ==
+                          api::PedestrianProfileEnum::WHEELCHAIR,
                       std::chrono::seconds{query.maxPostTransitTime_},
                       query.maxMatchingDistance_, gbfs_rd);
                 }},
@@ -498,7 +502,9 @@ api::plan_response routing::operator()(boost::urls::url_view const& url) const {
                                                  ? osr::direction::kBackward
                                                  : osr::direction::kForward;
                             return get_td_offsets(
-                                *e, pos, dir, start_modes, query.wheelchair_,
+                                *e, pos, dir, start_modes,
+                                query.pedestrianProfile_ ==
+                                    api::PedestrianProfileEnum::WHEELCHAIR,
                                 std::chrono::seconds{query.maxPreTransitTime_});
                           }},
                       start)
@@ -513,7 +519,9 @@ api::plan_response routing::operator()(boost::urls::url_view const& url) const {
                                                  ? osr::direction::kForward
                                                  : osr::direction::kBackward;
                             return get_td_offsets(
-                                *e, pos, dir, dest_modes, query.wheelchair_,
+                                *e, pos, dir, dest_modes,
+                                query.pedestrianProfile_ ==
+                                    api::PedestrianProfileEnum::WHEELCHAIR,
                                 std::chrono::seconds{
                                     query.maxPostTransitTime_});
                           }},
@@ -530,7 +538,13 @@ api::plan_response routing::operator()(boost::urls::url_view const& url) const {
         .min_connection_count_ = static_cast<unsigned>(query.numItineraries_),
         .extend_interval_earlier_ = start_time.extend_interval_earlier_,
         .extend_interval_later_ = start_time.extend_interval_later_,
-        .prf_idx_ = static_cast<n::profile_idx_t>(query.wheelchair_ ? 2U : 1U),
+        .prf_idx_ = static_cast<n::profile_idx_t>(
+            query.useRoutedTransfers_
+                ? (query.pedestrianProfile_ ==
+                           api::PedestrianProfileEnum::WHEELCHAIR
+                       ? 2U
+                       : 1U)
+                : 0U),
         .allowed_claszes_ = to_clasz_mask(query.transitModes_),
         .require_bike_transport_ = query.requireBikeTransport_,
         .transfer_time_settings_ =
@@ -585,7 +599,9 @@ api::plan_response routing::operator()(boost::urls::url_view const& url) const {
             [&, cache = street_routing_cache_t{}](auto&& j) mutable {
               return journey_to_response(
                   w_, l_, pl_, *tt_, *tags_, e, rtt, matches_, shapes_, gbfs_rd,
-                  query.wheelchair_, j, start, dest, cache, *blocked);
+                  query.pedestrianProfile_ ==
+                      api::PedestrianProfileEnum::WHEELCHAIR,
+                  j, start, dest, cache, *blocked);
             }),
         .previousPageCursor_ =
             fmt::format("EARLIER|{}", to_seconds(r.interval_.from_)),

diff --git a/ui/src/lib/openapi/schemas.gen.ts b/ui/src/lib/openapi/schemas.gen.ts
@@ -113,12 +113,18 @@ export const MatchSchema = {
     }
 } as const;
 
+export const PedestrianProfileSchema = {
+    description: 'Different accessibility profiles for pedestrians.',
+    type: 'string',
+    enum: ['FOOT', 'WHEELCHAIR']
+} as const;
+
 export const ModeSchema = {
     description: `# Street modes
 
   - \`WALK\`
   - \`BIKE\`
-  - \`RENTAL\`
+  - \`RENTAL\` Experimental. Expect unannounced breaking changes (without version bumps).
   - \`CAR\`
   - \`CAR_PARKING\`