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

Switching back Place to Location #231

Merged
merged 26 commits into from
Jan 31, 2023
Merged

Switching back Place to Location #231

Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
9599501
Switching back Place to Location
ue71603 Aug 11, 2022
5696347
Rest of Place -> Location
ue71603 Aug 27, 2022
506d3f5
updated the examples
ue71603 Aug 27, 2022
7463341
updated annotation
ue71603 Sep 12, 2022
d3b166e
changed documentation after -> for
ue71603 Oct 1, 2022
f79225b
Update OJP/OJP_JourneySupport.xsd
ue71603 Oct 18, 2022
3d87923
Update OJP/OJP_JourneySupport.xsd
ue71603 Oct 18, 2022
8804818
Update OJP/OJP_Locations.xsd
ue71603 Oct 18, 2022
6277543
Update OJP/OJP_Locations.xsd
ue71603 Oct 18, 2022
9c7e1b5
Lint and update documentation tables
github-actions[bot] Jan 20, 2023
d780e88
Update OJP/OJP_Locations.xsd
ue71603 Jan 20, 2023
fb8d7d7
Update OJP/OJP_Locations.xsd
ue71603 Jan 20, 2023
26048c6
Update OJP/OJP_Locations.xsd
ue71603 Jan 20, 2023
7ff4cb2
Update OJP/OJP_Locations.xsd
ue71603 Jan 20, 2023
82f8dcd
Lint and update documentation tables
github-actions[bot] Jan 20, 2023
4c8b20d
Apply suggestions from code review
ue71603 Jan 20, 2023
9b0ec08
Lint and update documentation tables
github-actions[bot] Jan 20, 2023
f4a53fe
Apply suggestions from code review
ue71603 Jan 20, 2023
d261d8a
Lint and update documentation tables
github-actions[bot] Jan 20, 2023
f458a7d
Apply suggestions from code review
ue71603 Jan 20, 2023
6a42804
Lint and update documentation tables
github-actions[bot] Jan 20, 2023
388bb65
as the support is about Place it is PlaceSupport.xsd
ue71603 Jan 26, 2023
1a2bf0f
Lint and update documentation tables
github-actions[bot] Jan 27, 2023
ee7c764
Update OJP_Locations.xsd
ue71603 Jan 27, 2023
466f21e
fix changes
ue71603 Jan 27, 2023
c3d4731
Lint and update documentation tables
github-actions[bot] Jan 27, 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
2 changes: 1 addition & 1 deletion OJP/OJP_All.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<xs:include schemaLocation="OJP_JourneySupport.xsd"/>
<xs:include schemaLocation="OJP_Lines.xsd"/>
<xs:include schemaLocation="OJP_ModesSupport.xsd"/>
<xs:include schemaLocation="OJP_Places.xsd"/>
<xs:include schemaLocation="OJP_Locations.xsd"/>
<xs:include schemaLocation="OJP_PlaceSupport.xsd"/>
<xs:include schemaLocation="OJP_Requests.xsd"/>
<xs:include schemaLocation="OJP_RequestSupport.xsd"/>
Expand Down
12 changes: 6 additions & 6 deletions OJP/OJP_JourneySupport.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,9 @@
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TripPlaceStructure">
<xs:complexType name="TripLocationStructure">
<xs:annotation>
<xs:documentation>A trip place represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip place does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat.</xs:documentation>
<xs:documentation>A trip location represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip location does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="OperatingDayRef"/>
Expand Down Expand Up @@ -502,21 +502,21 @@
<xs:documentation>Static place.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TripPlace" type="TripPlaceStructure">
<xs:element name="TripLocation" type="TripLocationStructure">
<xs:annotation>
<xs:documentation>Place within a (moving) vehicle.</xs:documentation>
<xs:documentation>Location within a (moving) vehicle.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice minOccurs="0">
<xs:element name="DepArrTime" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Time when departure/arrival from/to place is required.</xs:documentation>
<xs:documentation>Time when departure/arrival from/to location is required.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TimeAllowance" type="xs:duration" minOccurs="0">
<xs:annotation>
<xs:documentation>Extra time needed before reaching/after leaving this place.</xs:documentation>
<xs:documentation>Extra time needed before reaching/after leaving this location.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
Expand Down
52 changes: 26 additions & 26 deletions OJP/OJP_Places.xsd → OJP/OJP_Locations.xsd
View file
Open in desktop
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_Places.xsd - Request and response definitions for place information</xs:documentation>
<xs:documentation>OJP/OJP_Location.xsd - Request and response 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 @@ -12,17 +12,17 @@
<xs:documentation>FUNCTION 4: Coordinate to Address</xs:documentation>
<xs:documentation>All functions integrated into one request / response</xs:documentation>
</xs:annotation>
<xs:group name="PlaceInformationRequestGroup">
<xs:group name="LocationInformationRequestGroup">
<xs:sequence>
<xs:choice>
<xs:element name="InitialInput" type="InitialPlaceInputStructure">
<xs:element name="InitialInput" type="InitialLocationInputStructure">
<xs:annotation>
<xs:documentation>Initial input for the place information request. This input defines what is originally looked for.</xs:documentation>
<xs:documentation>Initial input for the location information request. This input defines what is originally looked for. Be aware that this also can contain PLACEs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PlaceRef" type="PlaceRefStructure">
<xs:annotation>
<xs:documentation>Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here.</xs:documentation>
<xs:documentation>LOCATION for further refinement. If a location in a previous response was marked as not "complete" it can be refined by putting it here.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
Expand All @@ -33,9 +33,9 @@
</xs:element>
</xs:sequence>
</xs:group>
<xs:group name="PlaceInformationResponseGroup">
<xs:group name="LocationInformationResponseGroup">
<xs:sequence>
<xs:element name="PlaceInformationResponseContext" type="ResponseContextStructure" minOccurs="0">
<xs:element name="LocationInformationResponseContext" type="ResponseContextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Context to hold response objects that occur frequently.</xs:documentation>
</xs:annotation>
Expand All @@ -51,26 +51,26 @@
<xs:annotation>
<xs:documentation>========================================== Additional declarations ==========================================</xs:documentation>
</xs:annotation>
<xs:complexType name="InitialPlaceInputStructure">
<xs:complexType name="InitialLocationInputStructure">
<xs:sequence>
<xs:element name="Name" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of the place object which is looked after. This is usually the user's input. If not given, the name of the resulting place objects is not relevant.</xs:documentation>
<xs:documentation>Name of the LOCATION object which is looked for. This is usually the user's input. If not given, the name of the resulting location objects is not relevant.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="GeoPosition" type="siri:LocationStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Coordinate where to look for places. If given, the result should prefer place objects near to this GeoPosition.</xs:documentation>
<xs:documentation>Coordinate where to look for locations/places. If given, the result should prefer locations/place objects near to this GeoPosition.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="GeoRestriction" type="GeoRestrictionsStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Restricts the resulting place objects to the given geographical area.</xs:documentation>
<xs:documentation>Restricts the resulting location/place objects to the given geographical area.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AllowedSystem" type="siri:ParticipantRefStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/</xs:documentation>
<xs:documentation>Used in distributed environments. e.g. EU-Spirit. If none is given, the location/place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location/place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand Down Expand Up @@ -128,7 +128,7 @@
<xs:element name="Place" type="PlaceStructure"/>
<xs:element name="Complete" type="xs:boolean">
<xs:annotation>
<xs:documentation>States whether the included place is complete or needs further refinement. Only complete places are fully resolved and can be used in e.g. trip requests. Incomplete places have to be refined entering them once again into a PlaceInformationRequest.</xs:documentation>
<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>
</xs:annotation>
</xs:element>
<xs:element name="Probability" minOccurs="0">
Expand Down Expand Up @@ -192,27 +192,27 @@
<xs:sequence>
<xs:element name="Type" type="PlaceTypeEnumeration" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Allowed place object types. If none is given, all types are allowed.</xs:documentation>
<xs:documentation>Allowed location/place object types. If none is given, all types are allowed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Usage" type="PlaceUsageEnumeration" minOccurs="0">
<xs:annotation>
<xs:documentation>Defines, whether place objects for origin, via, or destination are searched.</xs:documentation>
<xs:documentation>Defines, whether location/place objects for origin, via, or destination are searched.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PtModes" type="PtModeFilterStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.</xs:documentation>
<xs:documentation>Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OperatorFilter" type="OperatorFilterStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Filter for places that are operated by certain organisations.</xs:documentation>
<xs:documentation>Filter for locations/places that are operated by certain organisations.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TopographicPlaceRef" type="TopographicPlaceRefStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>If at least one is set, only place objects within the given localities are allowed.</xs:documentation>
<xs:documentation>If at least one is set, only location/place objects within the given localities are allowed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PointOfInterestFilter" type="PointOfInterestFilterStructure" minOccurs="0">
Expand Down Expand Up @@ -278,12 +278,12 @@
<xs:sequence>
<xs:element name="PlaceRef" type="PlaceRefStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.</xs:documentation>
<xs:documentation>Location/Place for which exchange points to other "neighbour" systems are to be searched. This location/place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Params" type="ExchangePointsParamStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>E.g. place types (stops, addresses, POIs) or specific place attributes</xs:documentation>
<xs:documentation>E.g. location/place types (stops, addresses, POIs) or specific location/place attributes</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand All @@ -298,27 +298,27 @@
<xs:sequence>
<xs:element name="Type" type="PlaceTypeEnumeration" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Allowed place object types. If none is given, all types are allowed.</xs:documentation>
<xs:documentation>Allowed location/place object types. If none is given, all types are allowed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Usage" type="PlaceUsageEnumeration" minOccurs="0">
<xs:annotation>
<xs:documentation>Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey.</xs:documentation>
<xs:documentation>Defines, whether the location/place object of this request acts as origin, via or destination point of the passenger journey.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PtModes" type="PtModeFilterStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops.</xs:documentation>
<xs:documentation>Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OperatorFilter" type="OperatorFilterStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Filter for places that are operated by certain organisations.</xs:documentation>
<xs:documentation>Filter for locations/places that are operated by certain organisations.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TopographicPlaceRef" type="TopographicPlaceRefStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>If at least one is set, only place objects within the given localities are allowed.</xs:documentation>
<xs:documentation>If at least one is set, only location/place objects within the given localities are allowed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DestinationSystem" type="siri:ParticipantRefStructure" minOccurs="0">
Expand Down Expand Up @@ -377,7 +377,7 @@
</xs:element>
<xs:element name="TravelDurationEstimate" type="xs:duration" minOccurs="0">
<xs:annotation>
<xs:documentation>Rough estimate of the travel duration from the specified reference place to this exchange point.</xs:documentation>
<xs:documentation>Rough estimate of the travel duration from the specified reference location/place to this exchange point.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="WaitDuration" type="xs:duration" default="PT0M" minOccurs="0">
Expand Down
2 changes: 1 addition & 1 deletion OJP/OJP_PlaceSupport.xsd
View file
Open in desktop
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_PlaceSupport.xsd - Supporting definitions for place information</xs:documentation>
<xs:documentation>OJP/OJP_LocationSupport.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 Down
16 changes: 8 additions & 8 deletions OJP/OJP_Requests.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,27 @@
</xs:complexContent>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== PlaceInformation Service ==========================================</xs:documentation>
<xs:documentation>========================================== Location Information Service ==========================================</xs:documentation>
</xs:annotation>
<xs:element name="OJPPlaceInformationRequest" type="OJPPlaceInformationRequestStructure" substitutionGroup="siri:AbstractFunctionalServiceRequest"/>
<xs:complexType name="OJPPlaceInformationRequestStructure">
<xs:element name="OJPLocationInformationRequest" type="OJPLocationInformationRequestStructure" substitutionGroup="siri:AbstractFunctionalServiceRequest"/>
<xs:complexType name="OJPLocationInformationRequestStructure">
<xs:complexContent>
<xs:extension base="AbstractOJPServiceRequestStructure">
<xs:sequence>
<xs:group ref="PlaceInformationRequestGroup"/>
<xs:group ref="LocationInformationRequestGroup"/>
<xs:element ref="siri:Extensions" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="OJPPlaceInformationDelivery" type="OJPPlaceInformationDeliveryStructure" substitutionGroup="siri:AbstractFunctionalServiceDelivery"/>
<xs:complexType name="OJPPlaceInformationDeliveryStructure">
<xs:element name="OJPLocationInformationDelivery" type="OJPLocationInformationDeliveryStructure" substitutionGroup="siri:AbstractFunctionalServiceDelivery"/>
<xs:complexType name="OJPLocationInformationDeliveryStructure">
<xs:complexContent>
<xs:extension base="siri:AbstractServiceDeliveryStructure">
<xs:sequence>
<xs:element ref="OJPPlaceInformationRequest" minOccurs="0"/>
<xs:element ref="OJPLocationInformationRequest" minOccurs="0"/>
<xs:group ref="ServiceResponseContextGroup"/>
<xs:group ref="PlaceInformationResponseGroup"/>
<xs:group ref="LocationInformationResponseGroup"/>
<xs:element ref="siri:Extensions" minOccurs="0"/>
</xs:sequence>
</xs:extension>
Expand Down
8 changes: 4 additions & 4 deletions OJP/OJP_StopEvents.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
<xs:documentation>Request structure for departure and arrival events at stops</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Place" type="PlaceContextStructure">
<xs:element name="Location" type="PlaceContextStructure">
<xs:annotation>
<xs:documentation>Place for which to obtain stop event information.</xs:documentation>
<xs:documentation>LOCATION / PLACE for which to obtain stop event information.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Params" type="StopEventParamStructure" minOccurs="0">
Expand Down Expand Up @@ -247,12 +247,12 @@
</xs:element>
<xs:element name="WalkDistance" type="siri:DistanceType" minOccurs="0">
<xs:annotation>
<xs:documentation>Distance from request place (f.e. address) to this stop in metres.</xs:documentation>
<xs:documentation>Distance from request LOCATION / PLACE (f.e. address) to this stop in metres.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="WalkDuration" type="xs:duration" minOccurs="0">
<xs:annotation>
<xs:documentation>Walking duration from request place (f.e. address) to this stop. All user options taken into account (f.e. walk speed).</xs:documentation>
<xs:documentation>Walking duration from request LOCATION / PLACE (f.e. address) to this stop. All user options taken into account (f.e. walk speed).</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand Down
Loading