Replace coord with location in PlaceTypeEnumeration (#218)

Co-authored-by: Malte Herlitze <[email protected]>
Co-authored-by: Stefan de Konink <[email protected]>

OJP/OJP_Places.xsd

@@ -203,10 +203,23 @@
 	</xs:group>
 	<xs:simpleType name="PlaceTypeEnumeration">
 		<xs:restriction base="xs:string">
-			<xs:enumeration value="stop"/>
+			<xs:enumeration value="stop">
+				<xs:annotation>
+					<xs:documentation>stop covers StopPlace and StopPoint.</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
 			<xs:enumeration value="address"/>
 			<xs:enumeration value="poi"/>
-			<xs:enumeration value="coord"/>
+			<xs:enumeration value="coord">
+				<xs:annotation>
+					<xs:documentation>Deprecated. Use location instead.</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
+			<xs:enumeration value="location">
+				<xs:annotation>
+					<xs:documentation>Geographic position consisting of coordinates. Replaces the deprecated value coord.</xs:documentation>
+				</xs:annotation>
+			</xs:enumeration>
 			<xs:enumeration value="topographicPlace"/>
 		</xs:restriction>
 	</xs:simpleType>

docs/generated/OJP.html

@@ -377,7 +377,7 @@ <h1>OJP - <strong>O</strong>pen API for distributed <strong>J</strong>ourney <st
 			<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="1"><a href="#ModeGroup" title="ModeGroup">Mode</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code><strong>PtMode</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:VehicleModesOfTransportEnumeration</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Categorisation of mode </p></td></tr>
 			<!--Group could not be resolved: →siri:PtModeChoiceGroup--><!--======= 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:PtModeChoiceGroup</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr>
 		</tbody></table></div></div><!--======================================= chapter PtModeFilterStructure--><div id="PtModeFilterStructure" class="sect2"><h3>7.5. The complex type <code xmlns="">PtModeFilterStructure</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>PtModeFilterStructure</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">List of public transport modes ([from SIRI] mode of public transport service, corresponds to VEHICLE MODE) to include or exclude.</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>Exclude</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 modes in list are to include or exclude from search. Default is exclude.</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>PtMode</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>siri:VehicleModesOfTransportEnumeration</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">List of PT Transport modes to include/exclude.</p></td></tr><!--Group could not be resolved: →siri:PtModeChoiceGroup--><!--======= 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:PtModeChoiceGroup</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr></tbody></table></div></div><!--======================================= chapter PrivateModeFilterStructure--><div id="PrivateModeFilterStructure" class="sect2"><h3>7.6. The complex type <code xmlns="">PrivateModeFilterStructure</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>PrivateModeFilterStructure</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">List of private mobility offers to include or exclude.</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>Exclude</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 modes in list are to include or exclude from search. Default is exclude.</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>PrivateMode</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="#PrivateModesEnumeration" title="PrivateModesEnumeration">PrivateModes</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">List of private mobility offers to include/exclude.</p></td></tr></tbody></table></div></div></div></div>
-	<!--============================================================= Schema file  ===--><!--========================================================= schema schema_OJP_Places--><div class="sect1" id="schema_OJP_Places"><h2>8.  OJP/OJP_Places.xsd - Request and response definitions for place information</h2><div class="sectionbody"><div id="schema_OJP_Places_std" class="simple-type-definitions"><h3>8.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="PlaceTypeEnumeration"><code>PlaceTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">stop | address | poi | coord | topographicPlace</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="PlaceUsageEnumeration"><code>PlaceUsageEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">origin | via | destination</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr></tbody></table></div></div><!--======================================= chapter PlaceInformationRequestGroup--><div id="PlaceInformationRequestGroup" class="sect2"><h3>8.2. The <code xmlns="">PlaceInformationRequestGroup</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>PlaceInformationRequestGroup</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>
+	<!--============================================================= Schema file  ===--><!--========================================================= schema schema_OJP_Places--><div class="sect1" id="schema_OJP_Places"><h2>8.  OJP/OJP_Places.xsd - Request and response definitions for place information</h2><div class="sectionbody"><div id="schema_OJP_Places_std" class="simple-type-definitions"><h3>8.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="PlaceTypeEnumeration"><code>PlaceTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">stop | address | poi | coord | location | topographicPlace</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="PlaceUsageEnumeration"><code>PlaceUsageEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">origin | via | destination</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr></tbody></table></div></div><!--======================================= chapter PlaceInformationRequestGroup--><div id="PlaceInformationRequestGroup" class="sect2"><h3>8.2. The <code xmlns="">PlaceInformationRequestGroup</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>PlaceInformationRequestGroup</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 <em xmlns="">one of</em> the following elements:</p></td></tr><!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="3"><a href="#PlaceInformationRequestGroup" title="PlaceInformationRequestGroup">PlaceInformationRequest</a></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>a</em></p></td><td class="tableblock halign-left valign-top" colspan="1"><p class="tableblock"><code><strong>InitialInput</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="#InitialPlaceInputStructure" title="InitialPlaceInputStructure">InitialPlaceInput</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Initial input for the place information request. This input defines what is originally looked for.</p></td></tr><!--======= row--><tr><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>PlaceRef</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="#PlaceRefStructure" title="PlaceRefStructure">PlaceRef</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.</p></td></tr>
 			<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Restrictions</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="#PlaceParamStructure" title="PlaceParamStructure">PlaceParam</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">E.g. place types (stops, addresses, POIs) or specific place attributes</p></td></tr>
 		</tbody></table></div></div><!--======================================= chapter PlaceInformationResponseGroup--><div id="PlaceInformationResponseGroup" class="sect2"><h3>8.3. The <code xmlns="">PlaceInformationResponseGroup</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>PlaceInformationResponseGroup</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>