Skip to content

Updated docs for new wheelchair features (#17137) #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 58 additions & 6 deletions docs/specs/tripgo.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5215,6 +5215,16 @@ components:
type: integer
description: Total travel distance that it's considered necessary to push
the bicycle (see description of 'dismount' in the 'streets' array)
metresUp:
type: integer
description: Total uphill distance (see description of 'slope' in the 'streets' array)
metresDown:
type: integer
description: Total downhill distance (see description of 'slope' in the 'streets' array)
metresFlat:
type: integer
description: Total flat distance. Corresponds to 'NEARLY-NONE' steepness
(see description of 'slope' in the 'streets' array)
streets:
type: array
items:
Expand All @@ -5229,9 +5239,9 @@ components:
Encoded using Google's Encoded Polyline Algorithm. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
safe:
type: boolean
description: "Indicator for cycle paths if they are cycling-friendly\
\ (e.g., there's a bike lane) or for walking paths if they are\
\ wheelchair-friendly. Missing if unknown."
description: Indicator for cycle paths if they are cycling-friendly
(e.g., there's a bike lane). Missing if unknown. **Deprecated** for
wheelchair paths (see 'effortRating' instead).
dismount:
type: boolean
description: "Indicator for dismount sections in cycle paths (e.g.,\
Expand All @@ -5247,9 +5257,9 @@ components:
\ segment."
roadTags:
type: array
description: "A list of tags describing the\
\ type and/or condition of the road (for micromobility)\
\ or road's safety features (for walking)."
description: A list of tags describing the
type and/or condition of the road (for micromobility and wheelchair)
or road's safety features (for walking and wheelchair).
items:
type: string
enum:
Expand All @@ -5260,6 +5270,7 @@ components:
- BICYCLE-BOULEVARD
- SURFACE:GOOD
- SURFACE:BAD
- SURFACE:VERY-BAD
- SURFACE:EXCELLENT
- INFORMAL
- SEGREGATED
Expand All @@ -5270,6 +5281,10 @@ components:
- SERVICE-ROAD
- STREET-LIGHT
- CCTV-CAMERA
- RAMP
- NARROW
- VERY-NARROW
- STEPS
metres:
type: integer
description: "Travel distance, for walking and cycling segments."
Expand All @@ -5286,6 +5301,43 @@ components:
- TURN_SLIGHTLY_RIGHT
- TURN_RIGHT
- TURN_SHARPLY_RIGHT
effortRating:
type: number
minimum: 0
maximum: 1
description: For wheelchair paths, an estimation of the required effort.
Values between 0 (no effort) and 1 (with assistance only).
Missing means unknown.
wheelchairAccess:
type: boolean
description: Whether the path is accessible or not for wheelchair users.
Missing means unknown (assumed accessible). Note that we'll only suggest
inaccessible sections (e.g. steps) as part of a wheelchair route if there's
no other possible path connecting origin with destination.
slope:
type: object
description: Incline information for micromobility, walking and rolling paths.
Missing means unknown.
properties:
steepness:
type: string
description: Slope steepness
enum:
- NEARLY-NONE
- VERY-GENTLE
- GENTLE
- MODERATE
- STRONG
- VERY-STRONG
- EXTREME
- STEEP
- VERY-STEEP
direction:
type: string
description: Direction of slope, if any. Missing for 'NEARLY-NONE'.
enum:
- up
- down
turn-by-turn:
type: string
description: Indicates what level of turn-by-turn directions makes sense
Expand Down