Skip to content

Some minor mistakes and typos in the docs #695

@DmitryScaletta

Description

@DmitryScaletta

Response code is 204 instead of 200

image

https://dev.twitch.tv/docs/api/reference#get-vips

Property name "reward" instead of "cost" like in the example

image

image

https://dev.twitch.tv/docs/api/reference#get-custom-reward-redemption

All other endpoints doesn't have Response Example if response is empty (204)

image
image

https://dev.twitch.tv/docs/api/reference#modify-channel-information
https://dev.twitch.tv/docs/api/reference#delete-custom-reward
https://dev.twitch.tv/docs/api/reference#delete-eventsub-subscription

Not full URL

Should be GET https://api.twitch.tv/helix/search/channels

image

https://dev.twitch.tv/docs/api/reference#search-channels

Missing GET method

Should be GET https://api.twitch.tv/helix/streams/key

image

https://dev.twitch.tv/docs/api/reference#get-stream-key

"URLs" instead of "URL"

In all other places it's "URL"

image

https://dev.twitch.tv/docs/api/reference#get-users-follows

"Request Body Fields" instead of "Request Body"

In all other places it's "Request Body"

image

https://dev.twitch.tv/docs/api/reference#update-drops-entitlements

"Required Query Parameters" instead of "Request Query Parameters"

In all other places it's "Request Query Parameters"

image

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

"Response codes" instead of "Response Codes" (with capital "C")

In all other places it's "Response Codes"

image

https://dev.twitch.tv/docs/api/reference#start-commercial
https://dev.twitch.tv/docs/api/reference#get-extension-analytics
https://dev.twitch.tv/docs/api/reference#get-game-analytics
https://dev.twitch.tv/docs/api/reference#get-bits-leaderboard
https://dev.twitch.tv/docs/api/reference#get-cheermotes

Missing "Example Request" header

image

https://dev.twitch.tv/docs/api/reference#get-soundtrack-playlists

"Example Request" is actually "Example Response"

image

https://dev.twitch.tv/docs/api/reference#get-vips

Incorrect table formatting

See #691

6 spaces instead of 3 that represents nested object

image

https://dev.twitch.tv/docs/api/reference#create-stream-marker

Table without header (thead tag). The head is just a regular row inside tbody

image

https://dev.twitch.tv/docs/api/reference#get-channel-information

Metadata

Metadata

Assignees

No one assigned

    Labels

    product: docsDocumentation on dev.twitch.tv/docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions