83 results found
-
Deprecated attribute frameborder is deprecated, shouldn't suggest in docs
1 vote -
Get users doesn't mention that an App Access Token works https://dev.twitch.tv/docs/api/reference#get-users
Mentions User OAuth and the optional scope, but doesn't mention that you can use an app access token for this endpoint to get "public" data.
Authentication User OAuth Token Optional scope: user:read:email If this scope is provided, the response includes the user’s email address.Should probably read
Authentication - App Access Token - User OAuth Token any/no scopes - User OAuth Token with scope: user:read:email response includes the user’s email address.7 votes -
Typo in docs On page:
https://dev.twitch.tv/docs/extensions/reference#helper-bitsThe 'onTransactionComplete' fields list 'transactionID' (capital D), but you get "undefined" when accessing with capital D. Actual field is 'transactionId'.
A small change, but tripped me up a bit during implementation.
Thanks!
1 vote -
links no-longer clickable The procedures are no longer clickable at https://dev.twitch.tv/docs/authentication#getting-tokens.
(for a clickable reference see https://web.archive.org/web/20191220122144/https://dev.twitch.tv/docs/authentication)
5 votes -
Missing/incorrect description scopes for GET Helix/Users https://dev.twitch.tv/docs/api/reference#get-users
user:read:email disappeared and user:edit:broadcast now has the email scope's description.
2 votesThis error has been corrected, thanks.
-
Docs don't mention Token Type Similar to
All documentation should be revised to describe which kind of token and depending on token type what scopes are needed to call each endpoint.
The documentation for the most part only mentions a scope and doesn't describe what kind of token to use
2 votes -
Document correction for helix moderators endpoint https://dev.twitch.tv/docs/api/reference#get-moderators Under optional parameter for user_id the description says for users who are banned in this channel for the moderators endpoint.
6 votes -
Documentation not updated for oAuth changes on Helix As per
https://discuss.dev.twitch.tv/t/requiring-oauth-for-helix-twitch-api-endpoints/23916
None of the documentation is updated to reflect this change.
Yes it's not required yet. But it's good practice for new developers to be using the new oAuth procedure now
4 votes -
IRC NAMES command only ever returns self The IRC documentation states
List current chatters in a channel. If there are more than 1000 chatters in a room, NAMES return only the list of operator privileges currently in the room.
In my testing, I have only ever gotten Twitch to return my own username, even (only) in small (under 1K) rooms.
[@] :eggdroptest.tmi.twitch.tv 353 eggdroptest = #superscientistjhrek :eggdroptest
For example, that room usually has 15-30 chatters (in this case, there were 23 people in it), and several mods, but no names other than my own were returned as part of the 353 message.My suspicion is that perhaps…
1 vote -
4 votes
-
Thanks This is really very cool. Thank you for taking the time to create such awesome documentation. I am a front end dev for a well know travel website and I appreciate the effort that goes into making this.
1 voteThank you very much!
-
fix misleading descriptions This documentation isn't clear enough, it implies that the ID attribute should be set to the channel name, but for whatever reason it has to be set to 'chat_embed' and then the channel name goes in the SRC URL, replacing the 'hebo' text. There's no description of how the 'src' attribute should be presented so this isn't immediately clear.
1 vote -
My "documention idea" is that the documentation has a text formatting bug https://i.gyazo.com/76d10ed7c987ed262276501e25231ac6.png
"
WWW-Authenticate header" vs "WWW-Authenticateheader"EDIT: Another bug here https://dev.twitch.tv/docs/api/webhooks-reference#subscribe-tounsubscribe-from-events
"...if the parameters supplied are you receive an immediate..."
Reads like there should be something after "are".
1 vote -
Documentation Scopes Page missing moderation:read The scopes page on Authentication(https://dev.twitch.tv/docs/authentication/#scopes)
is missing the documented scope from the Helix Get Moderators
Returns all moderators in a channel.
Authorization
Requires OAuth Scope: moderation:read2 votes -
Example/URL is incomplete https://dev.twitch.tv/docs/api/reference/#get-extension-transactions
Unlike other documentation, https://api.twitch.tv/ is omitted from the URL and the example call
2 votes -
Webhooks limits: ambiguous From: https://github.com/twitchdev/issues/issues/65
Brief description
https://dev.twitch.tv/docs/api/webhooks-guide
Limits: By default, each client ID can have at most 10,000 subscriptions. Also, you can subscribe to the same topic at most 3 times.
Seems to be ambiguous to a lot of developers, they seem to think the that "3 times" means they can renew it 3 times then they are SOOL
Expected documentation
Limits: Each client ID can have at most 10,000 subscriptions. Where you can have 3 active subscriptions to a topic at the same time. Where an active subscription is defined as a topic/callback pair.
4 votes -
Missing scope From: https://github.com/twitchdev/issues/issues/63
Brief description
The channel:read:redemptions scope is required by the Channel Points PubSub topic (https://dev.twitch.tv/docs/pubsub#topics) but not mentioned in the scopes overview (https://dev.twitch.tv/docs/authentication#scopes)Expected documentation
The channel:read:redemptions listed on the overview page (https://dev.twitch.tv/docs/authentication#scopes)7 votes -
Extension viewer Session Token From: https://github.com/twitchdev/issues/issues/51
Brief description
https://dev.twitch.tv/docs/extensions/reference#helper-viewer
documentation wrong:
sessionToken Twitch.ext.viewer.isLinked: string The encoded JWT. This is the same as the token property of the authData parameter that currently gets passed to the onAuthorized callback.Expected documentation
sessionToken Twitch.ext.viewer.sessionToken: string The encoded JWT. This is the same as the token property of the authData parameter that currently gets passed to the onAuthorized callback.3 votesCorrected for today’s deployment
-
Get Broadcaster Subscriptions with an App Access Token From: https://github.com/twitchdev/issues/issues/45
Brief description
Get Broadcaster Subscriptions doesn't describe how you can use an "App Access Token" for an extension that has sub status enabled, to use the end point
Expected documentation
Describe that an "Extension App Access token" can be used when a broadcaster has granted the "channel:read:subscriptions" scope via the Twitch Extension Manager
3 votesAdded to today’s documentation deployment
-
Config Service links to wrong reference From: https://github.com/twitchdev/issues/issues/40
Brief description
https://dev.twitch.tv/docs/extensions/building/#using-the-configuration-service
Mentions "twitch api reference" but the config service endpoints are on in the Extension Reference
For extension examples that leverage the configuration service see the new Twitch API Reference. Also, see these repositories:
Expected documentation
Links to
https://dev.twitch.tv/docs/api/referencebut the configuration API is documentedhttps://dev.twitch.tv/docs/extensions/reference#set-extension-required-configuration3 votes
- Don't see your idea?