From b318fa44dca6e5f37ce0cbb68b8c3acdb55c4b37 Mon Sep 17 00:00:00 2001 From: zkldi <20380519+zkldi@users.noreply.github.com> Date: Thu, 27 Oct 2022 19:28:47 +0100 Subject: [PATCH] refactor: rename score-leaderboard to PB leaderboard --- .../dashboard/games/_game/_playtype/GPTLeaderboardsPage.tsx | 4 ++-- .../games/_game/_playtype/rivals/RivalsComparePage.tsx | 4 ++-- docs/docs/api/routes/gpt.md | 6 +++--- .../server/router/api/v1/games/_game/_playtype/router.ts | 4 ++-- .../v1/users/_userID/games/_game/_playtype/rivals/router.ts | 6 +++--- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/client/src/app/pages/dashboard/games/_game/_playtype/GPTLeaderboardsPage.tsx b/client/src/app/pages/dashboard/games/_game/_playtype/GPTLeaderboardsPage.tsx index 8f859eea4..0328efefd 100644 --- a/client/src/app/pages/dashboard/games/_game/_playtype/GPTLeaderboardsPage.tsx +++ b/client/src/app/pages/dashboard/games/_game/_playtype/GPTLeaderboardsPage.tsx @@ -41,7 +41,7 @@ export default function GPTLeaderboardsPage({ game, playtype }: GamePT) { - Score Leaderboards + PB Leaderboards @@ -53,7 +53,7 @@ export default function GPTLeaderboardsPage({ game, playtype }: GamePT) { )} diff --git a/client/src/app/pages/dashboard/users/games/_game/_playtype/rivals/RivalsComparePage.tsx b/client/src/app/pages/dashboard/users/games/_game/_playtype/rivals/RivalsComparePage.tsx index d9245297a..a8a70cba0 100644 --- a/client/src/app/pages/dashboard/users/games/_game/_playtype/rivals/RivalsComparePage.tsx +++ b/client/src/app/pages/dashboard/users/games/_game/_playtype/rivals/RivalsComparePage.tsx @@ -65,8 +65,8 @@ export default function RivalsComparePage({ diff --git a/docs/docs/api/routes/gpt.md b/docs/docs/api/routes/gpt.md index 9064deeb8..52db8ee9b 100644 --- a/docs/docs/api/routes/gpt.md +++ b/docs/docs/api/routes/gpt.md @@ -507,9 +507,9 @@ GET /api/v1/games/bms/7K/tableID/insane ***** -## Retrieve the score leaderboard for this Game. +## Retrieve the PB leaderboard for this Game. -`GET /api/v1/games/:game/:playtype/score-leaderboard` +`GET /api/v1/games/:game/:playtype/pb-leaderboard` ### Parameters @@ -522,7 +522,7 @@ GET /api/v1/games/bms/7K/tableID/insane | Property | Type | Description | | :: | :: | :: | -| `pbs` | Array<PBDocument> | The array of pbs part of the score leaderboard. | +| `pbs` | Array<PBDocument> | The array of pbs part of the PB leaderboard. | | `songs` | Array<[SongDocument](../../schemas/song.md)> | The array of songs part of the PBs. | | `charts` | Array<[ChartDocument](../../schemas/chart.md)> | The array of charts part of the PBs. | | `users` | Array<[UserDocument](../../schemas/user.md)> | The array of users part of the PBs. | diff --git a/server/src/server/router/api/v1/games/_game/_playtype/router.ts b/server/src/server/router/api/v1/games/_game/_playtype/router.ts index 6587784e4..b9ab72651 100644 --- a/server/src/server/router/api/v1/games/_game/_playtype/router.ts +++ b/server/src/server/router/api/v1/games/_game/_playtype/router.ts @@ -153,9 +153,9 @@ router.get("/leaderboard", async (req, res) => { * @param alg - An alternative algorithm to use instead of the gpts default. * @param limit - How many scores to return. * - * @name GET /api/v1/games/:game/:playtype/score-leaderboard + * @name GET /api/v1/games/:game/:playtype/pb-leaderboard */ -router.get("/score-leaderboard", async (req, res) => { +router.get("/pb-leaderboard", async (req, res) => { const { game, playtype } = GetGPT(req); const gptConfig = GetGamePTConfig(game, playtype); diff --git a/server/src/server/router/api/v1/users/_userID/games/_game/_playtype/rivals/router.ts b/server/src/server/router/api/v1/users/_userID/games/_game/_playtype/rivals/router.ts index 7a1f6f5ef..95ae0519e 100644 --- a/server/src/server/router/api/v1/users/_userID/games/_game/_playtype/rivals/router.ts +++ b/server/src/server/router/api/v1/users/_userID/games/_game/_playtype/rivals/router.ts @@ -103,7 +103,7 @@ router.get("/challengers", async (req, res) => { }); /** - * Retrieve a "score leaderboard" for this user's set of rivals. + * Retrieve a "PB leaderboard" for this user's set of rivals. * * This is - effectively - the best 100 scores from this set of users on the given * rating algorithm. @@ -111,9 +111,9 @@ router.get("/challengers", async (req, res) => { * @param alg - The score rating algorithm to sort on. Defaults to whatever the GPTConfig * default is. * - * @name GET /api/v1/users/:userID/games/:game/:playtype/rivals/score-leaderboard + * @name GET /api/v1/users/:userID/games/:game/:playtype/rivals/pb-leaderboard */ -router.get("/score-leaderboard", async (req, res) => { +router.get("/pb-leaderboard", async (req, res) => { const { user, game, playtype } = GetUGPT(req); const gptConfig = GetGamePTConfig(game, playtype);