docs: rm response_description

Author: adithyasunil04

src/pwncore/models/ctf.py

@@ -5,7 +5,7 @@
 from tortoise.models import Model
 from tortoise import fields
 from tortoise.contrib.pydantic import pydantic_model_creator
-
+from pydantic import BaseModel
 from pwncore.models.user import Team
 
 __all__ = (
@@ -19,6 +19,8 @@
     "BaseProblem",
 )
 
+class Flag(BaseModel):
+    flag: str
 
 class BaseProblem(Model):
     name = fields.TextField()

src/pwncore/models/responseModels/CTF_StatusResponse.py

@@ -0,0 +1,41 @@
+from pydantic import BaseModel
+from typing import List, Optional
+
+class CTF_ErrorResponse(BaseModel):
+    """
+    Error response for CTF operations
+    - 404: ctf_not_found : 2
+    - 403: hint_limit_reached : 9
+    - 412: Insufficient coins : 22
+    - 406: container_already_running : 7
+    - 429: container_limit_reached : 8
+    - 500: db_error : 0
+    """
+    msg_code: int
+
+class ContainerStartResponse(BaseModel):
+    """
+    Response for container start operation
+    msg_codes: 
+    - (success) container_start : 3
+    """
+    msg_code: int
+    ports: Optional[List[int]] = None
+    ctf_id: Optional[int] = None
+
+class ContainerStopResponse(BaseModel):
+    """
+    Response for container stop operations
+    - (success) container_stop : 4
+    - (fail) 
+        - 404: ctf_not_found : 2
+        - 400: container_not_found  : 6
+        - 500: db_error : 0 
+    """
+    msg_code: int
+
+class ContainerPortsResponse(BaseModel):
+    """
+    Response for all open ports of containers
+    """
+    ports: dict[int, list[int]]

src/pwncore/models/responseModels/adminResponse.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+from typing import Optional
+
+class AdminBaseResponse(BaseModel):
+    """
+    Generic response for admin operations
+    """
+    success: bool
+    message: Optional[str] = None

src/pwncore/models/responseModels/preEventCTF_response.py

@@ -4,9 +4,6 @@
 class PreEventFlag(BaseModel):
     """
     Response for pre-event flag submission
-    tag: team tag
-    flag: flag submitted
-    email: email of the team
     """
     tag: str
     flag: str
@@ -16,22 +13,18 @@ class PreEventFlag(BaseModel):
 class CoinsQuery(BaseModel):
     """
     Response for pre-event coins query
-    tag: team tag
     """
     tag: str
 
 class CoinsResponse(BaseModel):
     """
     Response for pre-event coins query
-    coins: total coins earned by the team in pre-event CTFs
     """
     coins: int
 
 class FlagSubmissionResponse(BaseModel):
     """
     Response for pre-event flag submission
-    status: bool
-    coins: total coins earned by the team in pre-event CTFs
     """
     status: bool
     coins: int

src/pwncore/models/responseModels/teamManagementResponse.py

@@ -0,0 +1,34 @@
+from pydantic import BaseModel
+import typing as t
+
+
+class UserAddBody(BaseModel):
+    """
+    Request body for adding a user
+    """
+    tag: str
+    name: str
+    email: str
+    phone_num: str
+
+
+class UserRemoveBody(BaseModel):
+    """
+    Request body for removing a user
+    """
+    tag: str
+
+class MemberStatusResponse(BaseModel):
+    """
+    Response for user management operations in teams
+    msg_code for response:
+    - (success) 
+        - user_added: 18
+        - user_removed: 19
+
+    - (fail) 
+        - user_already_in_team: 20
+        - user_not_in_team : 21
+        - db_error: 0
+    """
+    msg_code: int

src/pwncore/routes/ctf/pre_event.py

@@ -33,9 +33,7 @@
 @router.get(
     "/list",
     response_model=list[PreEventProblem_Pydantic],
-    response_description="""Returns a list of all available pre-event CTF problems.
-    Flag field is excluded from response for security.
-    """)
+    )
 async def ctf_list():
     problems = await PreEventProblem_Pydantic.from_queryset(PreEventProblem.all())
     return problems
@@ -44,9 +42,7 @@ async def ctf_list():
 @router.get(
     "/today",
     response_model=list[PreEventProblem_Pydantic],
-    response_description="""Returns list of CTF problems scheduled for current date.
-    Returns empty list if no problems are scheduled for today.
-    """)
+    )
 async def ctf_today():
     return await PreEventProblem_Pydantic.from_queryset(
         PreEventProblem().filter(date=datetime.now(_IST).date())
@@ -56,10 +52,7 @@ async def ctf_today():
 @router.get(
     "/coins/{tag}",
     response_model=CoinsResponse,
-    response_description="""Get total coins earned by a user in pre-event CTFs.
-    
-    Note: Returns msg_code : 11 if user_not_found.
-    """)
+    )
 async def coins_get(tag: str):
     try:
         return {

src/pwncore/routes/leaderboard.py

@@ -60,12 +60,6 @@ async def get_lb(self, req: Request):
 
 @router.get("",
     response_model=list[LeaderboardEntry],
-    response_description=u"""Returns the current CTF leaderboard sorted by total points.
-    
-    Notes:
-    - tpoints = sum of (problem points × penalty multiplier) + team points
-    - Results are cached for 30 seconds
-    - Cache is force-expired when problems are solved
-    """)
+    )
 async def fetch_leaderboard(req: Request):
     return Response(content=await gcache.get_lb(req), media_type="application/json")