ContactMethod field does not populate inside the NotificationRule on a User

[stefprez]

When fetching a user, the NotificationRules get populated for that user, but the ContactMethod field on each NotificationRule in the []NotificationRules always seems to be empty.

[theckman]

@stefprez can you give me an idea of how you're calling GetUser? Are you telling it to include the notification_rules?

[theckman]

@stefprez oh sorry, I misread your question originally. That is the expected behavior in terms of how PagerDuty documents their API, and the fact you expected it to be present might indicate a deficiency in our library. Please refer to this API documentation page.

You'll notice that under the schema for the response, the notification_rules array contains an object that has the following fields: id, summary, type, self, and html_url which is the same structure as the APIObject type in this package. It does not contain a contact_method field.

The PagerDuty REST API often returns references to the real object instead of returning the whole object in the response. This is to keep response sizes down.

I don't believe we should try to make the extra requests on behalf of the consumer to populate that data, so I think this bug should be marked as wontfix.

That said, for v2.0.0 I'll open an issue to track research on updating these references to use APIObject instead to avoid this kind of confusion.

[theckman]

I've opened that issue and will now close this one in favor of #279

[stefprez]

Excellent. Thanks for the additional context!