Merge branch 'main' into ulids-docs

Author: wescopeland

docs/v1/get-achievement-of-the-week.md

@@ -80,8 +80,8 @@ if (response is NetworkResponse.Success) {
     "Type": null,
     "Author": "StingX2",
     "AuthorULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
-    "DateCreated": "2021-10-16 23:53:32",
-    "DateModified": "2021-10-17 19:26:09"
+    "DateCreated": "2021-10-16",
+    "DateModified": "2021-10-17"
   },
   "Console": {
     "ID": 3,

docs/v1/get-game-extended.md

@@ -22,7 +22,6 @@ Most of this data can be found on the game page, for example, [Sonic the Hedgeho
 
 | Name | Required? | Description                                                       |
 | :--- | :-------- | :---------------------------------------------------------------- |
-| `z`  | Yes       | Your username.                                                    |
 | `y`  | Yes       | Your web API key.                                                 |
 | `i`  | Yes       | The target game ID.                                               |
 | `f`  |           | Defaults to 3. Set to 5 to see Unofficial / demoted achievements. |
@@ -87,9 +86,9 @@ if (response is NetworkResponse.Success) {
   "Publisher": "",
   "Developer": "",
   "Genre": "",
-  "Released": "1992-06-02 00:00:00",
+  "Released": "1992-06-02",
   "ReleasedAtGranularity": "day",
-  "IsFinal": 0,
+  "IsFinal": false, // this field is deprecated, and will always return false
   "RichPresencePatch": "cce60593880d25c97797446ed33eaffb",
   "GuideURL": null,
   "Updated": "2023-12-27T13:51:14.000000Z",

docs/v1/get-game-info-and-user-progress.md

@@ -18,7 +18,6 @@ You must query the user by either their username or their ULID. Please note the
 
 | Name | Required? | Description                                                        |
 | :--- | :-------- | :----------------------------------------------------------------- |
-| `z`  | Yes       | Your username.                                                     |
 | `y`  | Yes       | Your web API key.                                                  |
 | `u`  |           | The target username or ULID.                                       |
 | `g`  | Yes       | The target game ID.                                                |
@@ -94,7 +93,7 @@ if (response is NetworkResponse.Success) {
   "Genre": "",
   "Released": "1992-06-02 00:00:00",
   "ReleasedAtGranularity": "day",
-  "IsFinal": 0,
+  "IsFinal": false, // this field is deprecated, and will always return false
   "RichPresencePatch": "cce60593880d25c97797446ed33eaffb",
   "GuideURL": null,
   "ConsoleName": "Mega Drive",

docs/v1/get-user-profile.md

@@ -20,10 +20,13 @@ This information can be found near the top of [any user page](https://retroachie
 
 ### Query Parameters
 
-| Name | Required? | Description          |
-| :--- | :-------- | :------------------- |
-| `y`  | Yes       | Your web API key.    |
-| `u`  | Yes       | The target username. |
+You must query the user by either their username or their ULID. Please note the username is not considered a stable value. As of 2025, users can change their usernames. Initially querying by username is a good way to fetch a ULID.
+
+| Name | Required? | Description             |
+| :--- | :-------- | :---------------------- |
+| `y`  | Yes       | Your web API key.       |
+| `u`  |           | The target username.    |
+| `i`  |           | The target user's ULID. |
 
 ## Client Library
 
@@ -74,6 +77,7 @@ if (response is NetworkResponse.Success) {
 ```json [HTTP Response]
 {
   "User": "MaxMilyin",
+  "ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
   "UserPic": "/UserPic/MaxMilyin.png",
   "MemberSince": "2016-01-02 00:43:04",
   "RichPresenceMsg": "Playing ~Hack~ 11th Annual Vanilla Level Design Contest, The",
@@ -94,6 +98,7 @@ if (response is NetworkResponse.Success) {
 ```json [NodeJS]
 {
   "user": "MaxMilyin",
+  "ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
   "userPic": "/UserPic/MaxMilyin.png",
   "memberSince": "2016-01-02 00:43:04",
   "richPresenceMsg": "Playing ~Hack~ 11th Annual Vanilla Level Design Contest, The",

docs/v1/get-user-summary.md

@@ -179,7 +179,8 @@ if (response is NetworkResponse.Success) {
     "Publisher": "Falcon",
     "Developer": "Falcon",
     "Genre": "2D Platforming, Arcade",
-    "Released": "1981",
+    "Released": "1981-01-01",
+    "ReleasedAtGranularity": "year",
     "IsFinal": 0
   },
   "UserPic": "/UserPic/xelnia.png",