Documentation discrepency: chat/emoticon_images

[Six]

When the chat/emoticon_images endpoint is called without the optional emotesets parameter, the returned JSON blob does not match the documentation. Instead of returning this:

{
    "emoticon_sets": {
        "19151": [
            {
                "code": "TwitchLit",
                "id": 115390
            },
            ...
        ],
        ...
    }
}

The returned JSON blob structure is this:

{
    "emoticons": {
        [
            {
                "id": 69119
                "code": "ydmSatta",
                "emoticon_set": 13794
            },
            ...
        ]
    }
}

This isn’t so much of a discrepancy as it is just completely missing from the documentation.

[DallasNChains]

This isn’t a discrepancy. All example responses match their example requests. For this particular endpoint, the request specifies an emoteset parameter of 19151, which is why the response only includes that emoteset.

[Six]

When emotesets is specified, yes, the returned object matches what is in the documentation. I was trying to state that when emotesets isn’t specified is when the returned object doesn’t match.

[DallasNChains]

You’re correct. In the documentation, we don’t demonstrate all responses for all configurations of the endpoints. It would make the documentation too unwieldy and, ultimately, useless when the majority of the page is requests and responses. We choose a particular scenario that seems the most illustrative of the endpoint’s functionality and provide that. The rest is left up to the curiosity of the developer.

[3ventic]

@DallasNChains That makes sense when the structure of the response stays the same, but here the presence of emotesets param changes it where it doesnt fit in the existing model at all. Would be great to be able to build the data models without debugging actual requests.

[DallasNChains]

I updated this with an example of both result sets: https://dev.twitch.tv/docs/v5/reference/chat/#get-chat-emoticons-by-set