-
Notifications
You must be signed in to change notification settings - Fork 12
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
Avoid confusion about TripSummary #109
Conversation
Removed AcceptDeferredDelivery from TripPolicyFilterGroup. Instead added TripSummaryOnly into TripContentFilterGroup as the parameter to control whether complete trips or only trip summaries shall be delivered. There is no relation to a deferred delivery anymore. Removed IncludeLegs from MultiPointTripContentFilterGroup, as legs are mandatory within trip results. Removed MultiPointTripContentFilterGroup, as there is no need have different content filters for MultiPointTrip or Trip respectively.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general I think this change is a good idea, as it simplifies request handling, but it was purposefully added:
Full trip information is sent actively by the server to the Address stated in RequestorEndpointGroup.
This option was not part of TRIAS and has been added to OJP in the initial release - do you know by whom this feature was requested/used?
This once again is a breaking change which must be thoroughly documented.
The documentation in https://github.com/VDVde/OJP/blob/ResponseContextInRequestSupport/OJP_Trips.xsd#L248 needs to be updated too:
<xs:element name="TripSummary" type="TripSummaryStructure">
<xs:annotation>
<xs:documentation>Summary on trip. Only if requestor accepts deferrred delivery of trip details.</xs:documentation>
</xs:annotation>
</xs:element>
Actually, I don't know the detailed reasons for this design decision. However, I assume, that something similar to the once existing DELFI partial connection service was planned (which computed something similar to a TripSummary), but with the mechanisms of SIRI messages. Such a "TripSummary only" service is not part of TRIAS and had to be invented for OJP. But I assume, that the usage of deferred delivery for this was not intension but chance. |
Removed AcceptDeferredDelivery from TripPolicyFilterGroup. Instead added TripSummaryOnly into TripContentFilterGroup as the parameter to control whether complete trips or only trip summaries shall be delivered. There is no relation to a deferred delivery anymore.
Removed IncludeLegs from MultiPointTripContentFilterGroup, as legs are mandatory within trip results. Removed MultiPointTripContentFilterGroup, as there is no need have different content filters for MultiPointTrip or Trip respectively.