diff --git a/web_app/api/serializers/leaderboard.py b/web_app/api/serializers/leaderboard.py index 8638e2bdd..37705c80d 100644 --- a/web_app/api/serializers/leaderboard.py +++ b/web_app/api/serializers/leaderboard.py @@ -8,10 +8,23 @@ router = APIRouter() class UserLeaderboardItem(BaseModel): + """ + Args: + db (Session): Database session dependency. + + Returns: + UserLeaderboardResponse: Response containing the leaderboard data. + """ wallet_id: str positions_number: int class UserLeaderboardResponse(BaseModel): + """ + UserLeaderboardResponse is a model representing the response for a user leaderboard. + + Attributes: + leaderboard (List[UserLeaderboardItem]): A list of user leaderboard items. + """ leaderboard: List[UserLeaderboardItem] @router.get( diff --git a/web_app/db/crud/leaderborad.py b/web_app/db/crud/leaderborad.py index ea0fe2e28..381cd39c7 100644 --- a/web_app/db/crud/leaderborad.py +++ b/web_app/db/crud/leaderborad.py @@ -7,7 +7,16 @@ logger = logging.getLogger(__name__) class LeaderboardCRUD: + """ + A class used to perform CRUD operations related to the leaderboard. + """ def __init__(self, session: Session): + """ + Initializes a new instance of the class. + + Args: + session (Session): The database session to be used for database operations. + """ self.Session = session def get_top_users_by_positions(self) -> list[dict]: