-
Notifications
You must be signed in to change notification settings - Fork 4
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
Clear names for receivers API fields #12
Conversation
api/v2/openapi.yaml
Outdated
type: string | ||
format: date-time | ||
lastNotifyDuration: | ||
lastAttemptDuration: |
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.
lastAttemptDuration: | |
lastAttemptDuration: | |
description: duration of the last attempt to use the integration in humanized format, e.g. `1s` or `15ms` |
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.
@yuri-tceretian I just added descriptions for the fields and generated the files.
While we don't necessarily need to stick 1:1 with Prometheus, it'd be good if similar things keep similar names. In prometheus, Personally, I'd love to stick with |
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.
LGTM
We're using
lastNotify
andlastNotifyDuration
to indicate the time and duration for the last attempt regardless of the outcome. A better option would be to uselastAttempt
andlastAttemptDuration
instead.The field
lastError
doesn't store the last error that occurred, but the error for the last attempt to notify (if any). This could be confusing because if a notification fails to deliver once but succeeds afterwards, this field will be empty. The name has been changed tolastAttemptError
to better reflect this behavior.