While implementing support for the Get User Emotes endpoint in Chatterino, I noticed some shortcomings in the documentation of the response.
data.name has the wrong documentation (currently: "The User ID of broadcaster whose channel is receiving the unban request.")
data.emote_type doesn't list all possible values, but the phrasing implies all possible values are listed. (Resolved in #928)
data.emote_set_id doesn't mention that it might be empty and why it could be empty.
data.owner_id doesn't mention that it might be empty and why it could be empty.
Expected documentation
data.name: The name of the emote. This is the name that viewers type in the chat window to get the emote to appear.
data.emote_type: The type of emote. Some possible values are: bitstier, follower, subscriptions, globals.
data.emote_set_id: An ID that identifies the emote set that the emote belongs to. Empty if ...
data.owner_id: The ID of the broadcaster who owns the emote. Empty if ...
Screenshots
Additional context or questions
While implementing, I also noticed that the endpoint requires quite a lot of requests. For my user with two subscriptions, I had to make 28 requests to get all emotes for one channel. There are users with a lot more subs and a lot of channels open (25-100) which would - assuming 30 requests for one channel - make up to 3000 requests just starting the app. Most pages are sparsely populated, I got the following page sizes:
Brief description
While implementing support for the Get User Emotes endpoint in Chatterino, I noticed some shortcomings in the documentation of the response.
data.name
has the wrong documentation (currently: "The User ID of broadcaster whose channel is receiving the unban request.")(Resolved in #928)data.emote_type
doesn't list all possible values, but the phrasing implies all possible values are listed.data.emote_set_id
doesn't mention that it might be empty and why it could be empty.data.owner_id
doesn't mention that it might be empty and why it could be empty.Expected documentation
data.name
: The name of the emote. This is the name that viewers type in the chat window to get the emote to appear.data.emote_type
: The type of emote. Some possible values are: bitstier, follower, subscriptions, globals.data.emote_set_id
: An ID that identifies the emote set that the emote belongs to. Empty if ...data.owner_id
: The ID of the broadcaster who owns the emote. Empty if ...Screenshots
Additional context or questions
While implementing, I also noticed that the endpoint requires quite a lot of requests. For my user with two subscriptions, I had to make 28 requests to get all emotes for one channel. There are users with a lot more subs and a lot of channels open (25-100) which would - assuming 30 requests for one channel - make up to 3000 requests just starting the app. Most pages are sparsely populated, I got the following page sizes:
These could easily fit into 2–4 pages.
Should I open a separate issue for this?