TechInterviewer/api.yml at develop · work-in-progress-team/TechInterviewer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
openapi: 3.0.3
info:
  title: RepoInterviewer API
  version: 1.0.0
tags:
  - name: interview
    description: LLMによるコードレビュー面接システム
servers:
  - url: http://localhost:8000
    description: ローカル開発用サーバー

paths:
  /interview:
    post:
      summary: ソースコードと設定を送って面接セッションを開始
      operationId: setUpInterview
      security: []
      tags:
        - interview
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                source_code:
                  type: string
                  format: binary
                  description: レビュー対象のソースコード
                difficulty:
                  type: string
                  enum: [easy, normal, hard, extreme]
                  description: 面接の難易度
                total_question:
                  type: integer
                  description: 面接の質問数
      responses:
        '200':
          description: 面接IDと初回の質問文を返す
          content:
            application/json:
              schema:
                type: object
                properties:
                  interview_id:
                    type: string
                  first_question:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationError'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                type: string

  /interview/{interview_id}:
    post:
      summary: ユーザーの回答に対するLLMからの返答と評価を取得
      operationId: getResponse
      security: []
      tags:
        - interview
      parameters:
        - in: path
          name: interview_id
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                question_id:
                  type: string
                message:
                  type: string
      responses:
        '200':
          description: LLMからの返答と評価を返す
          content:
            application/json:
              schema:
                type: object
                properties:
                  interview_id:
                    type: string
                  question_id:
                    type: string
                  response:
                    type: string
                  score:
                    type: number
                  continue:
                    type: boolean
                    description: この質問への回答がまだ続く場合は true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationError'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                type: string

    get:
      summary: 指定された質問IDの質問文を取得
      operationId: getQuestion
      security: []
      tags:
        - interview
      parameters:
        - in: path
          name: interview_id
          required: true
          schema:
            type: string
        - in: query
          name: question_id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 質問文を返す
          content:
            application/json:
              schema:
                type: object
                properties:
                  interview_id:
                    type: string
                  question_id:
                    type: string
                  question:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationError'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                type: string

  /interview/{interview_id}/result:
    get:
      summary: 各質問の点数と総評を取得
      operationId: getInterviewResult
      security: []
      tags:
        - interview
      parameters:
        - in: path
          name: interview_id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 各質問の点数と総評を返す
          content:
            application/json:
              schema:
                type: object
                properties:
                  interview_id:
                    type: string
                  scores:
                    type: array
                    items:
                      type: integer
                  overall_review:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationError'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                type: string

components:
  schemas:
    Error:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail

    RequestValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            type: object
            properties:
              loc:
                type: array
                items:
                  type: string
              msg:
                type: string
              input:
                type: string
              type:
                type: string
      required:
        - detail