diff --git a/Leaderboard.md b/get_leaderboard.md similarity index 87% rename from Leaderboard.md rename to get_leaderboard.md index a441d2a..2ffe3a7 100644 --- a/Leaderboard.md +++ b/get_leaderboard.md @@ -4,12 +4,27 @@ Returns the highest test data from each user as a JSON array. The data includes metrics such as username, words per minute (WPM), accuracy percentage, the time taken for the test, and the length of the test for a comprehensive overview of user performance. +## Request Parameters + +- `username`: The name of the user. +- `wpm`: Words per minute, indicating the typing speed. +- `accuracy`: The accuracy of the user's typing, in percentage. +- `test_time`: The total time taken to complete the test, in seconds. +- `test_length`: The length of the test, typically measured in number of words. + ## Responses - `200 OK`: Successfully retrieves the leaderboard data. - `404 Not Found`: Indicates that the leaderboard was not found. - `500 Internal Server Error`: Indicates an issue with accessing the database. + +## Example Request + +```bash +curl -X GET "https://url/api/leaderboard" +``` + ## Example Response ```json @@ -29,12 +44,4 @@ Returns the highest test data from each user as a JSON array. The data includes "test_length": 240 } ] -``` - -## Fields - -- `username`: The name of the user. -- `wpm`: Words per minute, indicating the typing speed. -- `accuracy`: The accuracy of the user's typing, in percentage. -- `test_time`: The total time taken to complete the test, in seconds. -- `test_length`: The length of the test, typically measured in number of words. \ No newline at end of file +``` \ No newline at end of file