Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs missing first/pagination on API's that support them #19

Closed
BarryCarlyon opened this issue Dec 16, 2019 · 3 comments
Closed

Docs missing first/pagination on API's that support them #19

BarryCarlyon opened this issue Dec 16, 2019 · 3 comments
Labels
product: docs Documentation on dev.twitch.tv/docs

Comments

@BarryCarlyon
Copy link
Contributor

Brief description

Many API's don't document that they support first and after

Expected 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 Videos

Missing Pagination in the Return Values

  • Get Broadcaster Subscriptions
  • Get Videos
@BarryCarlyon BarryCarlyon added the product: docs Documentation on dev.twitch.tv/docs label Dec 16, 2019
@JaielZeus
Copy link

Adding as well:
Some API's need to be quality checked for the descriptions of the parameters like the moderation API ones.

For example:

https://dev.twitch.tv/docs/api/reference/#get-banned-users
and
https://dev.twitch.tv/docs/api/reference/#get-moderators

have the same description text for the parameter that one gets as response

@Breci
Copy link

Breci commented Dec 16, 2019

@JaielSoft You should open a different ticket for your issue, it's not the same problem as the one mentioned on this issue

@jbulava
Copy link
Member

jbulava commented Mar 3, 2020

Moved to UserVoice as the preferred feedback method for docs: https://twitch.uservoice.com/forums/310213/suggestions/39847735

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product: docs Documentation on dev.twitch.tv/docs
Projects
None yet
Development

No branches or pull requests

4 participants