From c9e809f3168b03efc978a37ba50ec59ba841b704 Mon Sep 17 00:00:00 2001 From: zkldi Date: Thu, 22 Jul 2021 00:44:21 +0100 Subject: [PATCH] change some field names in leaderboards-adjacent --- docs/docs/api/routes/user-gamept.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/docs/api/routes/user-gamept.md b/docs/docs/api/routes/user-gamept.md index c362c310b..8f43d1ca0 100644 --- a/docs/docs/api/routes/user-gamept.md +++ b/docs/docs/api/routes/user-gamept.md @@ -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 } } ``` \ No newline at end of file