From a52f6acba22e7789b6d6c0ae3c9bd6920c7ec3cf Mon Sep 17 00:00:00 2001 From: zkldi <20380519+zkldi@users.noreply.github.com> Date: Wed, 30 Mar 2022 04:28:19 +0100 Subject: [PATCH] These endpoints have never been used, and do not exist. --- docs/docs/api/routes/user-gamept.md | 98 ----------------------------- 1 file changed, 98 deletions(-) diff --git a/docs/docs/api/routes/user-gamept.md b/docs/docs/api/routes/user-gamept.md index 65dcd8115..328fe93c6 100644 --- a/docs/docs/api/routes/user-gamept.md +++ b/docs/docs/api/routes/user-gamept.md @@ -68,104 +68,6 @@ GET /api/v1/users/zkldi/games/iidx/SP ***** -## Retrieve a user's goals for this game + playtype. - -`GET /api/v1/users/:userID/games/:game/:playtype/goals` - -### Parameters - -| Property | Type | Description | -| :: | :: | :: | -| `unachieved` (Optional) | Presence | If present, only unachieved goals are returned. | - -### Response - -| Property | Type | Description | -| :: | :: | :: | -| `userGoals` | Array<UserGoalDocument> | The array of user-subscriptions to goals this user has. | -| `goals` | Array<GoalDocument> | The array of goal documents this user has a subscription to. | - -### Example - -#### Request -``` -GET /api/v1/users/zkldi/games/iidx/SP/goals -``` - -#### Response - -```js -{ - userGoals: [ - { - userID: 1, - goalID: "foobar", - progress: 4, - progressHuman: "CLEAR", - outOf: 5, - outOfHuman: "HARD CLEAR", - // ... so on - } - ], - goals: [ - { - goalID: "foobar", - title: "Hard Clear 5.1.1. SP ANOTHER", - // ... so on - } - ] -} -``` - -***** - -## Retrieve a user's milestones for this game + playtype. - -`GET /api/v1/users/:userID/games/:game/:playtype/milestones` - -### Parameters - -| Property | Type | Description | -| :: | :: | :: | -| `unachieved` (Optional) | Presence | If present, only unachieved milestones are returned. | - -### Response - -| Property | Type | Description | -| :: | :: | :: | -| `userMilestones` | Array<UserMilestoneDocument> | The array of user-subscriptions to milestones this user has. | -| `milestones` | Array<MilestoneDocument> | The array of milestone documents this user has a subscription to. | - -### Example - -#### Request -``` -GET /api/v1/users/zkldi/games/iidx/SP/milestones -``` - -#### Response - -```js -{ - userMilestones: [ - { - userID: 1, - milestoneID: "foobar", - // ... so on - } - ], - milestones: [ - { - milestoneID: "foobar", - title: "IIDX SP 9th Dan Milestone", - // ... so on - } - ] -} -``` - -***** - ## Search a user's personal bests. `GET /api/v1/users/:userID/games/:game/:playtype/pbs`