twitchdev / issues

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

Get Stream Tags: Example Response poor formatting #336

Closed deefdragon closed 3 years ago

deefdragon commented 3 years ago

Brief description The Example Response JSON is very poorly formatted, making it difficult to read and understand. Expected documentation

{
  "data": [
    {
      "tag_id": "621fb5bf-5498-4d8f-b4ac-db4d40d401bf",
      "is_auto": false,
      "localization_names": {
        "bg-bg": "Завършване без продължаване",
        "cs-cz": "Na jeden zátah",
        "da-dk": "1 Continue klaret",
        ...
      },
      "localization_descriptions": {
        "bg-bg": "За потоци с акцент върху завършване на аркадна игра с монети, в която не се използва продължаване",
        "cs-cz": "Pro vysílání s důrazem na plnění mincových arkádových her bez použití pokračování.",
        "da-dk": "Til streams med vægt på at gennemføre et arkadespil uden at bruge continues",
        ...
      }
    },
    {
      "tag_id": "79977fb9-f106-4a87-a386-f1b0f99783dd",
      "is_auto": false,
      "localization_names": {
        "bg-bg": "PvE",
        "cs-cz": "PvE",
        ...
      },
      "localization_descriptions": {
        "bg-bg": "За потоци с акцент върху PVE геймплей",
        "cs-cz": "Pro vysílání s důrazem na hratelnost \"hráč vs. prostředí\".",
        "da-dk": "Til streams med vægt på spil, hvor det er spilleren mod omgivelserne.",
        ...
      }
    }
  ]
}

Screenshots GetStreamTags

Additional context or questions https://dev.twitch.tv/docs/api/reference#get-stream-tags

jbulava commented 3 years ago

Formatting has been updated for Friday, as well as the description to be more accurate.