Fix ResponderRequest unmarshalling of IncidentResponders #493
Conversation
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
This commit also tweaks the json key name as the previous key did not match the key used in production.
allyjweir
commented
Aug 8, 2023
| @@ -659,7 +659,7 @@ type ResponderRequestResponse struct { | |||
| // ResponderRequestTarget specifies an individual target for the responder request. | |||
| type ResponderRequestTarget struct { | |||
| APIObject | |||
| Responders IncidentResponders `json:"incident_responders,omitempty"` | |||
| Responders []IncidentResponders `json:"incidents_responders,omitempty"` | |||
There was a problem hiding this comment.
I did consider if the IncidentResponders type should be renamed IncidentResponder but decided to keep this PR to the minimum diff and not to break the interface
|
Thanks for submitting this @allyjweir. Just following up on something internally and then we will get this merged. |
ChuckCrawford
approved these changes
Aug 16, 2023
gringus
pushed a commit
to gringus/go-pagerduty
that referenced
this pull request
Jan 26, 2024
This commit also tweaks the json key name as the previous key did not match the key used in production.
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.
This PR fixes an unmarshalling bug that was found while trying to use the
ResponderRequestWithContextmethod on the client.The response that the API returns is subtly different to the one which the client library is expecting. Within the
responder_request_targetobject, the client library expects a key calledincident_responders. However when interacting with the API directly, this key is actuallyincidents_responders. Note the additionalswhich pluralises 'incident'.Impact
This meant that whenever you made a responder request via the client library, it would succeed but the response would only be partial. That meant you could not retrieve any of the information about the responders which your request had added to an incident.
A note on API documentation
Please note that there is an inconsistency in the PagerDuty API documentation for this endpoint.
incident_respondersincidents_responders