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.

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

Added PlacesStructure in contexts #150

Merged
merged 3 commits into from
Mar 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 9 additions & 6 deletions OJP/OJP_RequestSupport.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -153,20 +153,23 @@
<xs:annotation>
<xs:documentation>========================================== Collection contexts ==========================================</xs:documentation>
</xs:annotation>
<xs:complexType name="PlacesStructure">
<xs:annotation>
<xs:documentation>Structure providing a collection of places.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Place" type="PlaceStructure" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ResponseContextStructure">
<xs:annotation>
<xs:documentation>Structure providing response contexts related to journeys, containing collections of places and situations.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Places" minOccurs="0">
<xs:element name="Places" type="PlacesStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Container for place objects. Only place objects that are referenced in the response should be put into the container.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Place" type="PlaceStructure" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Situations" type="SituationsStructure" minOccurs="0">
<xs:annotation>
Expand Down
17 changes: 11 additions & 6 deletions docs/generated/OJP.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -349,18 +349,23 @@ The element contains only one element:



=== The complex type `ResponseContextStructure`
=== The complex type `PlacesStructure`

Structure providing response contexts related to journeys, containing collections of places and situations.
The element contains a _sequence_ of the following elements:

|===
| `Places` | 0:1 | Container for place objects. Only place objects that are referenced in the response should be put into the container.
Structure providing a collection of places.

The element contains only one element:

| `Place` | 1:* | _PlaceStructure_



=== The complex type `ResponseContextStructure`

Structure providing response contexts related to journeys, containing collections of places and situations.
The element contains a _sequence_ of the following elements:

|===
| `Places` | 0:1 | _PlacesStructure_ | Container for place objects. Only place objects that are referenced in the response should be put into the container.
| `Situations` | 0:1 | _SituationsStructure_ | Container for SIRI SX situation objects. Only situations that are referenced in the response should be put into the container.
|===

Expand Down
37 changes: 22 additions & 15 deletions docs/generated/OJP.html
Original file line number Diff line number Diff line change
Expand Up @@ -476,6 +476,7 @@ <h1>OJP - <strong>O</strong>pen API for distributed <strong>J</strong>ourney <st
<li><a href="#_the_code_deliveryrequestgroup_code_group">The <code>DeliveryRequestGroup</code> group</a></li>
<li><a href="#_the_code_statusrequestgroup_code_group">The <code>StatusRequestGroup</code> group</a></li>
<li><a href="#_the_toplevel_element_code_terminatesubscriptionrequest_code">The toplevel element <code>TerminateSubscriptionRequest</code></a></li>
<li><a href="#_the_complex_type_code_placesstructure_code">The complex type <code>PlacesStructure</code></a></li>
<li><a href="#_the_complex_type_code_responsecontextstructure_code">The complex type <code>ResponseContextStructure</code></a></li>
</ul>
</li>
Expand Down Expand Up @@ -1457,36 +1458,42 @@ <h3 id="_the_toplevel_element_code_terminatesubscriptionrequest_code">The toplev
</div>
</div>
<div class="sect2">
<h3 id="_the_complex_type_code_placesstructure_code">The complex type <code>PlacesStructure</code></h3>
<div class="paragraph">
<p>Structure providing a collection of places.</p>
</div>
<div class="paragraph">
<p>The element contains only one element:</p>
</div>
<div class="paragraph">
<p>| <code>Place</code> | 1:* | <em>PlaceStructure</em></p>
</div>
</div>
<div class="sect2">
<h3 id="_the_complex_type_code_responsecontextstructure_code">The complex type <code>ResponseContextStructure</code></h3>
<div class="paragraph">
<p>Structure providing response contexts related to journeys, containing collections of places and situations.
The element contains a <em>sequence</em> of the following elements:</p>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top"><code>Places</code></th>
<th class="tableblock halign-left valign-top">0:1</th>
<th class="tableblock halign-left valign-top">Container for place objects. Only place objects that are referenced in the response should be put into the container.

The element contains only one element:</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Place</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1:*</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>PlaceStructure</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Places</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0:1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>PlacesStructure</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Container for place objects. Only place objects that are referenced in the response should be put into the container.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Situations</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0:1</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>SituationsStructure</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Container for SIRI SX situation objects. Only situations that are referenced in the response should be put into the container.</p></td>
</tr>
</tbody>
</table>
Expand Down