From 84522fbb7a2da29ece2b4ad046395920c63fe01d Mon Sep 17 00:00:00 2001 From: Roberto Pastor Date: Mon, 26 Feb 2024 08:57:40 +0100 Subject: [PATCH 1/4] Updated docs json example --- docs/v1/get-console-ids.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/v1/get-console-ids.md b/docs/v1/get-console-ids.md index 719891d..1ad7802 100644 --- a/docs/v1/get-console-ids.md +++ b/docs/v1/get-console-ids.md @@ -50,7 +50,11 @@ const consoleIds = await getConsoleIds(authorization); ```json [HTTP Response] [ - { "ID": 1, "Name": "Mega Drive" } + { + "ID": 1, + "Name": "Mega Drive", + "IconURL": "https://static.retroachievements.org/assets/images/system/md.png" + } // ... ] ``` From 07b7e5161890ae2e74f6fe24e625efc328a71ce1 Mon Sep 17 00:00:00 2001 From: Wes Copeland Date: Mon, 26 Feb 2024 07:19:48 -0500 Subject: [PATCH 2/4] chore: format --- docs/v1/get-console-ids.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/v1/get-console-ids.md b/docs/v1/get-console-ids.md index 1ad7802..f8189bb 100644 --- a/docs/v1/get-console-ids.md +++ b/docs/v1/get-console-ids.md @@ -50,10 +50,10 @@ const consoleIds = await getConsoleIds(authorization); ```json [HTTP Response] [ - { - "ID": 1, - "Name": "Mega Drive", - "IconURL": "https://static.retroachievements.org/assets/images/system/md.png" + { + "ID": 1, + "Name": "Mega Drive", + "IconURL": "https://static.retroachievements.org/assets/images/system/md.png" } // ... ] From afab44b0172e24c5817bbc02b315eac9bb14818c Mon Sep 17 00:00:00 2001 From: Roberto Pastor Date: Thu, 29 Feb 2024 15:46:54 +0100 Subject: [PATCH 3/4] Updated API_GetConsoleIDs to reflect latest changes --- docs/v1/get-console-ids.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/v1/get-console-ids.md b/docs/v1/get-console-ids.md index f8189bb..1d83b43 100644 --- a/docs/v1/get-console-ids.md +++ b/docs/v1/get-console-ids.md @@ -20,10 +20,12 @@ The systems list can be found by selecting the "Games" menu from the site navbar ### Query Parameters -| Name | Required? | Description | -| :--- | :-------- | :---------------- | -| `z` | Yes | Your username. | -| `y` | Yes | Your web API key. | +| Name | Required? | Description | +| :--- | :-------- | :----------------------------------------------------------------------- | +| `z` | Yes | Your username. | +| `y` | Yes | Your web API key. | +| `a` | | If 1, only return active systems. Defaults to 0. | +| `g` | | If 1, only return gaming systems (not Hubs, Events, etc). Defaults to 0. | ## Client Library @@ -53,7 +55,9 @@ const consoleIds = await getConsoleIds(authorization); { "ID": 1, "Name": "Mega Drive", - "IconURL": "https://static.retroachievements.org/assets/images/system/md.png" + "IconURL": "https://static.retroachievements.org/assets/images/system/md.png", + "Active": true, + "IsGameSystem": true } // ... ] From 546dc96a397455f0858b13648f9d8d2b092663cd Mon Sep 17 00:00:00 2001 From: Roberto Pastor Date: Thu, 29 Feb 2024 16:00:56 +0100 Subject: [PATCH 4/4] Revert "Updated API_GetConsoleIDs to reflect latest changes" This reverts commit afab44b0172e24c5817bbc02b315eac9bb14818c. --- docs/v1/get-console-ids.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/v1/get-console-ids.md b/docs/v1/get-console-ids.md index 1d83b43..f8189bb 100644 --- a/docs/v1/get-console-ids.md +++ b/docs/v1/get-console-ids.md @@ -20,12 +20,10 @@ The systems list can be found by selecting the "Games" menu from the site navbar ### Query Parameters -| Name | Required? | Description | -| :--- | :-------- | :----------------------------------------------------------------------- | -| `z` | Yes | Your username. | -| `y` | Yes | Your web API key. | -| `a` | | If 1, only return active systems. Defaults to 0. | -| `g` | | If 1, only return gaming systems (not Hubs, Events, etc). Defaults to 0. | +| Name | Required? | Description | +| :--- | :-------- | :---------------- | +| `z` | Yes | Your username. | +| `y` | Yes | Your web API key. | ## Client Library @@ -55,9 +53,7 @@ const consoleIds = await getConsoleIds(authorization); { "ID": 1, "Name": "Mega Drive", - "IconURL": "https://static.retroachievements.org/assets/images/system/md.png", - "Active": true, - "IsGameSystem": true + "IconURL": "https://static.retroachievements.org/assets/images/system/md.png" } // ... ]