Fix misleading ParticipantRef documentation - #1066
Open
hfjelstad wants to merge 3 commits into
Open
Conversation
Fix typo in the documentation of LINE Fix made by @ue71603
The ParticipantRef documentation ('Identifier of system requesting Data.') only fits the request case. In a publication delivery the field identifies the party that produced the data, not a requestor. The value is also a code (NMTOKEN via siri:ParticipantCodeType), not an object reference. Updated the xsd:documentation to 'External code identifying the source of the data being exchanged.' covering both publication and request. Element name and type are unchanged, so there is no schema break.
skinkie
previously approved these changes
Aug 20, 2026
skinkie
left a comment
skinkie
left a comment
Contributor
There was a problem hiding this comment.
Maybe do a pull request on the SIRI repo too?
skinkie
added
the
enhancement
Contributor
Author
|
@skinkie SIRI does not seem to have the same issue: ParticipantCodeType (NMTOKEN) | «Type for Unique identifier of participant.» So it could be changed to: ParticipantRefStructure (extends code) | «External code identifying a participant.» ?? |
TuThoThai
added
the
xsd-documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
ParticipantRefelement in the publication schemas is documented as"Identifier of system requesting Data."
That wording only fits the request case. In a publication delivery the field
identifies the party that produced the data, not a requestor — so the
mandatory (delivery) use is documented incorrectly.
Additionally, the value is a code (NMTOKEN via
siri:ParticipantCodeType),not a reference to an object. There is no
Participanttype and nokeyref—the value is the identity. The
...Refname suggests an object reference thatdoes not exist.
Fix
Short term (documentation only, non-breaking): update the
xsd:documentationto cover both publication and request:
Applied to all four top-level publication schemas:
xsd/NeTEx_publication.xsdxsd/NeTEx_publication_timetable.xsdxsd/NeTEx_publication-NoConstraint.xsdxsd/wsdl/NeTEx_publication-NoConstraint.xsdThe element name and type are left unchanged, so there is no schema break.