Fix misleading ParticipantRef documentation - #1066
Conversation
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
left a comment
There was a problem hiding this comment.
Maybe do a pull request on the SIRI repo too?
|
@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.» ?? |
trurlurl
left a comment
There was a problem hiding this comment.
To me, the following would make things even more clear: "External code identifying the sender of the message."
|
@trurlurl i do agree in the context of NeTEx, but since it is used in SIRI as well it would be too narrow. ParticipantRefStructure in SIRI is used as base for ConsumerRef, SubscriberRef and ResponderRef, |
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.