From 0c7e10ebc7782f696fddb5d4a70603c06e99be88 Mon Sep 17 00:00:00 2001 From: bigbass1997 Date: Mon, 16 Jun 2025 16:10:04 -0500 Subject: [PATCH 1/2] release-notes: Add documentation for the Release Notes API --- release-notes.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 release-notes.md diff --git a/release-notes.md b/release-notes.md new file mode 100644 index 0000000..f3ea9bf --- /dev/null +++ b/release-notes.md @@ -0,0 +1,26 @@ +# Toontown Rewritten Release Notes API + +## Requests + +All requests must be submitted via HTTP GET to `https://www.toontownrewritten.com/api` with one of the following endpoints. + +If you are frequently making calls to this API, we would appreciate it if you set a descriptive User-Agent. + +## GET `/releasenotes` + +Returns an array of `note` objects. + +| Name | Description | +|------|-------------| +| noteId | Identifier for the release note. | +| slug | Version number as a string, for example `ttr-live-v4.1.7d`. +| date | Date and time the note was published as a string, for example `April 20, 2025 at 5:25 AM`. + +## GET `/releasenotes/{noteId}` + +| Name | Description | +|------|-------------| +| noteId | Identifier for the release note. | +| slug | Version number as a string, for example `ttr-live-v4.1.7d`. +| date | Date and time the note was published as a string, for example `April 20, 2025 at 5:25 AM`. +| body | HTML contents of the release note as a string. From ac3ec146d8ac8f95e3fdc2e1c17ad8a4e562fad8 Mon Sep 17 00:00:00 2001 From: bigbass1997 Date: Mon, 16 Jun 2025 16:59:37 -0500 Subject: [PATCH 2/2] release-notes: Fix table formatting and improve response descriptions --- release-notes.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/release-notes.md b/release-notes.md index f3ea9bf..743d351 100644 --- a/release-notes.md +++ b/release-notes.md @@ -8,19 +8,29 @@ If you are frequently making calls to this API, we would appreciate it if you se ## GET `/releasenotes` -Returns an array of `note` objects. +Returns an array of all `note` objects, excluding the `body` field. | Name | Description | |------|-------------| | noteId | Identifier for the release note. | -| slug | Version number as a string, for example `ttr-live-v4.1.7d`. -| date | Date and time the note was published as a string, for example `April 20, 2025 at 5:25 AM`. +| slug | Version number as a string, for example `ttr-live-v4.1.7d`. | +| date | Date and time the note was published as a string, for example `April 20, 2025 at 5:25 AM`. | ## GET `/releasenotes/{noteId}` +Uses `noteId` to retrieve the corresponding `note` object. If no note is found, an `error` object is returned instead. + +### `note` Values + | Name | Description | |------|-------------| | noteId | Identifier for the release note. | -| slug | Version number as a string, for example `ttr-live-v4.1.7d`. -| date | Date and time the note was published as a string, for example `April 20, 2025 at 5:25 AM`. -| body | HTML contents of the release note as a string. +| slug | Version number as a string, for example `ttr-live-v4.1.7d`. | +| date | Date and time the note was published as a string, for example `April 20, 2025 at 5:25 AM`. | +| body | HTML contents of the release note as a string. | + +### `error` Values + +| Name | Description | +|------|-------------| +| error | `Unknown release note` |