Max/zkldi_Tachi
1
0
Fork 0
mirror of https://github.com/zkldi/Tachi.git synced 2026-10-12 01:08:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

These endpoints have never been used, and do not exist.

Browse Source
This commit is contained in:
zkldi
2022-03-30 04:28:19 +01:00
parent f2ec474563
commit a52f6acba2
1 changed files with 0 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/api/routes/user-gamept.md
-98
View File
@@ -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`