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 Mar 22, 2023
1 parent 3fa5a3f commit 6a14a56
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/generated/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ <h1>OJP - <strong>O</strong>pen API for distributed <strong>J</strong>ourney <st
<!--Group ProblemDetailGroup ──────┘--></tbody></table></div></div></div></div>
<!--============================================================= Schema file OJP_siri_service ===--><!--========================================================= schema schema_OJP_Lines--><div class="sect1" id="schema_OJP_Lines"><h2>6. OJP/OJP_Lines.xsd - Request and response definitions for information on lines</h2><div class="sectionbody"><div id="schema_OJP_Lines_std" class="simple-type-definitions"><h3>6.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="LineInformationProblemTypeEnumeration"><code>LineInformationProblemTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">LINEINFORMATION_LINEUNKNOWN | LINEINFORMATION_OTHER</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Types of problems that may be returned in responses to LINE INFORMATION requests.</p></td></tr></tbody></table></div></div><!--======================================= chapter LineInformationResponseGroup--><div id="LineInformationResponseGroup" class="sect2"><h3>6.2. The <code xmlns="">LineInformationResponseGroup</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>LineInformationResponseGroup</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">Line Information response group.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="1"><a href="#LineInformationResponseGroup" title="LineInformationResponseGroup">LineInformationResponse</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>LineResult</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="#LineResultStructure" title="LineResultStructure">LineResult</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr>
</tbody></table></div></div><!--======================================= chapter LineResultStructure--><div id="LineResultStructure" class="sect2"><h3>6.3. The complex type <code xmlns="">LineResultStructure</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>LineResultStructure</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="#LineInformationProblemStructure" title="LineInformationProblemStructure">LineInformationProblem</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Problems related to this Line 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>LineRef</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:LineRefStructure</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Reference to the LINE.</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>→‍siri:PublishedLineName</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>→‍siri:PublishedLineName</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Name or Number by which the LINE is known to the public.</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>DirectionRef</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>siri:DirectionRefStructure</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">DIRECTION of LINE.</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>RouteGeometry</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="#LinearShapeStructure" title="LinearShapeStructure">LinearShape</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">The LINE's route geometry. A line can have multiple ROUTEs and each has its own geometry. The first should be the "main" geometry.</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>AreaGeometry</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="#AreaStructure" title="AreaStructure">Area</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">The LINE's main area. Used for MOBILITY SERVICES that cover one or more areas. The interconnection between the areas is not calculated (e.g. exclusion zones can't be modeler). Don't mix RouteGeometry and AreaGeometry in a response.</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 are supported by this line.</p></td></tr></tbody></table></div></div><!--======================================= chapter LineInformationProblemStructure--><div id="LineInformationProblemStructure" class="sect2"><h3>6.4. The complex type <code xmlns="">LineInformationProblemStructure</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>LineInformationProblemStructure</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">Problem that may be returned in responses to LINE information requests.</p></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><strong>Type</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="#LineInformationProblemTypeEnumeration" title="LineInformationProblemTypeEnumeration">LineInformationProblemType</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Type of the LINE information problem.</p></td></tr><!--Group ProblemDetailGroup ──────┐-->
</tbody></table></div></div><!--======================================= chapter LineResultStructure--><div id="LineResultStructure" class="sect2"><h3>6.3. The complex type <code xmlns="">LineResultStructure</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>LineResultStructure</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="#LineInformationProblemStructure" title="LineInformationProblemStructure">LineInformationProblem</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Problems related to this Line 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>LineRef</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:LineRefStructure</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Reference to the LINE.</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>→‍siri:PublishedLineName</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>→‍siri:PublishedLineName</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Name or Number by which the LINE is known to the public.</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>DirectionRef</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>siri:DirectionRefStructure</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">DIRECTION of LINE.</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>RouteGeometry</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="#LinearShapeStructure" title="LinearShapeStructure">LinearShape</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">The LINE's route geometry. A line can have multiple ROUTEs and each has its own geometry. The first should be the "main" geometry.</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>AreaGeometry</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="#AreaStructure" title="AreaStructure">Area</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">The LINE's main area. Used for MOBILITY SERVICES that cover one or more areas. The interconnection between the areas is not calculated (e.g. exclusion zones can't be modeled). Don't mix RouteGeometry and AreaGeometry in a response.</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 are supported by this line.</p></td></tr></tbody></table></div></div><!--======================================= chapter LineInformationProblemStructure--><div id="LineInformationProblemStructure" class="sect2"><h3>6.4. The complex type <code xmlns="">LineInformationProblemStructure</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>LineInformationProblemStructure</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">Problem that may be returned in responses to LINE information requests.</p></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><strong>Type</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="#LineInformationProblemTypeEnumeration" title="LineInformationProblemTypeEnumeration">LineInformationProblemType</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Type of the LINE information problem.</p></td></tr><!--Group ProblemDetailGroup ──────┐-->
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="3"><a href="#ProblemDetailGroup" title="ProblemDetailGroup">ProblemDetail</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Title</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">Title of the problem.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Details</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">Explanation of the problem.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>LogData</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:string</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Additional log data.</p></td></tr>
Expand Down

0 comments on commit 6a14a56

Please sign in to comment.