From aa91e3798d9ffd2f7b15a6e0aa079dfb9e206163 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 3 Apr 2023 13:56:50 +0000 Subject: [PATCH] Lint and update documentation tables --- OJP/OJP_Trips.xsd | 2 +- docs/generated/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index d5e443d46..5bdf2152c 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -1656,7 +1656,7 @@ Refinement does not support the hiking or cycling profile. - + A problem has occurred that does not have a specific problem type. diff --git a/docs/generated/index.html b/docs/generated/index.html index 0bedaf8ad..efa2b1490 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -642,7 +642,7 @@

OJP - Open API for distributed Journey

11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning

11.1. Simple type definitions

AccessFeatureStatusEnumeration

unknown | available | partiallyAvailable | notAvailable

Allowed values for status of the access feature.

AccessFeatureTypeEnumeration

elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown

Allowed values for a AccessFeature.

AccessibilityFeatureTypesEnumeration

lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator

Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to).

FeasibilityEnumeration

allAccessFeaturesAvailable | accessFeatureNotAvailable | accessFeaturePartiallyAvailable | accessFeatureWithUnknownAvailability | seeSituations

Allowed values for the feasibility of a TRIP or part of a TRIP.

GuidanceAdviceEnumeration

origin | destination | continue | keep | turn | leave | enter | enter_roundabout | stay_in_roundabout | leave_roundabout | enter_builtup_area | leave_builtup_area | freewayAccessRamp | unknown_lane_choice | left_lane | middle_lane | right_lane | unknown_turning_kind

Various types of guidance advice given to traveller. Suitable values may differ by MODE (e.g. a car driver needs different advice than a person walking for a transfer.

MultiPointTypeEnumeration

anyPoint | eachOrigin | eachDestination | eachOriginDestination | somePoints

How the multiple origin/destination points should be considered. Note: Unfortunately this element was underdefined before and this resulted in different implementations. Note: MultiPointType trumps the number of results. If the algorithm thinks it necessary to provide more results, it should. -

OptimisationMethodEnumeration

fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | environmentalSafety | extraSafe | extraReliable | scenic | quietTravel

The types of algorithm that can be used for planning a journey (fastest, least walking, etc.). If multiple optimisation methods are needed, then several requests should be performed in parallel.

TransitionEnumeration

up | down | level | upAndDown | downAndUp

Transition types for interchanges.

TripProblemTypeEnumeration

TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_OTHER

Types of problems that may be returned in responses to Trip requests.

TurnActionEnumeration

straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action

The range of possible turns that can be described.

11.2. The TripRequestGroup group

+

TripRequestGroup

Trip request structure.

OptimisationMethodEnumeration

fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | environmentalSafety | extraSafe | extraReliable | scenic | quietTravel

The types of algorithm that can be used for planning a journey (fastest, least walking, etc.). If multiple optimisation methods are needed, then several requests should be performed in parallel.

TransitionEnumeration

up | down | level | upAndDown | downAndUp

Transition types for interchanges.

TripProblemTypeEnumeration

TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | REFINE_OBJECTNOTFOUND | REFINE_PROFILENOTSUPPORTED | TRIP_OTHER

Types of problems that may be returned in responses to Trip requests.

TurnActionEnumeration

straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action

The range of possible turns that can be described.

11.2. The TripRequestGroup group

TripRequestGroup

Trip request structure.

TripRequest

Origin

1:*

+PlaceContext

Specifies the origin situation from where the user wants to start.

Destination

1:*

+PlaceContext

Specifies the destination situation where the user is heading to.

Via

0:*

+TripVia

Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops.