twitchdev / issues

Issue tracker for third party developers.
Apache License 2.0
74 stars 6 forks source link

Invalid JSON result in Get Streams examples #289

Closed freaktechnik closed 3 years ago

freaktechnik commented 3 years ago

Brief description The examples for "Get Streams" contain invalid JSON that suggests tags are not returned as part of the stream object.

Expected documentation

Example Response 1 should be:

{
  "data": [
    {
      "id": "26007494656",
      "user_id": "23161357",
      "user_name": "LIRIK",
      "game_id": "417752",
      "type": "live",
      "title": "Hey Guys, It's Monday - Twitter: @Lirik",
      "viewer_count": 32575,
      "started_at": "2017-08-14T16:08:32Z",
      "language": "en",
      "thumbnail_url": "https://static-cdn.jtvnw.net/previews-ttv/live_user_lirik-{width}x{height}.jpg",
      "tag_ids":  [
        "6ea6bca4-4712-4ab9-a906-e3336a9d8039"
      ]
    },
    ...
  ],
  "pagination": {
    "cursor": "eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6MjB9fQ=="
  }
}

and Example Response 2 should be:

{
  "data": [
    {
      "id": "26007351216",
      "user_id": "7236692",
      "user_name": "BillyBob",
      "game_id": "29307",
      "game_name": "Path of Exile",
      "type": "live",
      "title": "[Punday Monday] Necromancer - Dan's First Character - Maps - !build",
      "viewer_count": 5723,
      "started_at": "2017-08-14T15:45:17Z",
      "language": "en",
      "thumbnail_url": "https://static-cdn.jtvnw.net/previews-ttv/live_user_dansgaming-{width}x{height}.jpg",
      "tag_ids":  [
        "6ea6bca4-4712-4ab9-a906-e3336a9d8039"
      ]
    },
    ...
   ],
   "pagination": {
     "cursor": "eyJiIjp7Ik9mZnNldCI6MH0sImEiOnsiT2Zmc2V0Ijo0MH19"
   }
}

Screenshots

image

image

Additional context or questions

As a minor detail, the indents are also wrong (corrected in my blocks above).

lleadbet commented 3 years ago

Ticketed as DXDOC-347.

lleadbet commented 3 years ago

This has been completed, so closing the ticket.