24 results found
-
PubSub Docs don't mention Token Type
From: https://github.com/twitchdev/issues/issues/25
Brief description
https://dev.twitch.tv/docs/pubsub#topics
PubSub documentation mentions the requirement to use an oAuth token, but doesn't directly specify which type of token, nor the requirement for the UserID of the token to match the UserID of the topic.
Authentication All topics require an OAuth token, but only some topics have a specific required scope (noted in the table below). Available Topics All topics require an OAuth token, but only some topics have a specific required scope (noted in the table).Expected documentation
…Authentication All topics require a User Access OAuth token, where the UserID of the token matches the9 votes -
PubSub Topics: no moderator topic examples/documentation
https://dev.twitch.tv/docs/pubsub
Has no examples or documentation for payloads for chatmoderatoractions
7 votes -
Fix TMI JS example with Promise handling
https://dev.twitch.tv/docs/irc#overview
Row:
client.connect();Should be replaced with:
client.connect().catch((err) => {console.log('Connection error!', err)});
or smth like that.Let's show users how to write good code, and show them, that all Promises should be handled. Unhandled promise rejections is bad!
Tmi.js Library also have connect example which contain promise handling
7 votes -
User banned extensions unload
So it seems that when a user is banned or timed out, extensions unload/are unavailable to those users.
This is not documented.
It should be documented somewhere
5 votes -
Please add an example payload of a resubgift/anonresubgift to the PubSub docs
I raised https://twitch.uservoice.com/forums/310213-developers/suggestions/41016568-context-resubgift-in-resub-events?tracking_code=8f96eb083a992136c313fb0ca1d79054 because I ctrl+f'ed for context as apposed to ctrl+f-ing for resubgift.
Please add an example for a resub/anonresubgift
5 votes -
graph syntax not built on deploy
The graphs on this page don't look right. The graph syntax is displaying, not the graph itself.
%% Extensions Overview Diagram graph LR Twitch --> | - postMessage - | Extension Extension --> | - postMessage - | Twitch Extension --> | - HTTP - | APIs Extension --> | - HTTP - | EBS[Extension Backend] Identity --> Twitch Chat --> Twitch Memes --> Twitch4 votes -
Chat and Pubsub - channel:moderate
As per this other uservoice
The moderation actions PubSub at time of writing requires a key from the channel you wish to listen to with the scope
channel:moderateHowever the scopes page
https://dev.twitch.tv/docs/authentication/#scopes
is mis leading as it only talks about how the scope works for chat leading to confusion with pubsub operation
"Perform moderation actions in a channel. The user requesting the scope must be a moderator in the channel."
The wording needs to be changed and/or the pubsub topic adjusted to support being able to read moderator events as a moderator
4 votes -
The Validate requests endpoint omits the expiry from the example response
URL
https://dev.twitch.tv/docs/authentication#validating-requests
{
"clientid": "<your client ID>",
"login": "<authorized user login>",
"scopes": [
"<requested scopes>"
],
"userid": "<authorized user ID>"
}should be
{
"clientid": "<your client ID>",
"login": "<authorized user login>",
"scopes": [
"<requested scopes>"
],
"userid": "<authorized user ID>",
"expires_in": timeInSeconds
}4 votes -
HTTP Response codes unclear
From: https://github.com/twitchdev/issues/issues/69
Brief descriptionSome endpoints return a 204 code no content.
But this is only highlighted in the example responses and not in the "main documentation"For example
https://dev.twitch.tv/docs/extensions/reference#send-extension-pubsub-message
https://dev.twitch.tv/docs/extensions/reference#send-extension-chat-messageEach endpoint documented could be extended to include usual HTTP response codes.
Expected documentation
The expected response code for success when theres no body response
Common non 2xx codes for the endpoints4 votes -
Webhooks (Un)Subscribe Parameters
From: https://github.com/twitchdev/issues/issues/14
Brief description
https://dev.twitch.tv/docs/api/webhooks-reference
the
hub.topicsection is out of date, in the JSON Body ParametersExpected documentation
Just changed it to something like "refer to later in this docs for the available topics"
4 votes -
Split the Helix API reference into sub-categories
As the Helix API reference page (https://dev.twitch.tv/docs/api/reference) is continuing to grow it it is starting to become unwieldly with the number of entries.
It would be beneficial to the docs to create sections for different areas of the API. Appropriate names for the sections are already listed in the API, as at the top of the reference page is a table that has a 'Resource' column which would be perfect for this usage, and that table can remain at the root reference page so that devs can see at a glance what endpoints are in what section, then…
3 votesThis has been on the roadmap, and is planned for early 2021.
-
Modify Channel Information says "Query parameters" example post says JSON blob
https://dev.twitch.tv/docs/api/reference#modify-channel-information
The example calls uses JSON, but the documentation talks about Query String/URL encoded form.
Docs should cover both possibilities and examples should cover both methods
3 votes -
Embed documentation doesn't mention the SSL requirment
https://dev.twitch.tv/docs/embed/ and it's child pages mention the requirements for parent but never SSL
3 votes -
Change description of broadcaster_id in create clip
The description of the broadcaster_id inside of the Create Clip endpoint is very confusing because it states that this is the id of the stream but it really is the id of the broadcaster as the name suggests.
3 votes -
Wording on refreshing a token is confusing
https://dev.twitch.tv/docs/authentication#refreshing-access-tokens
"
How to Refresh
To refresh a token, you need an access token/refresh token pair coming from a body. For example:
"You need only the "refresh token" and "client secret"
You can lose the access token, and still get a new token if you have a refresh_token
3 votes -
Helper: viewer is misleading as the viewer object is populated on all views not just the channel page
https://dev.twitch.tv/docs/extensions/reference#helper-viewer
The Twitch.ext.viewer object is a collection of info about the twitch viewer that is watching the channel page where your extension is activated. It will only be populated if the viewer is logged in, and only after the `onAuthorized` callback has been called. Accessing its properties will otherwise return `null`.Should be
The Twitch.ext.viewer object is a collection of info about the twitch user that is watching the extension view.Or something, as the
viewerhelper object exists on all views!3 votes -
Get Broadcaster Subscriptions docs example incomplete
The Get Broadcast Subscriptions docs https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions was updated to include gifterid and giftername fields, but neither of these were added to the example.
Also, the example is erroneous because it shows the same user id for both broadcaster and subscriber, but they represent different usernames, which is impossible.
3 votes -
Helper: Actions - don't work in the rig
From: https://github.com/twitchdev/issues/issues/56
Brief description
Documentation describes that there are functions such as
followChannelandrequestIdSharebut the documentation doesn't mention that these functions don't work in the rig (at time of writing)https://dev.twitch.tv/docs/extensions/reference#helper-actions
Additional context or questions
https://discordapp.com/channels/504015559252377601/523676096277905419/676767529666084864
3 votes -
onPositionChanged still in docs
From: https://github.com/twitchdev/issues/issues/36
Brief description
https://dev.twitch.tv/docs/extensions/reference#helper-extensions
The JS helper/callback function
onPositionChangedis still documented but is no longer relevant post video component redesignExpected documentation
Section Should be removed
3 votes -
How to link out on a mobile extension
Twitch documentation does not state how to handle opening a new window on a mobile extension.
3 votes
- Don't see your idea?