Return value description for `pages/…/metric-providers/…/metrics` is inaccurate

[Johnson Earls]

In the API documentation for "List metrics for a metric provider" (https://developer.statuspage.io/#operation/getPagesPageIdMetricsProvidersMetricsProviderIdMetrics) the return value is incorrectly reported as a single object, rather than an array of objects.

[Jesse Klein]

Hi Johnson,

Thanks for reaching out about the documentation. I think the intent of the documentation is to show what the object contains. Since these are lists, they would need to show every individual object in one request as an array. That said, I can bring this to the attention of the team to see about adding clarity to the documentation. If you have any further questions about using these endpoints, please feel free to reach out with a support ticket.

Regards,
Jesse

[Johnson Earls]

FYI, other objects that return an array show the return value as

Array [
    (Object Description)
]

 This one just shows the object description without the surrounding "Array [" ... "]" text.

[Jesse Klein]

Hi Johnson,

Thanks for sharing the response. I think I understand what you're saying. I brought it up and I was asked to open a bug report. You can view this here: https://jira.atlassian.com/browse/STATUS-881

Thanks for reporting this to us!

Regards,
Jesse