Skip to content
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.

Sign up for GitHub

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

Add context to AvailabilityDelivery #322

Merged
merged 2 commits into from
Mar 9, 2023
Merged

Add context to AvailabilityDelivery #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07fb6a8
Update OJP_Availability.xsd
ue71603 Mar 2, 2023
62f88c6
Lint and update documentation tables
github-actions[bot] Mar 2, 2023
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
5 changes: 5 additions & 0 deletions OJP/OJP_Availability.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,11 @@
<xs:documentation>Availability response.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="AvailabilityResponseContext" type="ResponseContextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Context to hold availability response objects that occur frequently.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AvailabilityResult" type="AvailabilityResultStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Indication of the availability of the requested service.</xs:documentation>
Expand Down
6 changes: 4 additions & 2 deletions docs/generated/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,8 @@ <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>CalcTime</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="#CalcTimeType" title="CalcTimeType">Calc</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Calculation time.</p></td></tr>
<!--======= row--><tr><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="#OJPGenericProblemStructure" title="OJPGenericProblemStructure">OJPGenericProblem</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">OJP generic problem for the whole delivery.</p></td></tr>
<!--Group ServiceResponseContextGroup ──────┘--><!--Group AvailabilityResponseGroup ──────┐-->
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="2"><a href="#AvailabilityResponseGroup" title="AvailabilityResponseGroup">AvailabilityResponse</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>AvailabilityResult</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="#AvailabilityResultStructure" title="AvailabilityResultStructure">AvailabilityResult</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Indication of the availability of the requested service.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="3"><a href="#AvailabilityResponseGroup" title="AvailabilityResponseGroup">AvailabilityResponse</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>AvailabilityResponseContext</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="#ResponseContextStructure" title="ResponseContextStructure">ResponseContext</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Context to hold availability response objects that occur frequently.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>AvailabilityResult</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="#AvailabilityResultStructure" title="AvailabilityResultStructure">AvailabilityResult</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Indication of the availability of the requested service.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Extension</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:anyType</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr>
<!--Group AvailabilityResponseGroup ──────┘--><!--======= 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:Extensions</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:Extensions</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr>

Expand Down Expand Up @@ -1430,7 +1431,8 @@ <h1>OJP - <strong>O</strong>pen API for distributed <strong>J</strong>ourney <st
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="2"><a href="#DriverAssistanceGroup" title="DriverAssistanceGroup">DriverAssistance</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>BoardingAssistance</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">Whether assistance is required for boarding. Could be offered by the driver or station staff. Default is FALSE.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>AlightingAssistance</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">Whether assistance is required for alighting. Could be offered by the driver or station staff. Default is FALSE.</p></td></tr>
</tbody></table></div></div><!--======================================= chapter AvailabilityResponseGroup--><div id="AvailabilityResponseGroup" class="sect2"><h3>13.10. The <code xmlns="">AvailabilityResponseGroup</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>AvailabilityResponseGroup</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">Availability response.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="2"><a href="#AvailabilityResponseGroup" title="AvailabilityResponseGroup">AvailabilityResponse</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>AvailabilityResult</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="#AvailabilityResultStructure" title="AvailabilityResultStructure">AvailabilityResult</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Indication of the availability of the requested service.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="3"><a href="#AvailabilityResponseGroup" title="AvailabilityResponseGroup">AvailabilityResponse</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>AvailabilityResponseContext</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="#ResponseContextStructure" title="ResponseContextStructure">ResponseContext</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Context to hold availability response objects that occur frequently.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>AvailabilityResult</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="#AvailabilityResultStructure" title="AvailabilityResultStructure">AvailabilityResult</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Indication of the availability of the requested service.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Extension</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:anyType</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr>
</tbody></table></div></div><!--======================================= chapter AvailabilityResultStructure--><div id="AvailabilityResultStructure" class="sect2"><h3>13.11. The complex type <code xmlns="">AvailabilityResultStructure</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>AvailabilityResultStructure</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">Availability result structure.</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>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="#AvailabilityProblemStructure" title="AvailabilityProblemStructure">AvailabilityProblem</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Problems related to this AVAILABILITY result.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>b</em></p></td><td class="tableblock halign-left valign-top" colspan="1"><p class="tableblock"><code><strong>PublicTransport</strong></code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><strong title="mandatory, single, part of a choice">-1:1</strong></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#BookingPTLegStructure" title="BookingPTLegStructure">BookingPTLeg</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Definition of the journey leg that should be made by public transport. Other mobility services may be added later.</p></td></tr>
Expand Down