Clarify behavior for multiple fields in Alert EntitySelectors - #118
Merged
barbeau merged 1 commit intoDec 6, 2018
Merged
Conversation
There has been confusion in the past over the expected behavior of the EntitySelector object within Alerts, especially when multiple fields are provided within an EntitySelector (see https://groups.google.com/forum/#!topic/gtfs-realtime/jamsDygrcSk). In particular, the GTFS-realtime .proto documentation indicates that these fields should be joined as an AND and the alert should only be applied to the entity if it matches all the provided fields. However, the GTFS-realtime documentation is somewhat ambiguous and could be interpreted as joining these fields as an OR - in other words, the alert applies to all entities that match any of the provided fields. This proposal clarifies the GTFS-realtime documentation to align with the .proto documentation to clearly indicate that when when multiple fields are provided in an EntitySelector, they should be joined as an AND - in other words, in order for an alert to apply to an entity it must match all of the provided EntitySelector fields.
barbeau
added
the
GTFS Realtime
This was referenced Nov 14, 2018
Contributor
|
Big +1 |
Contributor
|
+1 |
|
Though I don't think we're voting yet, +1 in its current form. |
Contributor
|
+1 for me as well. |
Contributor
Author
|
This pull request has been open for more than one week, so per the Official Process I'm calling for a vote. Vote will be closed on Monday December 3rd at 23:59:59 UTC. |
Contributor
|
+1 |
4 similar comments
Contributor
|
👍 |
|
+1 |
Contributor
|
+1 |
|
+1 |
Contributor
Author
|
The vote is closed with the following:
So it passes! Thanks all! |
This was referenced Jan 3, 2022
Closed
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
8 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.
There has been confusion in the past over the expected behavior of the EntitySelector object within Alerts, especially when multiple fields are provided within an EntitySelector (see https://groups.google.com/forum/#!topic/gtfs-realtime/jamsDygrcSk). In particular, the GTFS-realtime .proto documentation indicates that these fields should be joined as an AND and the alert should only be applied to the entity if it matches all the provided fields. However, the GTFS-realtime documentation is somewhat ambiguous and could be interpreted as joining these fields as an OR - in other words, the alert applies to all entities that match any of the provided fields.
This proposal clarifies the GTFS-realtime documentation to align with the .proto documentation to clearly indicate that when when multiple fields are provided in an EntitySelector, they should be joined as an AND - in other words, in order for an alert to apply to an entity it must match all of the provided EntitySelector fields.
Announced on the GTFS-realtime group at https://groups.google.com/forum/#!topic/gtfs-realtime/GfwvTmAOu1I.