Max/zkldi_Tachi
1
0
Fork 0
mirror of https://github.com/zkldi/Tachi.git synced 2026-09-28 09:58:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for rankingDat

Browse Source
This commit is contained in:
zkldi
2021-09-02 16:06:48 +01:00
parent a9e361e325
commit e9cbb6d6eb
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/api/routes/user-gamept.md
+13 -3
View File
@@ -20,7 +20,7 @@ None.
| `firstScore` | ScoreDocument or Null | The user's first score for this game + playtype. This is null if the user has no scores with timestamps. |
| `mostRecentScore` | ScoreDocument or Null | The user's most recent score. This is null if the user has no scores with timestamps. |
| `totalScores` | integer | The total amount of scores this user has. |
| `rankingData` | { ranking: integer, outOf: integer } | The position of this player on the default leaderboards for this game, and how many players it is out of. |
| `rankingData` | Record<Rating Algorithm, { ranking: integer, outOf: integer }> | The position of this player on the default leaderboards for this game, and how many players it is out of. |
### Example
@@ -48,8 +48,18 @@ GET /api/v1/users/zkldi/games/iidx/SP
mostRecentScore: null,
totalScores: 5,
rankingData: {
ranking: 3,
outOf: 18
ktRating: {
ranking: 3,
outOf: 18
}
ktLampRating: {
ranking: 2,
outOf: 18
},
BPI: {
ranking: 5,
outOf: 18
}
}
}
```