Skip to content

Commit

Permalink
Lint and update documentation tables
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Apr 3, 2023
1 parent 78365e0 commit aa91e37
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion OJP/OJP_Trips.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -1656,7 +1656,7 @@
<xs:annotation>
<xs:documentation>Refinement does not support the hiking or cycling profile.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:enumeration>
<xs:enumeration value="TRIP_OTHER">
<xs:annotation>
<xs:documentation>A problem has occurred that does not have a specific problem type.</xs:documentation>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ <h1>OJP - <strong>O</strong>pen API for distributed <strong>J</strong>ourney <st
<!--============================================================= Schema file ===--><!--========================================================= schema schema_OJP_Trips--><div class="sect1" id="schema_OJP_Trips"><h2>11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning</h2><div class="sectionbody"><div id="schema_OJP_Trips_std" class="simple-type-definitions"><h3>11.1. Simple type definitions</h3><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><colgroup><col style="width:28%"/><col style="width:28%"/><col style="width:44%"/></colgroup><tbody><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="AccessFeatureStatusEnumeration"><code>AccessFeatureStatusEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">unknown | available | partiallyAvailable | notAvailable</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Allowed values for status of the access feature.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="AccessFeatureTypeEnumeration"><code>AccessFeatureTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Allowed values for a AccessFeature.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="AccessibilityFeatureTypesEnumeration"><code>AccessibilityFeatureTypesEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to).</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="FeasibilityEnumeration"><code>FeasibilityEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">allAccessFeaturesAvailable | accessFeatureNotAvailable | accessFeaturePartiallyAvailable | accessFeatureWithUnknownAvailability | seeSituations</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Allowed values for the feasibility of a TRIP or part of a TRIP.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="GuidanceAdviceEnumeration"><code>GuidanceAdviceEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="MultiPointTypeEnumeration"><code>MultiPointTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">anyPoint | eachOrigin | eachDestination | eachOriginDestination | somePoints</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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.
</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="OptimisationMethodEnumeration"><code>OptimisationMethodEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | environmentalSafety | extraSafe | extraReliable | scenic | quietTravel</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TransitionEnumeration"><code>TransitionEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">up | down | level | upAndDown | downAndUp</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Transition types for interchanges.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TripProblemTypeEnumeration"><code>TripProblemTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Types of problems that may be returned in responses to Trip requests.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TurnActionEnumeration"><code>TurnActionEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">The range of possible turns that can be described.</p></td></tr></tbody></table></div></div><!--======================================= chapter TripRequestGroup--><div id="TripRequestGroup" class="sect2"><h3>11.2. The <code xmlns="">TripRequestGroup</code> group</h3><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><colgroup><col style="width:11.9047619047619%"/><col style="width:1.19047619047619%"/><col style="width:11.9047619047619%"/><col style="width:1.19047619047619%"/><col style="width:23.8095238095238%"/><col style="width:35.7142857142857%"/></colgroup><tbody><!--======= type-description--><tr><td class="tableblock halign-left valign-top" colspan="4"><p class="tableblock"><code>TripRequestGroup</code></p></td><td class="tableblock halign-left valign-top" colspan="1"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock">Trip request structure.</p></td></tr>
</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="OptimisationMethodEnumeration"><code>OptimisationMethodEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | environmentalSafety | extraSafe | extraReliable | scenic | quietTravel</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TransitionEnumeration"><code>TransitionEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">up | down | level | upAndDown | downAndUp</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Transition types for interchanges.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TripProblemTypeEnumeration"><code>TripProblemTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Types of problems that may be returned in responses to Trip requests.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TurnActionEnumeration"><code>TurnActionEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">The range of possible turns that can be described.</p></td></tr></tbody></table></div></div><!--======================================= chapter TripRequestGroup--><div id="TripRequestGroup" class="sect2"><h3>11.2. The <code xmlns="">TripRequestGroup</code> group</h3><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><colgroup><col style="width:11.9047619047619%"/><col style="width:1.19047619047619%"/><col style="width:11.9047619047619%"/><col style="width:1.19047619047619%"/><col style="width:23.8095238095238%"/><col style="width:35.7142857142857%"/></colgroup><tbody><!--======= type-description--><tr><td class="tableblock halign-left valign-top" colspan="4"><p class="tableblock"><code>TripRequestGroup</code></p></td><td class="tableblock halign-left valign-top" colspan="1"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock">Trip request structure.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="7"><a href="#TripRequestGroup" title="TripRequestGroup">TripRequest</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code><strong>Origin</strong></code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><strong title="mandatory, at least one">1:*</strong></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#PlaceContextStructure" title="PlaceContextStructure">PlaceContext</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the origin situation from where the user wants to start.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code><strong>Destination</strong></code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><strong title="mandatory, at least one">1:*</strong></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#PlaceContextStructure" title="PlaceContextStructure">PlaceContext</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the destination situation where the user is heading to.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Via</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><span title="optional, multiple">0:*</span></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#TripViaStructure" title="TripViaStructure">TripVia</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">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.
Expand Down

0 comments on commit aa91e37

Please sign in to comment.