From d5b5f56a9001c20e5822785a05bcf146e58c1bff Mon Sep 17 00:00:00 2001 From: Nathan Arthur Date: Wed, 27 Aug 2025 11:32:53 -0400 Subject: [PATCH 1/4] document token routes --- src/api-v2.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/api-v2.md b/src/api-v2.md index a52a2b0..1af0864 100644 --- a/src/api-v2.md +++ b/src/api-v2.md @@ -29,12 +29,14 @@ Please reach out to support@taskratchet.com to get an API key. Base URL: -| Endpoint | Description | -| --------------- | --------------------- | -| `GET me` | Get your profile data | -| `DEL me` | Delete your account | -| `GET me/tasks` | Get all your tasks | -| `POST me/tasks` | Create a new task | +| Endpoint | Description | +| --------------- | ----------------------- | +| `GET me` | Get your profile data | +| `DEL me` | Delete your account | +| `GET me/tasks` | Get all your tasks | +| `POST me/tasks` | Create a new task | +| `POST me/token` | Reset your API v2 token | +| `GET me/token` | Get your API v2 token | ### `GET me` From e845d786a75469ddccd117ffa92ecbb3220230f2 Mon Sep 17 00:00:00 2001 From: Nathan Arthur Date: Wed, 27 Aug 2025 11:37:49 -0400 Subject: [PATCH 2/4] expand routes in api v2 docs --- src/api-v2.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/api-v2.md b/src/api-v2.md index 1af0864..0056ca1 100644 --- a/src/api-v2.md +++ b/src/api-v2.md @@ -31,14 +31,14 @@ Base URL: | Endpoint | Description | | --------------- | ----------------------- | -| `GET me` | Get your profile data | -| `DEL me` | Delete your account | -| `GET me/tasks` | Get all your tasks | -| `POST me/tasks` | Create a new task | -| `POST me/token` | Reset your API v2 token | -| `GET me/token` | Get your API v2 token | +| `GET /api2/me` | Get your profile data | +| `DEL /api2/me` | Delete your account | +| `GET /api2/me/tasks` | Get all your tasks | +| `POST /api2/me/tasks` | Create a new task | +| `POST /api2/me/token` | Reset your API v2 token | +| `GET /api2/me/token` | Get your API v2 token | -### `GET me` +### `GET /api2/me` | Response Field | Type | Description | | ------------------- | ------- | ----------------------------------------------------- | @@ -67,11 +67,11 @@ Example response: } ``` -### `DEL me` +### `DEL /api2/me` Deletes the user's account. This action is irreversible. -### `GET me/tasks` +### `GET /api2/me/tasks` Returns an array of tasks. This route is paginated. @@ -106,7 +106,7 @@ Example response: ] ``` -### `POST me/tasks` +### `POST /api2/me/tasks` Creates a new task. The request body should be a JSON object with the following fields:\ From 64a5118ffe1f6beac57b1f18a803c2c36842c3f5 Mon Sep 17 00:00:00 2001 From: Nathan Arthur Date: Wed, 27 Aug 2025 11:44:06 -0400 Subject: [PATCH 3/4] use full delete method name --- src/api-v2.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/api-v2.md b/src/api-v2.md index 0056ca1..2cbdf75 100644 --- a/src/api-v2.md +++ b/src/api-v2.md @@ -29,10 +29,10 @@ Please reach out to support@taskratchet.com to get an API key. Base URL: -| Endpoint | Description | -| --------------- | ----------------------- | +| Endpoint | Description | +| --------------------- | ----------------------- | | `GET /api2/me` | Get your profile data | -| `DEL /api2/me` | Delete your account | +| `DELETE /api2/me` | Delete your account | | `GET /api2/me/tasks` | Get all your tasks | | `POST /api2/me/tasks` | Create a new task | | `POST /api2/me/token` | Reset your API v2 token | @@ -67,7 +67,7 @@ Example response: } ``` -### `DEL /api2/me` +### `DELETE /api2/me` Deletes the user's account. This action is irreversible. From 24fcd9944247d36a9cca9e2f99db6d220f75d168 Mon Sep 17 00:00:00 2001 From: Nathan Arthur Date: Wed, 27 Aug 2025 11:50:27 -0400 Subject: [PATCH 4/4] document token routes --- src/api-v2.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/api-v2.md b/src/api-v2.md index 2cbdf75..357ab7c 100644 --- a/src/api-v2.md +++ b/src/api-v2.md @@ -132,3 +132,13 @@ Example response: "status": "pending" } ``` + +### `POST /api2/me/token` + +Reset your account's API v2 token. This will invalidate the old token and generate a new one. + +You'll need to be authenticted in order to reset your token. If you don't already have a token, contact support for help. + +### `GET /api2/me/token` + +Returns the current API v2 token for the authenticated user.