api-docs.yaml

openapi: 3.0.1
info:
  title: SROOM 프로젝트
  description: RESTful API
  version: v1.0.0
servers:
  - url: http://localhost:8080
    description: Generated server url
paths:
  /members/profile:
    put:
      tags:
        - 로그인
      summary: 프로필 이름 수정
      description: name을 받아 멤버의 이름을 수정합니다.
      operationId: updateMemberName
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/NameUpdateRequest'
        required: true
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 멤버 이름 변경에 성공하였습니다.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/NameUpdateResponse'
  /materials/summaries/{courseVideoId}:
    put:
      tags:
        - 강의 수강
      summary: 강의 노트 수정하기
      description: 영상 ID를 사용해 저장된 강의노트를 수정합니다.
      operationId: updateSummaries
      parameters:
        - name: courseVideoId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/SummaryEdit'
        required: true
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 강의 노트를 업데이트 했습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SummaryId'
  /materials/quizzes/{courseQuizId}/scrap:
    put:
      tags:
        - 강의 수강
      summary: "퀴즈 오답노트 등록, 취소"
      description: courseQuizId 를 받아 해당 퀴즈를 오답노트에 등록하거나 취소합니다.
      operationId: switchScrapFlag
      parameters:
        - name: courseQuizId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 오답노트에 등록/취소하였습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ScrapResult'
  /lectures/{courseVideoId}/time:
    put:
      tags:
        - 강의 수강
      summary: 시청중인 강의 학습시간 저장하기
      description: "duration을 입력받아 업데이트하고, 70%가 넘었다면 수강완료 처리한다."
      operationId: updateLectureTime
      parameters:
        - name: courseVideoId
          in: path
          required: true
          schema:
            type: integer
            format: int64
        - name: isCompletedManually
          in: query
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/LectureTimeRecord'
        required: true
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 학습시간을 저장 하였습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LectureStatus'
  /reviews/lectures/{lectureId}:
    post:
      tags:
        - 리뷰 평점
      summary: 리뷰 평점 작성
      description: 리뷰 평점 작성 및 제출
      operationId: postReview
      parameters:
        - name: lectureId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/ReviewSubmitRequest'
        required: true
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 작성 완료되었습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewSubmitResponse'
  /members/refresh:
    post:
      tags:
        - 로그인
      summary: access token 갱신
      description: refresh token을 사용하여 로그인을 유지합니다.
      operationId: refresh
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/RefreshToken'
        required: true
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 토큰 갱신에 성공하였습니다.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Login'
  /members/login:
    post:
      tags:
        - 로그인
      summary: 사용자 로그인
      description: 구글 ID 키를 사용하여 사용자를 인증합니다.
      operationId: login
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/GoogleIdKey'
        required: true
      responses:
        "400":
          description: 요청 본문이 유효하지 않습니다.
          content: {}
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: 인증에 실패하였습니다.
          content: {}
        "200":
          description: 성공적으로 사용자를 인증하였습니다.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Login'
  /materials/quizzes/{courseVideoId}:
    post:
      tags:
        - 강의 수강
      summary: 퀴즈 채점 결과 저장
      description: courseVideoId 를 받아 채점 결과를 courseQuiz 테이블에 저장합니다.
      operationId: submitQuizResults
      parameters:
        - name: courseVideoId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SubmittedQuiz'
        required: true
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 채점 결과를 저장했습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SubmittedQuizInfo'
  /courses:
    get:
      tags:
        - 내 강의실
      summary: 내 강의코스 불러오기
      description: 멤버ID를 입력받아 멤버의 등록 코스 리스트와 관련 정보를 불러옵니다.
      operationId: getMyCourses
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 코스 리스트를 불러왔습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/MyCourses'
    post:
      tags:
        - 강의 등록
      summary: 강의 신규 등록
      description: 강의코드를 입력받아 코스를 생성합니다.
      operationId: enrollCourse
      parameters:
        - name: use_schedule
          in: query
          required: true
          schema:
            type: boolean
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/NewLecture'
        required: true
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 강의 코스를 등록하였습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/EnrolledCourseInfo'
  /courses/{courseId}:
    get:
      tags:
        - 강의 수강
      summary: 수강페이지 코스정보
      description: 코스 ID를 받아 해당 코스 정보와 수강할 영상 리스트를 반환합니다.
      operationId: getCourseDetail
      parameters:
        - name: courseId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 수강 정보를 반환하였습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CourseDetail'
    post:
      tags:
        - 강의 등록
      summary: 기존 코스 강의 등록
      description: 강의코드와 코스ID를 받아 코스에 추가합니다.
      operationId: addLectureInCourse
      parameters:
        - name: courseId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/NewLecture'
        required: true
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 코스에 강의를 추가하였습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/EnrolledCourseInfo'
    delete:
      tags:
        - 내 강의실
      summary: 강의 코스 삭제
      description: "지정한 강의 코스를 삭제하고, 업데이트된 강의 리스트를 반환합니다."
      operationId: deleteCourse
      parameters:
        - name: courseId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: "강의코스 삭제가 성공했으며, 정상적으로 결과를 반환했습니다."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyCourses'
  /:
    get:
      tags:
        - health-check-controller
      operationId: healthCheck
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
  /reviews/courses/{courseId}:
    get:
      tags:
        - 리뷰 평점
      summary: 리뷰 평점 강의 리스트 조회
      description: 리뷰 평점을 위한 코스 내 강의 리스트 조회
      operationId: getLectureList
      parameters:
        - name: courseId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 강의 리스트를 불러왔습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LectureBriefList4Review'
  /materials/{courseVideoId}:
    get:
      tags:
        - 강의 수강
      summary: 강의자료 불러오기
      description: "영상 ID를 사용해 저장된 강의노트, 퀴즈를 불러옵니다."
      operationId: getMaterials
      parameters:
        - name: courseVideoId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 강의 자료를 불러왔습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/Material'
  /lectures:
    get:
      tags:
        - 강의 검색
      summary: 강의 키워드 검색
      description: 키워드를 입력받아 유튜브 강의를 검색한다.
      operationId: getLecturesByKeyword
      parameters:
        - name: keywordSearchParam
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/KeywordSearchParam'
        - name: keyword
          in: query
          description: 검색할 키워드
          required: true
          example: 네트워크
        - name: limit
          in: query
          description: 결과의 최대 개수
          example: 5
        - name: filter
          in: query
          description: "검색 종류 필터, all, playlist, video"
          example: all
        - name: nextPageToken
          in: query
          description: 다음 페이지 토큰
          example: QAUQAA
        - name: prevPageToken
          in: query
          description: 이전 페이지 토큰
          example: CAUQAA
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 검색 결과를 반환하였습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/KeywordSearch'
  /lectures/{lectureCode}:
    get:
      tags:
        - 강의 검색
      summary: 강의 상세 정보 조회
      description: 강의 ID를 이용하여 강의의 상세 정보를 조회한다.
      operationId: getLectureDetail
      parameters:
        - name: lectureCode
          in: path
          description: 강의 코드
          required: true
          schema:
            type: string
          example: OEV8gMkCHXQ
        - name: lectureDetailParam
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/LectureDetailParam'
        - name: index_only
          in: query
          description: 목차만 응답 여부
          example: false
        - name: review_only
          in: query
          description: 후기만 응답 여부
          example: false
        - name: index_limit
          in: query
          description: 결과의 최대 개수
          example: 50
        - name: review_limit
          in: query
          description: 후기의 최대 개수
          example: 10
        - name: index_next_token
          in: query
          description: 목차 다음 페이지 토큰
          example: EAAaBlBUOkNESQ
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 강의 상세 정보를 반환하였습니다.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/PlaylistDetail'
                  - $ref: '#/components/schemas/VideoDetail'
                  - $ref: '#/components/schemas/IndexInfo'
  /lectures/recommendations:
    get:
      tags:
        - 강의 검색
      summary: 강의 추천
      description: 유저 ID를 받아 적당한 강의를 추천한다.
      operationId: getRecommendations
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 추천 결과를 반환하였습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recommendations'
  /dashboards:
    get:
      tags:
        - 대시보드
      summary: 대시보드 불러오기
      description: 유저 ID 바탕으로 대시보드 정보 불러오기
      operationId: getDashboard
      responses:
        "400":
          description: Bad Request
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "404":
          description: Not Found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "401":
          description: Unauthorized
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        "200":
          description: 성공적으로 대시보드를 반환하였습니다.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/Dashboard'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        message:
          type: string
    NameUpdateRequest:
      type: object
      properties:
        name:
          type: string
          description: 수정할 멤버 이름
          example: 손경식
      description: 멤버 이름 수정
    NameUpdateResponse:
      type: object
      properties:
        memberId:
          type: integer
          format: int64
        name:
          type: string
    SummaryEdit:
      type: object
      properties:
        content:
          type: string
    SummaryId:
      type: object
      properties:
        summaryId:
          type: integer
          format: int64
    ScrapResult:
      type: object
      properties:
        courseQuizId:
          type: integer
          format: int64
        is_scrapped:
          type: boolean
    LectureTimeRecord:
      type: object
      properties:
        view_duration:
          type: integer
          format: int32
          writeOnly: true
        viewDuration:
          type: integer
          format: int32
    LectureStatus:
      type: object
      properties:
        courseVideoId:
          type: integer
          format: int64
        viewDuration:
          type: integer
          format: int32
        is_completed:
          type: boolean
      description: 해당 강의에 대한 수강정보
    ReviewSubmitRequest:
      type: object
      properties:
        submittedRating:
          type: integer
          format: int32
        reviewContent:
          type: string
      description: 리뷰 작성 API 요청 객체
    ReviewSubmitResponse:
      type: object
      properties:
        lectureId:
          type: integer
          format: int64
        reviewId:
          type: integer
          format: int64
        submittedRating:
          type: integer
          format: int32
        reviewContent:
          type: string
      description: 리뷰 작성 API Response
    RefreshToken:
      type: object
      properties:
        refreshToken:
          type: string
          description: 리프레시 토큰
          example: eyJhbGci...
      description: 리프레시 토큰
    Login:
      type: object
      properties:
        accessToken:
          type: string
          description: 엑세스 토큰
          example: eyJhbGci...
        refreshToken:
          type: string
          description: 리프레시 토큰
          example: eyJhbGci...
        expiresAt:
          type: integer
          description: 만료 시간(초)
          format: int64
          example: 1688398507
        name:
          type: string
          description: 멤버 이름
          example: user_978538
        profile:
          type: string
          description: 멤버 프로필 사진
          example: https://lh3.googleusercontent.com/a/ACg8ocI-Fz8cwMOHu2AJttFMt-s-25lPa--EUakuTRgvqfi-bA=s96-c
        bio:
          type: string
          description: 사용자 한줄소개
      description: 로그인 정보
    GoogleIdKey:
      type: object
      properties:
        credential:
          type: string
          description: 구글 ID 토큰
          example: eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk5YmNiMDY5MzQwYTNmMTQ3NDYyNzk0ZGZlZmE3NWU3OTk2MTM2MzQiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJuYmYiOjE2ODgyMTkyODAsImF1ZCI6IjEwODUyMjEwNDc5NDYtNHMxZ2YwZjlqdHQ3OTB2a2ZkcHZ1Z3FqbW9qMzdrdGsuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMDYwMzMxMTQ0MzU1MjY2MTA0ODciLCJlbWFpbCI6ImxqanVuMDcwMkBnbWFpbC5jA0Nzk0Ni00czFnZjBmOWp0dDc5MHZrZmRwdnVncWptb2ozN2t0ay5hcHBzLmdvb2dsZXVzZXJjb250ZW50LmNvbSIsIm5hbWUiOiLsnbTsooXspIAiLCJwaWN0dXJlIjoiaHR0cHM6Ly9saDMuZ29vZ2xldXNlcmNvbnRlbnQuY29tL2EvQUF=NLQmhRemdtZnNMdXpJVEhNS081bHNnN3FrPXM5Ni1jIiwiZ2l2ZW5fbmFtZSI6IuyiheykgCIsImZhbWlseV9uYW1lIjoi7J20IiwiaWF0IjoxNjg4MjE5NTgwLCJleHAiOjE2ODgyMjMxODAsImp0aSI6kNmVmNmMyM2JlZDgifQ.U1zcrnD9T9tnq2boIRZ9m37fVqeq25elAyBtghKG1p4mzbI1VoygbzdbyYihUkIVz8I21EDiiny9pO8ZBh7_pfSVHXok2XWPtWtzp3SHFKwePhW-SD0HAh8vDPJrkGCiQj5CupAL5nIs-GlIfusC7rx9A1hHaxu-CNyuEDlqrHh-MHlQLN4Wp42RfptOf68cIZZvKQ9D-Fx7Ag6F3Ot8Wfq5yZA
      description: 구글 ID 토큰
    SubmittedQuiz:
      type: object
      properties:
        id:
          type: integer
          format: int64
          writeOnly: true
        submitted_answer:
          type: string
          writeOnly: true
        is_correct:
          type: boolean
          writeOnly: true
        submittedAnswer:
          type: string
        isCorrect:
          type: boolean
        quizId:
          type: integer
          format: int64
    SubmittedQuizInfo:
      type: object
      properties:
        id:
          type: integer
          format: int64
        courseQuizId:
          type: integer
          format: int64
    NewLecture:
      required:
        - lectureCode
      type: object
      properties:
        lectureCode:
          type: string
          description: 강의 코드
          example: PL0d8NnikouEWcF1jJueLdjRIC4HsUlULi
        dailyTargetTime:
          type: integer
          description: 일일 목표 시간
          format: int32
          example: 120
        scheduling:
          type: array
          description: 강의 스케줄
          example:
            - 1
            - 2
            - 3
            - 4
            - 5
          items:
            type: integer
            description: 강의 스케줄
            format: int32
        expectedEndDate:
          type: string
          description: 예상 종료 시간
          example: 2023-12-31
      description: 새로운 강의 정보
    EnrolledCourseInfo:
      type: object
      properties:
        courseId:
          type: integer
          description: 등록된 코스 번호
          format: int64
          example: 12
        lectureId:
          type: integer
          description: 등록된 강의 번호
          format: int64
          example: 44
        title:
          type: string
          description: 등록된 강의 제목
          example: 손경식의 맥북프로 언박싱
      description: 등록된 코스 정보
    LectureBrief4Review:
      type: object
      properties:
        index:
          type: integer
          description: 강의 인덱스
          format: int32
        lectureId:
          type: integer
          description: 강의 ID
          format: int64
        title:
          type: string
          description: 강의 제목
        thumbnail:
          type: string
          description: 강의 썸네일
        channel:
          type: string
          description: 채널명
        viewDuration:
          type: integer
          description: 시청 시간
          format: int32
        lectureDuration:
          type: integer
          description: 총 시간
          format: int32
        completedVideoCount:
          type: integer
          description: 수강 완료 영상 갯수
          format: int32
        totalVideoCount:
          type: integer
          description: 총 영상 갯수
          format: int32
        progress:
          type: integer
          description: 진행률
          format: int32
        submittedAt:
          type: string
          description: 리뷰 작성 날짜
        content:
          type: string
          description: 리뷰 내용
        rating:
          type: integer
          description: 유저 평점
          format: int32
        is_playlist:
          type: boolean
          description: 플레이리스트 여부
        is_review_allowed:
          type: boolean
          description: 리뷰 작성 가능 여부
      description: 리뷰 작성 페이지 강의 정보
    LectureBriefList4Review:
      type: object
      properties:
        lectures:
          type: array
          description: 강의 리스트
          items:
            $ref: '#/components/schemas/LectureBrief4Review'
      description: 강의 리스트
    Material:
      type: object
      properties:
        status:
          type: integer
          format: int32
        totalQuizCount:
          type: integer
          format: int32
        quizzes:
          type: array
          items:
            $ref: '#/components/schemas/QuizRes'
        summaryBrief:
          $ref: '#/components/schemas/SummaryBrief'
    QuizRes:
      type: object
      properties:
        id:
          type: integer
          format: int64
        type:
          type: integer
          format: int32
        question:
          type: string
        options:
          type: array
          items:
            type: string
        answer:
          type: string
        submittedAt:
          type: string
        submittedAnswer:
          type: string
        is_submitted:
          type: boolean
        is_correct:
          type: boolean
        is_scrapped:
          type: boolean
    SummaryBrief:
      type: object
      properties:
        content:
          type: string
        modifiedAt:
          type: string
        is_modified:
          type: boolean
    KeywordSearchParam:
      required:
        - keyword
      type: object
      properties:
        keyword:
          type: string
        next_page_token:
          type: string
        limit:
          type: integer
          format: int32
        filter:
          type: string
    KeywordSearch:
      type: object
      properties:
        resultPerPage:
          type: integer
          description: 응답 개수
          format: int32
          example: 5
        nextPageToken:
          type: string
          description: 다음페이지 조회 토큰
          example: CAQQAA
        prevPageToken:
          type: string
          description: 이전페이지 조회 토큰
          example: QAQQAA
        lectures:
          type: array
          description: 조회된 강의 리스트
          items:
            $ref: '#/components/schemas/LectureResponse'
      description: 검색 결과 강의 리스트
    LectureResponse:
      type: object
      properties:
        lectureTitle:
          type: string
          description: 강의 제목
          example: 네트워크 기초(개정판)
        description:
          type: string
          description: 강의 설명
          example: OSI 7계층에서 각 계층의 다양한 프로토콜들을 통해서 배우는 네트워크 기초에 대한 강의입니다.
        channel:
          type: string
          description: 채널
          example: 따라하면서 배우는 IT
        lectureCode:
          type: string
          description: 강의 ID
          example: PL0d8NnikouEWcF1jJueLdjRIC4HsUlULi
        rating:
          type: number
          description: 강의 평점
          format: double
          example: 4.3
        reviewCount:
          type: integer
          description: 후기 개수
          format: int32
          example: 44
        thumbnail:
          type: string
          description: 강의 썸네일
          example: https://i.ytimg.com/vi/Av9UFzl_wis/hqdefault.jpg
        lectureCount:
          type: integer
          description: 강의 개수
          format: int32
          example: 11
        viewCount:
          type: integer
          description: 조회수
          format: int64
          example: 1222222
        publishedAt:
          type: string
          description: 생성일
          example: 2022-05-23 10:30:21
        is_enrolled:
          type: boolean
          description: 강의 등록 여부
          example: false
        is_playlist:
          type: boolean
          description: 플레이리스트 여부
          example: true
      description: 검색된 개별 강의 정보
    LectureDetailParam:
      type: object
      properties:
        index_only:
          type: boolean
        index_limit:
          type: integer
          format: int32
        review_only:
          type: boolean
        review_offset:
          type: integer
          format: int32
        review_limit:
          type: integer
          format: int32
    CourseBrief:
      type: object
      properties:
        courseId:
          type: integer
          description: 코스 ID
          format: int64
          example: 44
        courseTitle:
          type: string
          description: 코스 제목
          example: 침착맨 vs 주호민 산다면 누구 인생으로?
        totalVideoCount:
          type: integer
          description: 코스에 해당하는 영상 개수
          format: int32
          example: 111
      description: 멤버의 코스 리스트
    PlaylistDetail:
      type: object
      properties:
        lectureCode:
          type: string
          description: 재생목록 ID
          example: PL0d8NnikouEWcF1jJueLdjRIC4HsUlULi
        lectureTitle:
          type: string
          description: 재생목록 제목
          example: 네트워크 기초(개정판)
        channel:
          type: string
          description: 채널 이름
          example: Network Academy
        description:
          type: string
          description: 재생목록 설명
          example: OSI 7계층에서 각 계층의 다양한 프로토콜들을 통해서 배우는 네트워크 기초에 대한 강의입니다.
        publishedAt:
          type: string
          description: 재생목록 게시 날짜
          example: 2022-12-31T23:59:59Z
        rating:
          type: number
          description: 강의 평점
          format: double
          example: 4.3
        reviewCount:
          type: integer
          description: 후기 개수
          format: int32
          example: 44
        thumbnail:
          type: string
          description: 재생목록 썸네일
          example: https://i.ytimg.com/vi/Av9UFzl_wis/hqdefault.jpg
        reviews:
          type: array
          description: 강의 후기 요약 정보
          items:
            $ref: '#/components/schemas/ReviewBrief'
        courses:
          type: array
          description: 멤버의 코스 리스트
          items:
            $ref: '#/components/schemas/CourseBrief'
        is_enrolled:
          type: boolean
          description: 강의 등록 여부
          example: false
        is_playlist:
          type: boolean
          description: 플레이리스트 여부
          example: true
      description: 재생목록 상세 정보
    ReviewBrief:
      type: object
      properties:
        index:
          type: integer
          description: 순서
          format: int32
          example: 1
        reviewContent:
          type: string
          description: 후기 내용
          example: 발음을 못알아먹것서요~
        submittedRating:
          type: integer
          description: 별점
          format: int32
          example: 2
        reviewerName:
          type: string
          description: 후기 남긴 사람 이름
          example: user_318593
        publishedAt:
          type: string
          description: 후기 생성 날짜
          example: 2022-01-34
      description: 후기 정보
    Index:
      type: object
      properties:
        index:
          type: integer
          description: 목차 번호
          format: int32
          example: 1
        thumbnail:
          type: string
          description: 강의 썸네일
          example: https://i.ytimg.com/vi/Av9UFzl_wis/hqdefault.jpg
        lectureTitle:
          type: string
          description: 강의 제목
          example: 네트워크 기초(개정판)
        duration:
          type: integer
          description: 영상 길이
          format: int32
        is_members_only:
          type: boolean
          description: 회원 전용 강의 표시
          example: false
      description: 재생목록 목차 정보
    IndexInfo:
      type: object
      properties:
        indexList:
          type: array
          description: 목차 리스트
          items:
            $ref: '#/components/schemas/Index'
        duration:
          type: integer
          description: 총 재생 시간
          format: int32
          example: 245212
        lectureCount:
          type: integer
          description: 영상 총 개수
          format: int32
          example: 112
      description: 목차 정보
    VideoDetail:
      type: object
      properties:
        lectureCode:
          type: string
          description: 강의 ID
          example: OEV8gMkCHXQ
        lectureTitle:
          type: string
          description: 강의 제목
          example: 네트워크 기초(개정판)
        channel:
          type: string
          description: 채널 이름
          example: OpenAI
        description:
          type: string
          description: 강의 설명
          example: OSI 7계층에서 각 계층의 다양한 프로토콜들을 통해서 배우는 네트워크 기초에 대한 강의입니다.
        duration:
          type: integer
          description: 강의 재생 길이
          format: int32
          example: 11424
        viewCount:
          type: integer
          description: 조회 수
          format: int64
          example: 10234
        publishedAt:
          type: string
          description: 게시일
          example: 2023-06-28
        rating:
          type: number
          description: 강의 평점
          format: double
          example: 4.3
        reviewCount:
          type: integer
          description: 후기 개수
          format: int32
          example: 44
        thumbnail:
          type: string
          description: 강의 썸네일
          example: https://i.ytimg.com/vi/OEV8gMkCHXQ/maxresdefault.jpg
        reviews:
          type: array
          description: 강의 리뷰 목록
          items:
            $ref: '#/components/schemas/ReviewBrief'
        courses:
          type: array
          description: 멤버의 코스 리스트
          items:
            $ref: '#/components/schemas/CourseBrief'
        indexes:
          $ref: '#/components/schemas/IndexInfo'
        is_enrolled:
          type: boolean
          description: 강의 등록 여부
          example: false
        is_playlist:
          type: boolean
          description: 플레이리스트 여부
          example: false
        is_members_only:
          type: boolean
          description: 회원 전용 강의 표시
          example: false
      description: 동영상 상세 정보
    RecommendLecture:
      type: object
      properties:
        lectureTitle:
          type: string
          description: 강의 제목
        description:
          type: string
          description: 강의 설명
        channel:
          type: string
          description: 채널
        lectureCode:
          type: string
          description: 강의 ID
        rating:
          type: number
          description: 강의 평점
          format: double
        reviewCount:
          type: integer
          description: 리뷰 개수
          format: int32
        thumbnail:
          type: string
          description: 썸네일
        is_playlist:
          type: boolean
          description: 플레이리스트 여부
      description: 추천 강의 정보
    Recommendations:
      type: object
      properties:
        recommendations:
          type: array
          description: 추천 강의 리스트
          items:
            $ref: '#/components/schemas/RecommendLecture'
      description: 강의 추천 리스트
    CourseInfo:
      type: object
      properties:
        courseId:
          type: integer
          description: 코스 ID
          format: int64
        courseTitle:
          type: string
          description: 코스 제목 - 첫 영상 제목
        thumbnail:
          type: string
          description: 썸네일
        channels:
          type: string
          description: 채널 리스트
        totalVideoCount:
          type: integer
          description: 코스 내 영상 갯수
          format: int32
        completedVideoCount:
          type: integer
          description: 수강 완료 영상 갯수
          format: int32
        duration:
          type: integer
          description: 코스 총 재생 시간
          format: int32
        progress:
          type: integer
          description: 수강률
          format: int32
        lastViewTime:
          type: string
          description: 마지막 수강 시간
      description: 강의 코스 정보
    Dashboard:
      type: object
      properties:
        correctnessRate:
          type: integer
          description: 퀴즈 정답률
          format: int32
        completionRate:
          type: integer
          description: 완강률
          format: int32
        totalLearningTime:
          type: integer
          description: 전체 누적수강 시간
          format: int32
        motivation:
          type: string
          description: 동기부여 문구
        latestLectures:
          type: array
          description: 최근 수강 강의
          items:
            $ref: '#/components/schemas/CourseInfo'
        learningHistories:
          type: array
          description: 일별 수강 로그
          items:
            $ref: '#/components/schemas/LearningHistory'
      description: 대시보드 반환 데이터
    LearningHistory:
      type: object
      properties:
        date:
          type: string
          description: 날짜
        learningTime:
          type: integer
          description: 수강 시간
          format: int32
        quizCount:
          type: integer
          description: 일일 퀴즈 푼 갯수
          format: int32
        lectureCount:
          type: integer
          description: 일일 수강 강의 갯수
          format: int32
      description: 일일 수강 로그
    MyCourses:
      type: object
      properties:
        unfinishedCourse:
          type: integer
          description: 미 수강완료 강의 갯수
          format: int32
        completionRate:
          type: integer
          description: 완강률
          format: int32
        courses:
          type: array
          description: 강의 코스 데이터 리스트
          items:
            $ref: '#/components/schemas/CourseInfo'
      description: 내 강의실 데이터
    CourseDetail:
      type: object
      properties:
        courseId:
          type: integer
          description: 강의의 고유 식별자
          format: int64
          example: 102
        useSchedule:
          type: boolean
          description: 강의가 일정을 사용하는지 여부
          example: true
        thumbnail:
          type: string
          description: 코스 썸네일
          example: https://i.ytimg.com/vi/c2cz_uF3NII/maxresdefault.jpg
        courseTitle:
          type: string
          description: 강의의 제목
          example: 자바 기초
        channels:
          type: string
          description: 강의가 제공되는 채널
          example: YouTube
        courseDuration:
          type: integer
          description: 강의의 총 기간 (분 단위)
          format: int32
          example: 120
        currentDuration:
          type: integer
          description: 현재 시청 완료된 강의 기간 (분 단위)
          format: int32
          example: 60
        totalVideoCount:
          type: integer
          description: 강의의 총 비디오 개수
          format: int32
          example: 10
        completedVideoCount:
          type: integer
          description: 강의에서 완료된 비디오 수
          format: int32
          example: 5
        progress:
          type: integer
          description: 강의 진행률 퍼센트
          format: int32
          example: 50
        lastViewVideo:
          $ref: '#/components/schemas/LastVideoInfo'
        sections:
          type: array
          description: 강의 일정의 주 리스트
          items:
            $ref: '#/components/schemas/Section'
      description: 수강페이지에 쓰이는 강의에 대한 상세 정보
    LastVideoInfo:
      type: object
      properties:
        videoId:
          type: integer
          description: 비디오의 고유 식별자
          format: int64
          example: 20
        courseVideoId:
          type: integer
          description: 비디오의 COURSEVIDEO 테이블 PK
          format: int64
          example: 11
        videoTitle:
          type: string
          description: 비디오의 제목
          example: 자바 스프링 기초
        videoCode:
          type: string
          description: 비디오의 코드
          example: JAVA_SPRING_BASICS
        channel:
          type: string
          description: 비디오가 제공되는 채널
          example: 래퍼 손경식
        lastViewDuration:
          type: integer
          description: 마지막으로 시청한 비디오의 기간 (초 단위)
          format: int32
          example: 30
      description: 마지막으로 시청한 비디오에 대한 정보
    Section:
      type: object
      properties:
        section:
          type: integer
          description: 주차 번호
          format: int32
          example: 1
        weekDuration:
          type: integer
          description: 해당 주차의 총 강의 기간 (초 단위)
          format: int32
          example: 120
        currentWeekDuration:
          type: integer
          description: 해당 주차에서 현재 시청 완료한 강의 기간 (초 단위)
          format: int32
          example: 60
        videos:
          type: array
          description: 해당 주차의 비디오 목록
          items:
            $ref: '#/components/schemas/VideoWatchInfo'
        is_completed:
          type: boolean
          description: 해당 주차의 강의가 완료되었는지 여부
          example: false
      description: 강의 일정의 주별 정보
    VideoWatchInfo:
      type: object
      properties:
        videoId:
          type: integer
          description: 비디오 ID
          format: int64
          example: 1111
        videoIndex:
          type: integer
          description: 비디오의 인덱스
          format: int32
          example: 1
        courseVideoId:
          type: integer
          description: 비디오의 COURSEVIDEO 테이블 PK
          format: int64
          example: 123
        channel:
          type: string
          description: 비디오가 제공되는 채널
          example: 발라더 손경식
        videoTitle:
          type: string
          description: 비디오의 제목
          example: 자바 스프링 기초
        videoCode:
          type: string
          description: 비디오의 코드
          example: JAVA_SPRING_BASICS
        lastViewDuration:
          type: integer
          description: 영상 시작시간
          format: int32
          example: 11
        videoDuration:
          type: integer
          description: 영상 재생시간
          format: int32
          example: 1000
        is_completed:
          type: boolean
          description: 해당 비디오가 완료되었는지 여부
          example: false
      description: 수강 페이지 사이드바에 쓰이는 비디오의 요약 정보