Add comment above IncidentDetails.Alerts field explaining behaviors #335
Conversation
This file contains 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
stmcallister
approved these changes
Oct 8, 2021
For the Webhook object sent from PagerDuty, the "alerts" key is not a JSON array of fully hydrated objects. Instead, only the "alert_key" JSON key is set within each object, which might be unclear based on the type we use in the Go client. This change adds a comment above the Alerts field to indicate it's not a slice of fully hydrated `IncidentAlert` values, and that only `AlertKey` is set.
theckman
force-pushed
the
clarify_webhook_alert
branch
from
b116e6a
to
4d613ad
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
For the Webhook object sent from PagerDuty, the "alerts" key is not a JSON array
of fully hydrated objects. Instead, only the "alert_key" JSON key is set within
each object, which might be unclear based on the type we use in the Go client.
This change adds a comment above the Alerts field to indicate it's not a slice
of fully hydrated
IncidentAlertvalues, and that onlyAlertKeyis set.