Merge pull request #208 from Pseudo-Lab/test/example-data

test(getcloser): API별 입력 데이터 예시 추가

Author: HanNayeoniee

getcloser/backend/app/schemas/challenge_schema.py

@@ -7,13 +7,6 @@ class ChallengeRequest(BaseModel):
   my_id: int
   members_ids: List[int]
 
-class AssignedChallenge(BaseModel):
-  user_id: int
-  assigned_challenge_id: int
-  from_user_id: int
-  category: str
-  answer: str
-
   class Config:
     json_schema_extra = {
       "example": {
@@ -25,6 +18,13 @@ class Config:
       }
     }
 
+class AssignedChallenge(BaseModel):
+  user_id: int
+  assigned_challenge_id: int
+  from_user_id: int
+  category: str
+  answer: str
+
 class AnswerSubmitRequest(BaseModel):
   user_id: int
   challenge_id: int
@@ -49,13 +49,27 @@ class ChallengeResponse(BaseModel):
 class GoodsRedeemRequest(BaseModel):
   user_id: int
 
+  class Config:
+    json_schema_extra = {
+      "example": {
+        "user_id": 1
+      }
+    }
+
 class GoodsRedeemResponse(BaseModel):
   message: str
   redeemed_at: Optional[datetime] = None
 
 class ChallengeRetryRequest(BaseModel):
   user_id: int
 
+  class Config:
+    json_schema_extra = {
+      "example": {
+        "user_id": 1
+      }
+    }
+
 class ChallengeRetryResponse(BaseModel):
   message: str
   retry_count: int

getcloser/backend/app/schemas/team_schema.py

@@ -6,6 +6,13 @@ class TeamCreateRequest(BaseModel):
     my_id: int
     member_ids: List[int] = Field(..., min_items=4, max_items=4, description="팀원 4명의 ID")
 
+    class Config:
+        json_schema_extra = {
+            "example": {
+                "my_id": 1,
+                "member_ids": [2, 3, 4, 5]
+            }
+    }
 
 class TeamResponse(BaseModel):
     team_id: int

getcloser/backend/app/schemas/user_schema.py

@@ -3,6 +3,13 @@
 class UserAuth(BaseModel):
   email: EmailStr
 
+  class Config:
+    json_schema_extra = {
+      "example": {
+        "email": "minjun_kim@gmail.com"
+      }
+    }
+
 class UserResponse(BaseModel):
   accessToken: str