173 results found
-
Update References to v5 API There are reference to V5 API here to get user and channel ID.
Combined with the GitHub Sample at https://github.com/twitchdev/pubsub-javascript-sample that is still using it this is very confusing to get to work.
Suggest to update the sample and this article to reference the helix APIs instead.4 votes -
Publish Official Typescript Typing's for all Data Models It would be very easy to build and design for if there were official typing for all data endpoints. The data between all the different API's for the same data isn't consistent, and with event sub, since it no longer relies on the underlying Helix endpoint, that data can now be different too. This will also mitigate typos on the docs which causes huge headaches when trying to code for API responses and the data not working, or missing fields. The typing can specify which fields are required and which are optional, so when designing your app, you can easily…
4 votes -
Document how join and authentication limits apply to anonymous connections. https://dev.twitch.tv/docs/irc/guide#command--message-limits says:
- 20 authenticate attempts per 10 seconds per user (200 for verified bots)
- 20 join attempts per 10 seconds per user (2000 for verified bots)however it's unclear how these limits apply to anonymous connections. Is there no limit to join attempts at all when you have authenticated as an anonymous user? And do authentication attempts for anonymous users (NICK justinfan12345) count towards the rate limit?
4 votes -
Capabilities sub pages no clear capability needed It should be more obvious that
Twitch IRC: Commandsneeds the commands capability,Twitch IRC: Tagsneeds the tags capability, Membership page needs the membership capability.IE:
Literally add a paragraph at the top to the effect of
The Twitch IRC responses outlined on this page requires the connection to have requested the $whatever capability as outlined on the https://dev.twitch.tv/docs/irc/guide#twitch-irc-capabilities Capabilities section of the guide.
4 votes -
anonsubgift, anonsubmysterygift, anongiftpaidupgrade are documented but never occur https://dev.twitch.tv/docs/irc/tags#usernotice-twitch-tags documents anonsubgift and anongiftpaidupgrade. I found this announcement post https://discuss.dev.twitch.tv/t/anonymous-sub-gifting-to-launch-11-15-launch-details/18683 saying that apparently it was temporarily disabled as a workaround. As far as I can tell to this day the workaround is used. The documentation should be updated to remove the originally planned but never put into service types, and instead document that anonymous gifts come from AnAnonymousGifter.
4 votes -
Remove jQuery from the GA Example The examples for Google Analytics suggest using jQuery. Which is extra bloat if an extension hasn't use jQuery to start with and can lead to confusion
4 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 -
don't assume gender of viewers in documentation Extensions Manager Overview -> Capabilities -> Request Identity Link
Description refers to viewer as a male ('his'). This is likely to offend some people?
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 -
correct Content-Type to Content-Length This page has this line
"Your response must return a 200 status code, the response body must contain the raw challenge value, and you must set the Content-Type response header to the length of the challenge value. If successful, your subscription is enabled."
I have assumed that this is meant to say "Content-Length" rather than "Content-Type", because using the challenge length as a Content-Type is not a valid content type.
3 votes -
Add keyboard shortcut for docs search A lot of dev docs sites have a shortcut like ctrl+k or / for focusing the search box. It'd be nice if this was implemented
3 votes -
Wrong documentation about python webserver port In the section "HTTPS on localhost: the easy way" it says to launch python webserver with command: "python3 -m http.server", but this will launch it on port 8000, not 8080 like it says in the next sentence:
Then, change your base URI in the Asset Hosting page of your control panel from https://localhost:8080 to http://localhost:8080.
3 votes -
Potential syntax error? Just under the Step 4 header, on line 11 of the code, the html tags open with '<tr><th>' and end with '</td></tr>' and I'm wondering if it's meant to be '</th></tr>' ? if not that's no issue, I'm not the most used to HTML, it just seems odd that it would close with a different tag without an explanation.
3 votes -
Adjust line number for referenced code I think that the Twitch Extension Helper Library is embedded on line 43 of config.html rather than line 10.
3 votes -
API status page is gated by Atlassian login? Hey Twitch team -- the Twitch API "status page" link at the bottom of the page at https://dev.twitch.tv/docs/api/guide/#twitch-api-health currently links to a login-gated Atlassian page.
I tried using my work's Atlassian account, but even with that, I can't view the Twitch API health page.
Any way to make it publicly accessible?
3 votes -
Missing JSON field for refresh token If successful, the refresh token response includes a expires_in value. that is not shown in the example and is a very useful field.
3 votes -
Scope missing - channel:send:events Missing documentation for channel:send:events scope.
3 votes -
Next Step Button Hello guys, I can understand that documentation is boring but it brings a lot benefits on the long term. So please think about those two suggestions:
1) In your 101 tutorials page for example. Add an next page button.
2) Typos are made i know. I do it myself. But before publishing your guide check for typos - its your production environment. people can see this.Cheers
Patrick3 votes
- Don't see your idea?