84 results found
-
Docs missing first/pagination on API's that support them From: https://github.com/twitchdev/issues/issues/19
Brief description
Many API's don't document that they support
firstandafterExpected documentation
Document first/after in the optional query parameters
Additional context or questions
Missing First in
Optional Query Parameters
- Get Banned Users
- Get Moderators
- Get Moderator Events
- Get Broadcaster Subscriptions
- Get VideosMissing Pagination in the
Return Values
- Get Broadcaster Subscriptions
- Get Videos8 votes -
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 -
Remove jQuery from extension examples https://dev.twitch.tv/docs/extensions/reference#javascript-helper
Change
window.Twitch.ext.onAuthorized(function(auth) {
$.ajax({
url: '/<some backend path>',
type: 'GET',
headers: {
'x-extension-jwt': auth.token,
}
});
});to using fetch, or STATE it's a jQuery example
1 voteWe’ve updated the examples to use fetch vs. jQuery.
-
Bad Code examples twitch.ext https://dev.twitch.tv/docs/extensions/reference#javascript-helper
Every since refernce to each function is
twitch.ext
This ASSUMES the developer has cast
var twitch = window.Twitchsomewhere.
It would be more clear if each code reference didwindow.Twitch.ext
instead, or mention that
twitchis a variable expected to be cast by the developerThere is also some inconsistency where twitch.ext and window.Twitch.ext are used inchangably
1 vote -
missing space missing a space on last line
1 vote -
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 -
Get Subscriptions Endpoint description is ambiguous The Documentation for the Get Broadcaster Subscriptions Endpoint has a description of
Get all of a broadcaster’s subscriptions.- This is ambiguous and sounds like it returns the Subscriptions to other channels a Broadcaster has whereas it returns the users that subscribed to the broadcaster.I would suggest changing the description to say
Get all of a broadcaster’s subscribers.instead.2 votes -
Authentication for oAuth is unclear https://dev.twitch.tv/docs/authentication/getting-tokens-oauth
Both Implicit code flow and authorization code flow label the first step as a "HTTP GET" instead of "this is a link that you need to put on a page for the user you wish to authenticate" or "you need to redirect the user to this page"
Too many people are trying to curl/fetch the URL as the docs seem to label it as a HTTP GET request
2 votes -
Missing info In step2, it says nothing about:
--header 'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
It is in a different page, what describe how to get your app id. Should be linked or copy that info to here.1 vote -
Authorization types and how to get them isn't clear Please pleas please provide a link or something leading to this documentation: https://dev.twitch.tv/docs/authentication/getting-tokens-oauth#oauth-client-credentials-flow
I spent a while trying to figure out how to get a Bearer authorization with no luck, I feel like it should be shown how to do on this page.
1 vote -
Extensions package.json HTTPS env variable update In the section for using create-react-app and providing the environment variables for the start script, these docs state using "HTTPS=on". It should be "HTTPS=true" though.
1 vote -
Entitlements Webhook Docs On the Drops 2.0 documentation it states "When a viewer claims a Drop, you can call the Entitlements API to get viewer entitlement data using webhooks. " Yet there are no references to a Webhook Topic for the Get Entitlements endpoint.
Either the Drops 2.0 page is erroneous and there is no webhook, or the Webhook Reference page needs to be updated to include that topic.
1 vote -
Embedded Experiences Requirements - needs spacing on the bullet points The documentation on
https://dev.twitch.tv/docs/embed/
for "Embedded Experiences Requirements" is badly formatted
1 vote -
Documentation layout when scrolling You scroll to the right this happens:
1 vote -
4 votes
-
Some Typos on "The New API" Documentation Hello,
Searching in the documentation of the new API I have found these four small errors. They are not at all severe, but they should be remedied in order to facilitate the use of the API.
- https://dev.twitch.tv/docs/api/reference#get-extension-transactions => Link bad rendered in Markdown
- https://dev.twitch.tv/docs/api/reference#get-bits-leaderboard => typo on OAuth Token, missing O
- https://dev.twitch.tv/docs/api/reference#redeem-code => method missing
- https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions => Scope in wrong format (not labeled)
2 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.
-
Deprecated attribute frameborder is deprecated, shouldn't suggest in docs
1 vote -
Get All Chat Emoticons From: https://github.com/twitchdev/issues/issues/10
Brief description
Docs state the "images" is an array
{
"links": {
"self": "http://api.twitch.tv/kraken/chat/emoticons"
},
"emoticons": [
{
"id": 115390,
"regex": "TwitchLit",
"images": [
{
"width": 28,
"height": 28,
"url": "https://static-cdn.jtvnw.net/jtvuserpictures/emoticon-115390-src-b577ded8522fc1a1-28x28.png",
"emoticonset": 19151
}
]
},
{
"id": 80393,
"regex": "Kappa",
"images": [
{
"width": 28,
"height": 28,
"url": "https://static-cdn.jtvnw.net/jtv_user_pictures/emoticon-80393-src-cf7c8d03a4c5cb75-28x28.png",
"emoticon_set": 15940
}
]
}
]
}Expected documentation
…{ "_links": { "self": "http://api.twitch.tv/kraken/chat/emoticons" }, "emoticons": [ { "id": 115390, "regex": "TwitchLit", "images": { "width": 28, "height": 28, "url": "https://static-cdn.jtvnw.net/jtv_user_pictures/emoticon-115390-src-b577ded8522fc1a1-28x28.png", "emoticon_set": 19151 } }, { "id": 80393, "regex": "Kappa",4 votes -
Next Steps Typo There is a typo at the botton of this page
It says @TwitchDevon Twitter instead of @TwitchDev on Twitter :)
1 vote
- Don't see your idea?