81 results found
-
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 -
Locales/language valid options From: https://github.com/twitchdev/issues/issues/31
Brief description
The documentation doesn't advise anything regarding what languages/localses exist/are valid to be called.
For example
https://dev.twitch.tv/docs/api/reference#get-streams
has a
languagequery string argument, but doesn't advise what is valid for a langauge.Expected documentation
Document the list of locales of if it matches a ISO, update documentation on endpoints using language/locale with a note about what is valid
Additional context or questions
Raised/queried on discord
https://discordapp.com/channels/504015559252377601/523675960797691915/664243349309620225
3 votes -
[TYPO] EventSub channel.update docs Channel Update Notification Example states both
user_idanduser_nameare returned, when actually it returnsbroadcaster_user_idandbroadcaster_user_nameRef: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelupdate
2 votes -
Twitch-Notification-Id header documentation The documentation mentions "a unique ID" that is included with each notification, but doesn't mention the header name.
The page should add documentation for the "Twitch-Notification-Id" header.
2 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 -
PubSub examples need to be updated for multi_month_duration The pubsub examples need to be extended for the new multi month gifting
2 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.
-
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 -
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 -
Disambiguate the "Legacy" API in documentation This page should mention that "v5" and the "kraken" api refer to the same thing. Me and my friends always used "Kraken" to refer to this api, it's in the endpoint its self.
I'm sure we are not alone in this, please mention that v5 IS the Kraken endpoint, you should even rename the side-section to say "Legacy Twitch API v5 (Kraken)"
1 vote -
Please revert the EventSub documentation format changes You changed the EventSub documentation between last night (Nov 16, 2021) and today (Nov 17, 2021). The new documentation is very confusing. Specifically speaking:
- The Subscription Types documentation links on the left side are out of order and like-kind events are not next to each other. For example, "Redemption Status Update" should be next to "Channel Points redeem reward".
- The Subscription Types are poor named, and it's a little difficult to figure out which Subscription Type goes to which event.
- The URL to go straight to the section in the Subscription Types is different from the type supplied in an…
1 vote -
dimensionn There's a typo under mobile guidelines:
"dimensionn"1 vote -
broken link the register your app link is broken
it's https://dev.twitch.tv/dashboard/apps/create
but should be
https://dev.twitch.tv/console/apps/create1 vote -
missing scopes Scope list says it's comprehensive, but it does not include user:read:email which is listed in some other docs.
1 vote -
Link Scope API with capabilities Hello Twitch !
Can you please add links to api capabilities on each scope ? It would be very useful :-)Best regards
LMD1 vote -
possible grammatical change on page https://dev.twitch.tv/docs/pubsub
"These example applications share a common pattern: on application load, the application fetches a complete snapshot of its state and uses a PubSub connection to receive updates to this state. The updates act as “diffs” to the initial state."
Unsure it's stated correctly as PubSub is the model but not the connection. The connection protocol is WebSocket. Should possibly read:
"These example applications share a common pattern: on application load, the application fetches a complete snapshot of its state and uses a WebSocket connection to receive updates to this state. The updates act as “diffs” to the…1 vote -
Don't mention NPM Under "Run the Chatbot Locally", npm comes with node.js. Saying to install both can be confusing when there is no download option for npm.
1 voteThanks for mentioning this! We’ve updated the instructions for today’s docs deployment.
- Don't see your idea?