Merge pull request #246 from boostcampwm-2021/develop

[Docs] swagger update

backend/src/swagger/components/auth.yaml

@@ -0,0 +1,64 @@
+components:
+  parameters:
+    GetScheduleParam:
+      - name: team_id
+        in: query
+        required: true
+        description: 대상 팀 id
+        schema:
+          type: integer
+      - name: start_date
+        in: query
+        required: true
+        description: 시작 날짜
+        schema:
+          type: string
+      - name: end_date
+        in: query
+        required: true
+        description: 끝 날짜
+        schema:
+          type: string
+    ScheduleId:
+      - name: schedule_id
+        in: path
+        required: true
+        description: shedule id
+        schema:
+          type: integer
+  schemas:
+    login:
+      type: object
+      properties:
+        userEmail:
+          type: string
+        userPassword:
+          type: string
+      example:
+        userEmail: [email protected]
+        userPassword: 1qwrj1233ssd
+    signup:
+      type: object
+      properties:
+        userName:
+          type: string
+        userEmail:
+          type: string
+        userPassword:
+          type: string
+      example:
+        userName: testName
+        userEmail: [email protected]
+        userPassword: 1qwrj1233ssd
+    loginRes:
+      type: object
+      properties:
+        user:
+          type: object
+    signupRes:
+      type: object
+      properties:
+        signup:
+          type: boolean
+      example:
+        signup: true

backend/src/swagger/components/schedule.yaml

@@ -2,7 +2,7 @@ components:
   parameters:
     GetScheduleParam:
       - name: team_id
-        in: path
+        in: query
         required: true
         description: 대상 팀 id
         schema:
@@ -20,7 +20,7 @@ components:
         schema:
           type: string
     ScheduleId:
-      - name: schdule_id
+      - name: schedule_id
         in: path
         required: true
         description: shedule id
@@ -132,6 +132,8 @@ components:
     CreateScheduleBody:
       type: object
       properties:
+        team_id:
+          type: integer
         title:
           type: string
         start_date:
@@ -147,6 +149,7 @@ components:
         color:
           type: integer
       example:
+        team_id: 1
         title: 매일 5번 반복
         start_date: 2021-11-01T03:00:00.000Z
         end_date: 2021-11-01T04:00:00.000Z

backend/src/swagger/components/team.yaml

@@ -12,6 +12,17 @@ components:
         required: true
         schema:
           type: integer
+    TeamUser:
+      - name: userId
+        in: path
+        required: true
+        schema:
+          type: integer
+      - name: teamId
+        in: path
+        required: true
+        schema:
+          type: integer
   schemas:
     TeamList:
       type: array

backend/src/swagger/openapi.yaml

@@ -6,13 +6,11 @@ info:
   license:
     name: MIT
 servers:
-  - url: http://localhost:4000/
+  - url: https://www.boostteams.kro.kr
     description: BoostTeams Server
 tags:
   - name: auth
     description: Join / Login / Logout
-  - name: chat
-    description: Chat Page
   - name: schedule
     description: Calendar Page
   - name: team
@@ -31,16 +29,13 @@ paths:
     $ref: './paths/auth/signup.yaml'
   /api/auth/info:
     $ref: './paths/auth/info.yaml'
-  # schdule
-  /api/schedules/{team_id}:
+  /api/auth/signout:
+    $ref: './paths/auth/signout.yaml'
+  # schedule
+  /api/schedules:
     $ref: './paths/schedule/scheduleByTeamId.yaml'
   /api/schedules/{schedule_id}:
     $ref: './paths/schedule/scheduleByScheduleId.yaml'
-  # chat
-  /api/chat/room:
-    $ref: './paths/chat/chat.yaml'
-  /api/chat/room/{chatRoomId}:
-    $ref: './paths/chat/chatRoom.yaml'
   # user
   /api/users:
     $ref: './paths/user/user.yaml'

backend/src/swagger/paths/auth/info.yaml

@@ -4,5 +4,9 @@ get:
   responses:
     200:
       description: 성공
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/auth.yaml#/components/schemas/loginRes'
     401:
       description: error

backend/src/swagger/paths/auth/login.yaml

@@ -1,8 +1,17 @@
 post:
   summary: 로그인하기
   tags: [auth]
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../components/auth.yaml#/components/schemas/login'
   responses:
     200:
       description: 성공
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/auth.yaml#/components/schemas/loginRes'
     401:
       description: error

backend/src/swagger/paths/auth/signout.yaml

@@ -0,0 +1,8 @@
+get:
+  summary: 회원 탈퇴
+  tags: [auth]
+  responses:
+    204:
+      description: 성공
+    401:
+      description: error

backend/src/swagger/paths/auth/signup.yaml

@@ -1,8 +1,17 @@
 post:
   summary: 회원가입하기
   tags: [auth]
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../components/auth.yaml#/components/schemas/signup'
   responses:
     200:
       description: 성공
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/auth.yaml#/components/schemas/signupRes'
     409:
       description: error

backend/src/swagger/paths/schedule/scheduleByTeamId.yaml

@@ -15,13 +15,6 @@ get:
 post:
   summary: 일정 추가하기
   tags: [schedule]
-  parameters:
-    - name: team_id
-      in: path
-      required: true
-      description: 대상 팀 id
-      schema:
-        type: integer
   requestBody:
     content:
       application/json: