Skip to content

Commit

Permalink
Missing annotations (#332)
Browse files Browse the repository at this point in the history 
* several annotations added
* OJP_Trips.xsd - missing end tag
  • Loading branch information
@trurlurl
trurlurl authored Mar 9, 2023
1 parent dc93a5f commit e378001
Show file tree
Hide file tree
Showing 11 changed files with 256 additions and 96 deletions.
12 changes: 10 additions & 2 deletions OJP/OJP_Availability.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,16 @@
<xs:documentation>Earliest possible departure time from a start location and latest possible arrival at a different destination location.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="EarliestDepartureTime" type="xs:dateTime" minOccurs="0"/>
<xs:element name="LatestArrivalTime" type="xs:dateTime" minOccurs="0"/>
<xs:element name="EarliestDepartureTime" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Earliest possible departure time from start location.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LatestArrivalTime" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Latest possible arrival time at destination location.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:annotation>
Expand Down
6 changes: 5 additions & 1 deletion OJP/OJP_Common.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,11 @@
<xs:documentation>Reference to a vehicle for a specific point in time.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="siri:VehicleRef"/>
<xs:element ref="siri:VehicleRef">
<xs:annotation>
<xs:documentation>Reference to vehicle.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TimeOfOperation" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Time stamp when the vehicle is operating. In most use cases equal to "now".</xs:documentation>
Expand Down
6 changes: 5 additions & 1 deletion OJP/OJP_Fare.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@
<xs:documentation>Sub-request: stop-related fare information.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="siri:StopPointRef"/>
<xs:element ref="siri:StopPointRef">
<xs:annotation>
<xs:documentation>Reference to the stop point.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Date" type="xs:date" minOccurs="0">
<xs:annotation>
<xs:documentation>Date for which to retrieve Fare information.</xs:documentation>
Expand Down
32 changes: 26 additions & 6 deletions OJP/OJP_FareSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,11 @@
<xs:documentation>List of values for Flexible Booking values.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="BookingMethod" type="BookingMethodEnumeration" minOccurs="1" maxOccurs="unbounded"/>
<xs:element name="BookingMethod" type="BookingMethodEnumeration" minOccurs="1" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Flexible booking methods.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<!-- ======================================================================= -->
Expand Down Expand Up @@ -326,7 +330,11 @@
<xs:documentation>List of Purchase Moment values.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="PurchaseMoment" type="PurchaseMomentEnumeration" maxOccurs="unbounded"/>
<xs:element name="PurchaseMoment" type="PurchaseMomentEnumeration" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Possibilities when to pay.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<!-- =================================================== -->
Expand Down Expand Up @@ -372,7 +380,11 @@
<xs:documentation>List of Booking Process values.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="BookingProcess" type="BookingProcessEnumeration" minOccurs="1" maxOccurs="unbounded"/>
<xs:element name="BookingProcess" type="BookingProcessEnumeration" minOccurs="1" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Ways how to book (UIC 7037 codes).</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<!-- =================================================== -->
Expand All @@ -390,10 +402,14 @@
</xs:simpleType>
<xs:complexType name="GroupBookingListOfEnumerations">
<xs:annotation>
<xs:documentation>List of Group Booking values.</xs:documentation>
<xs:documentation>Possibilites and restrictions for group booking.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="GroupBooking" type="GroupBookingEnumeration" maxOccurs="unbounded"/>
<xs:element name="GroupBooking" type="GroupBookingEnumeration" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Group booking policies.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="BookingArrangementsStructure" abstract="false">
Expand Down Expand Up @@ -651,7 +667,11 @@
<xs:documentation>URL to buy the FareProduct online.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BookingArrangements" type="BookingArrangementsContainerStructure" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="BookingArrangements" type="BookingArrangementsContainerStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Multiple sets of multiple booking arrangements for different legs of a journey.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:annotation>
Expand Down
18 changes: 15 additions & 3 deletions OJP/OJP_JourneySupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,16 @@
<xs:documentation>Vehicle journey that runs at a specific date.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="OperatingDayRef"/>
<xs:element ref="siri:VehicleRef" minOccurs="0"/>
<xs:element ref="OperatingDayRef">
<xs:annotation>
<xs:documentation>Reference to an Operating Day.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="siri:VehicleRef" minOccurs="0">
<xs:annotation>
<xs:documentation>Contains the Vehicle reference of the vehicle. In Transmodel this may be the VEHICLE Id.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="ScheduledJourneyGroup"/>
</xs:sequence>
</xs:group>
Expand Down Expand Up @@ -436,7 +444,11 @@
</xs:choice>
<xs:choice>
<xs:group ref="DatedJourneyGroup" minOccurs="0"/>
<xs:element name="SharingService" type="SharingServiceStructure" minOccurs="0"/>
<xs:element name="SharingService" type="SharingServiceStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Shared mobility offer.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:group ref="ServiceOriginGroup" minOccurs="0"/>
<xs:group ref="ServiceDestinationGroup" minOccurs="0"/>
Expand Down
6 changes: 5 additions & 1 deletion OJP/OJP_Lines.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@
<xs:documentation>Reference to the LINE.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="siri:PublishedLineName" minOccurs="0"/>
<xs:element ref="siri:PublishedLineName" minOccurs="0">
<xs:annotation>
<xs:documentation>Name or Number by which the LINE is known to the public.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DirectionRef" type="siri:DirectionRefStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>DIRECTION of LINE.</xs:documentation>
Expand Down
62 changes: 51 additions & 11 deletions OJP/OJP_Locations.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@
<xs:documentation>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.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PlaceResult" type="PlaceResultStructure" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="PlaceResult" type="PlaceResultStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The place/location objects found by the service are ordered in descending order of how well they match the input data. The first result in the list matches best.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:annotation>
Expand Down Expand Up @@ -84,18 +88,30 @@
</xs:complexType>
<xs:complexType name="GeoRestrictionsStructure">
<xs:choice>
<xs:element name="Circle" type="GeoCircleStructure"/>
<xs:element name="Rectangle" type="GeoRectangleStructure"/>
<xs:element name="Circle" type="GeoCircleStructure">
<xs:annotation>
<xs:documentation>Area defined by a circle.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Rectangle" type="GeoRectangleStructure">
<xs:annotation>
<xs:documentation>Area defined by a rectangle.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Area" type="GeoAreaStructure">
<xs:annotation>
<xs:documentation>Area is defined by a polyline</xs:documentation>
<xs:documentation>Area defined by a polyline.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:complexType>
<xs:complexType name="GeoCircleStructure">
<xs:sequence>
<xs:element name="Center" type="siri:LocationStructure"/>
<xs:element name="Center" type="siri:LocationStructure">
<xs:annotation>
<xs:documentation>Centre position of the circle.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Radius" type="siri:DistanceType">
<xs:annotation>
<xs:documentation>Radius in metres.</xs:documentation>
Expand All @@ -105,8 +121,16 @@
</xs:complexType>
<xs:complexType name="GeoRectangleStructure">
<xs:sequence>
<xs:element name="UpperLeft" type="siri:LocationStructure"/>
<xs:element name="LowerRight" type="siri:LocationStructure"/>
<xs:element name="UpperLeft" type="siri:LocationStructure">
<xs:annotation>
<xs:documentation>Upper-left (north-west) corner of the rectangle.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LowerRight" type="siri:LocationStructure">
<xs:annotation>
<xs:documentation>Lower-right (south-east) corner of the rectangle.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="GeoAreaStructure">
Expand All @@ -115,7 +139,11 @@
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="PolylinePoint" type="siri:LocationStructure" minOccurs="3" maxOccurs="unbounded"/>
<xs:element name="PolylinePoint" type="siri:LocationStructure" minOccurs="3" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Vertices of a polyline defining an area.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PlaceResultStructure">
Expand All @@ -125,7 +153,11 @@
<xs:documentation>Problems related to this LOCATION result.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Place" type="PlaceStructure"/>
<xs:element name="Place" type="PlaceStructure">
<xs:annotation>
<xs:documentation>The Place / Location object.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Complete" type="xs:boolean">
<xs:annotation>
<xs:documentation>States whether the included location/place is complete or needs further refinement. Only complete locations/places are fully resolved and can be used in e.g. trip requests. Incomplete locations/places have to be refined entering them once again into a LocationInformationRequest.</xs:documentation>
Expand Down Expand Up @@ -340,7 +372,11 @@
<xs:documentation>Preferred language in which to return text values.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NumberOfResults" type="xs:positiveInteger" minOccurs="0"/>
<xs:element name="NumberOfResults" type="xs:positiveInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g. in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ContinueAt" type="xs:nonNegativeInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response.</xs:documentation>
Expand All @@ -360,7 +396,11 @@
<xs:documentation>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.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ExchangePointsResult" type="ExchangePointsResultStructure" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="ExchangePointsResult" type="ExchangePointsResultStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The exchange points found by the service.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:complexType name="ExchangePointsResultStructure">
Expand Down
14 changes: 11 additions & 3 deletions OJP/OJP_PlaceSupport.xsd
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns="http://www.vdv.de/ojp" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:siri="http://www.siri.org.uk/siri" targetNamespace="http://www.vdv.de/ojp" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation>OJP/OJP_LocationSupport.xsd - Supporting definitions for location information</xs:documentation>
<xs:documentation>OJP/OJP_PlaceSupport.xsd - Supporting definitions for location information</xs:documentation>
</xs:annotation>
<xs:import namespace="http://www.siri.org.uk/siri" schemaLocation="../siri/siri_model/siri_all-v2.0.xsd"/>
<xs:include schemaLocation="OJP_All.xsd"/>
Expand All @@ -13,7 +13,11 @@
<xs:documentation>A stop point with id and name</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="siri:StopPointRef"/>
<xs:element ref="siri:StopPointRef">
<xs:annotation>
<xs:documentation>Reference to a stop point.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="StopPointName" type="InternationalTextStructure">
<xs:annotation>
<xs:documentation>Name or description of stop point for use in passenger information.</xs:documentation>
Expand Down Expand Up @@ -476,7 +480,11 @@
</xs:annotation>
<xs:sequence>
<xs:choice>
<xs:element ref="siri:StopPointRef"/>
<xs:element ref="siri:StopPointRef">
<xs:annotation>
<xs:documentation>Reference to a stop point.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="StopPlaceRef"/>
<xs:element name="GeoPosition" type="siri:LocationStructure">
<xs:annotation>
Expand Down
8 changes: 6 additions & 2 deletions OJP/OJP_SituationSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,14 @@
<xs:sequence>
<xs:element name="PtSituation" type="siri:PtSituationElementStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>SIRI situation details.</xs:documentation>
<xs:documentation>SIRI situation details in public transport, see CEN/TS 15531-5.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RoadSituation" type="siri:RoadSituationElementStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>SIRI situation details in individual transport, see CEN/TS 15531-5.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RoadSituation" type="siri:RoadSituationElementStructure" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:element name="SituationFullRef" type="SituationFullRefStructure">
Expand Down
Loading

0 comments on commit e378001

Please sign in to comment.