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
github-actions[bot] committed Dec 28, 2022
1 parent 20381ba commit 8183f42
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion OJP/OJP_PlaceSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@
<xs:annotation>
<xs:documentation>The service does not support the sorting method. The details should provide a list of the allowed methods the service supports.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:enumeration>
<xs:enumeration value="LOCATION_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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ <h1>OJP - <strong>O</strong>pen API for distributed <strong>J</strong>ourney <st
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>ContinueAt</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><span title="optional, single">0:1</span></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>xs:nonNegativeInteger</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Place</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="#ExchangePointsResultStructure" title="ExchangePointsResultStructure">ExchangePointsResult</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr>
</tbody></table></div></div><!--======================================= chapter ExchangePointsResultStructure--><div id="ExchangePointsResultStructure" class="sect2"><h3>8.19. The complex type <code xmlns="">ExchangePointsResultStructure</code></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>ExchangePointsResultStructure</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"/></td></tr><!--======= line--><tr><td class="tableblock halign-left valign-top" colspan="6"><p class="tableblock">The element contains a <em xmlns="">sequence</em> of the following elements:</p></td></tr><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Problem</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="#ExchangePointProblemStructure" title="ExchangePointProblemStructure">ExchangePointProblem</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Problems related to this EXCHANGE POINTS result.</p></td></tr><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code><strong>Place</strong></code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><strong title="mandatory, single">1:1</strong></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#PlaceStructure" title="PlaceStructure">Place</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Place object that describes this exchange point.</p></td></tr><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>TravelDurationEstimate</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><span title="optional, single">0:1</span></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>xs:duration</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Rough estimate of the travel duration from the specified reference place to this exchange point.</p></td></tr><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>WaitDuration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><span title="optional, single">0:1</span></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>xs:duration</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it has to take care, that feeding arrival and fetching departure are at least this duration apart.</p></td></tr><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>BorderPoint</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><span title="optional, single">0:1</span></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>xs:boolean</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE.</p></td></tr><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Mode</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="#ModeStructure" title="ModeStructure">Mode</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested.</p></td></tr></tbody></table></div></div></div></div>
<!--============================================================= Schema file ===--><!--========================================================= schema schema_OJP_PlaceSupport--><div class="sect1" id="schema_OJP_PlaceSupport"><h2>9. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information</h2><div class="sectionbody"><div id="schema_OJP_PlaceSupport_std" class="simple-type-definitions"><h3>9.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="AddressCodeType"><code>AddressCodeType</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">xs:normalizedString</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Identifier of an Address</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="ExchangePointsProblemTypeEnumeration"><code>ExchangePointsProblemTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Types of problems that may be returned in responses to EXCHANGE POINTS requests</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="LocationProblemTypeEnumeration"><code>LocationProblemTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_OTHER</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Types of problems that may be returned in responses to LOCATION requests.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="PointOfInterestCodeType"><code>PointOfInterestCodeType</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">xs:normalizedString</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Identifier of a Point of Interest</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="StopPlaceCodeType"><code>StopPlaceCodeType</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">xs:normalizedString</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Identifier of a Stop Place</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TopographicPlaceCodeType"><code>TopographicPlaceCodeType</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">xs:normalizedString</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Identifier of a TopographicPlace</p></td></tr></tbody></table></div></div><!--======================================= chapter StopPointGroup--><div id="StopPointGroup" class="sect2"><h3>9.2. The <code xmlns="">StopPointGroup</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>StopPointGroup</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">A stop point with id and name</p></td></tr>
<!--============================================================= Schema file ===--><!--========================================================= schema schema_OJP_PlaceSupport--><div class="sect1" id="schema_OJP_PlaceSupport"><h2>9. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information</h2><div class="sectionbody"><div id="schema_OJP_PlaceSupport_std" class="simple-type-definitions"><h3>9.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="AddressCodeType"><code>AddressCodeType</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">xs:normalizedString</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Identifier of an Address</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="ExchangePointsProblemTypeEnumeration"><code>ExchangePointsProblemTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Types of problems that may be returned in responses to EXCHANGE POINTS requests</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="LocationProblemTypeEnumeration"><code>LocationProblemTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_UNSUPPORTEDSORTINGMETHOD | LOCATION_OTHER</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Types of problems that may be returned in responses to LOCATION requests.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="PointOfInterestCodeType"><code>PointOfInterestCodeType</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">xs:normalizedString</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Identifier of a Point of Interest</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="StopPlaceCodeType"><code>StopPlaceCodeType</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">xs:normalizedString</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Identifier of a Stop Place</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TopographicPlaceCodeType"><code>TopographicPlaceCodeType</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">xs:normalizedString</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Identifier of a TopographicPlace</p></td></tr></tbody></table></div></div><!--======================================= chapter StopPointGroup--><div id="StopPointGroup" class="sect2"><h3>9.2. The <code xmlns="">StopPointGroup</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>StopPointGroup</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">A stop point with id and name</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="5"><a href="#StopPointGroup" title="StopPointGroup">StopPoint</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code><strong>→‍siri:StopPointRef</strong></code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><strong title="mandatory, single">1:1</strong></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>→‍siri:StopPointRef</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code><strong>StopPointName</strong></code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><strong title="mandatory, single">1:1</strong></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#InternationalTextStructure" title="InternationalTextStructure">InternationalText</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Name or description of stop point for use in passenger information.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>NameSuffix</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><span title="optional, single">0:1</span></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#InternationalTextStructure" title="InternationalTextStructure">InternationalText</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance".</p></td></tr>
Expand Down

0 comments on commit 8183f42

Please sign in to comment.