Fix the ResponderRequest input/output structures

[CerealBoy]

The doc for incidents/{id}/responder_requests is mis-leading, in that the description, example, and formatted doc each show a different structure. This morning I worked with support to actually determine the necessary structure here, so have updated the input and output structure here to resolve this.

For any implementation of this previously the structure of the code will require updating, but as this was already broken this should be fine?

Currently:

{
  "requester_id": "identifier",
  "message": "Help has been requested",
  "responder_request_targets": [
    {
      "type": "escalation_policy",
      "id": "identifier"
    }
  ]
}

Should be:

{
  "requester_id": "identifier",
  "message": "Help has been requested",
  "responder_request_targets": [
    {
      "responder_request_target": {
        "type": "escalation_policy",
        "id": "identifier"
      }
    }
  ]
}

[asabitov]

Ah, that makes sense, thought it is not really natural.
fruits: [apple:{color,red}, pear:{color,green}]

[asabitov]

Well, as long as it works :)

[theckman]

#233 does basically the same thing, merging it was blocked waiting on v1.4.0 release (since this is a breaking change). If that PR isn't updated relatively soon we'll move forward with reviewing this one.

[CerealBoy]

#233 does basically the same thing, merging it was blocked waiting on v1.4.0 release (since this is a breaking change). If that PR isn't updated relatively soon we'll move forward with reviewing this one.

Oh, I should've checked! Happy for this to be closed in favour of the other 👍

[CerealBoy]

@theckman I wanted to check-in to see if there's been any update on when this can be brought in?

[theckman]

@CerealBoy So, I've enough access in this repo to review and merge the PRs of others, but not myself. I'm waiting for PagerDuty staff to review #325 so I can merge it, and then I can merge external PRs that are going to go into v1.5.0 (this being one of them).

[CerealBoy]

That's great, thank you very much for the update! Hopefully they get back soon 🤞

[theckman]

Alright! v1.5.0 merge window has opened, so I'll get this brought-in to be included in that release once it's cut. No timeline for that just yet, but I hope to get it all hammered out within the coming weeks.

[theckman]

Thanks again!