change some field names in leaderboards-adjacent

This commit is contained in:
zkldi
2021-07-22 00:44:21 +01:00
parent eb987c2fce
commit c9e809f316
+6 -1
View File
@@ -687,7 +687,8 @@ GET /api/v1/users/zkldi/games/iidx/SP/most-played
| `above` | Array<UserGameStats> | Up to 5 users' game stats better than this user. |
| `below` | Array<UserGameStats> | Same as above, but below the user. |
| `users` | Array<UserDocument> | The user documents related to the above statistics. |
| `yourStats` | UserGameStats | The requested user's stats for this game. |
| `thisUsersStats` | UserGameStats | The requested user's stats for this GPT. |
| `thisUsersRanking` | {outOf: integer, ranking: integer} | The requested user's ranking for this GPT. |
### Example
@@ -737,6 +738,10 @@ GET /api/v1/users/zkldi/games/iidx/SP/leaderboard-adjacent
classes: {
dan: 5
}
},
thisUsersRanking: {
ranking: 2,
outOf: 3
}
}
```