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.

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

Add new optional field SeverityLevel to Service Alerts feed #136

Merged

Conversation

ibi-group-team
Copy link
Contributor

@ibi-group-team ibi-group-team commented Jan 16, 2019

This is a proposal to add a new field SeverityLevel to the ServiceAlerts feed. The SeverityLevel field would be optional and comprised of enum values:

  • UNKNOWN_SEVERITY
  • INFO
  • WARNING
  • SEVERE

See discussion here: #133

Announced on the GTFS-realtime Google Groups here: https://groups.google.com/forum/#!topic/gtfs-realtime/t8bpU5gbjDU

@LeoFrachet
Copy link
Contributor

LeoFrachet commented Jan 21, 2019

Looks good!

Two small suggestions:

  1. Please add the space missing in the comment, to stay consistent with the rest of the doc: //Severity => // Severity
  2. Andrew (@abyrd) and Sean (@barbeau) in the issue Add new field SeverityLevel (enum, optional) to Service Alerts feed #133 suggested INFO instead of INFORMATIONAL. I have no strong opinion. I slightly lean toward INFO but I have no opposition toward INFORMATIONAL.

@barbeau
Copy link
Collaborator

barbeau commented Jan 22, 2019

I also have a preference for INFO but no strong objection to INFORMATIONAL

@abyrd
Copy link

abyrd commented Jan 22, 2019

Initially I had a preference for INFO over INFORMATIONAL. But on further reflection I think this is just because the value INFO is often used in logging, which is really a different application. I can see why we'd want to avoid abbreviations in enum values. INFO in this case may stand for INFORMATIONAL, or does it stand for INFORMATION? Either way the grammatical parallelism with the other enum values is questionable.

I think the main argument for INFO is that it is concise and not strictly an adjective or a noun. It seems like more people prefer INFO but I wouldn't actively oppose INFORMATIONAL.

@ibi-group-team
Copy link
Contributor Author

This pull request has been open for more than one week, so we are calling for a vote.

Voting will be closed on Thursday January 31 at 23:59:59 UTC.

@laurentg
Copy link

laurentg commented Jan 24, 2019

Just as a side note, in our Urbiplan alerts product we already have this severity level. We use 3 levels: INFO, WARN, CRITICAL. +1
Also we would be ready to output GTFS-RT alert feeds with this severity level field rapidly if this change is accepted.

@abyrd
Copy link

abyrd commented Jan 24, 2019

+1

3 similar comments
@skinkie
Copy link
Contributor

skinkie commented Jan 24, 2019

+1

@paulswartz
Copy link
Contributor

+1

@gcamp
Copy link
Contributor

gcamp commented Jan 24, 2019

+1

@barbeau
Copy link
Collaborator

barbeau commented Jan 24, 2019

+1

@ibi-group-team There are a few formatting items I commented on that need to be fixed prior to merge.

Also, as a side note, the conventions proposed here match Google's severity levels (Critical, Warning, Informational) inferred from Alert Effects as listed on https://support.google.com/transitpartners/answer/6374472?hl=en&ref_topic=6159819.

@prhod
Copy link

prhod commented Jan 25, 2019

+1

1 similar comment
@harringtonp
Copy link

+1

@ibi-group-team
Copy link
Contributor Author

Voting for this proposal is closed and the results are:
Yes: 8
No: 0

So the proposal passes! We'll get this merged.

Thank you all!

@barbeau barbeau merged commit 1b602c2 into google:master Feb 1, 2019
@barbeau
Copy link
Collaborator

barbeau commented Feb 1, 2019

Thanks @ibi-group-team and all!

@ibi-group-team ibi-group-team deleted the ServiceAlerts-add-severity-field branch February 1, 2019 16:27
@scmcca scmcca added proposal GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime labels May 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GTFS Realtime Issues and Pull Requests that focus on GTFS Realtime
Projects
None yet
Development

Successfully merging this pull request may close these issues.