-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
4411 lines (4411 loc) · 141 KB
/
openapi.yaml
File metadata and controls
4411 lines (4411 loc) · 141 KB
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: AI 기술 면접 연습 플랫폼 API
version: 0.4.1
description: 핵심 사용자 흐름과 최신 요구사항 변경안을 반영한 OpenAPI 계약. API 변경 시 docs/requirements.md,
docs/project/open-items.md와 함께 수정한다. 핵심 성공 응답은 success/data/meta 형태와 예시 응답을 포함한다.
servers:
- url: /api/v1
tags:
- name: Auth
- name: GitHub
- name: Documents
- name: Applications
- name: Interview
- name: Followup
- name: AI
components:
securitySchemes:
AuthorizationHeader:
type: apiKey
in: header
name: Authorization
description: '형식: Bearer {apiKey} {accessToken}'
schemas:
Meta:
type: object
properties:
requestId:
type: string
timestamp:
type: string
format: date-time
pagination:
$ref: '#/components/schemas/Pagination'
ErrorResponse:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
message:
type: string
retryable:
type: boolean
retryAfterSeconds:
type: integer
nullable: true
description: rate limit 시 재시도까지 기다려야 하는 초. null이면 해당 없음.
fieldErrors:
type: array
items:
$ref: '#/components/schemas/ErrorDetail'
required:
- code
- message
meta:
$ref: '#/components/schemas/Meta'
required:
- success
- error
- meta
User:
type: object
properties:
id:
type: integer
format: int64
displayName:
type: string
email:
type: string
nullable: true
profileImageUrl:
type: string
nullable: true
status:
type: string
enum:
- active
- withdrawn
required:
- id
- displayName
- status
GithubConnection:
type: object
properties:
id:
type: integer
format: int64
userId:
type: integer
format: int64
githubUserId:
type: integer
format: int64
githubLogin:
type: string
accessScope:
type: string
nullable: true
description: OAuth 동의 범위. private repository 조회가 필요한 경우 추가 scope가 포함될 수
있다.
syncStatus:
type: string
enum:
- pending
- success
- failed
connectedAt:
type: string
format: date-time
lastSyncedAt:
type: string
format: date-time
nullable: true
required:
- id
- userId
- githubUserId
- githubLogin
- syncStatus
- connectedAt
Repository:
type: object
properties:
id:
type: integer
format: int64
githubRepoId:
type: integer
format: int64
ownerLogin:
type: string
repoName:
type: string
fullName:
type: string
htmlUrl:
type: string
visibility:
type: string
enum:
- public
- private
- internal
defaultBranch:
type: string
nullable: true
isSelected:
type: boolean
hasCommits:
type: boolean
description: 커밋 동기화 완료 여부. false면 포트폴리오 분석 불가
analysisStatus:
allOf:
- $ref: '#/components/schemas/RepoSyncStatus'
- description: 분석 상태. 분석 미요청 또는 TTL 만료 시 null
nullable: true
pushedAt:
type: string
format: date-time
nullable: true
description: GitHub pushed_at. 기여/URL 추가 경로는 null
ownerType:
type: string
nullable: true
enum:
- owner
- collaborator
description: 저장 시점에 결정됨. 기존 데이터는 null
language:
type: string
nullable: true
description: primary language
required:
- id
- githubRepoId
- fullName
- htmlUrl
- visibility
- isSelected
- hasCommits
SaveContributionRequest:
type: object
properties:
githubRepoId:
type: integer
format: int64
nameWithOwner:
type: string
description: 'owner/repo 형식'
example: spring-projects/spring-security
url:
type: string
language:
type: string
nullable: true
repoSizeKb:
type: integer
nullable: true
required:
- githubRepoId
- nameWithOwner
- url
AddContributionByUrlRequest:
type: object
properties:
url:
type: string
description: 'GitHub repo URL (예: https://github.com/owner/repo)'
required:
- url
ContributedRepo:
type: object
properties:
githubRepoId:
type: integer
format: int64
nameWithOwner:
type: string
url:
type: string
language:
type: string
nullable: true
repoSizeKb:
type: integer
nullable: true
contributionCount:
type: integer
alreadySaved:
type: boolean
description: 이미 github_repositories에 저장된 repo 여부
repositoryId:
type: integer
format: int64
nullable: true
description: 'github_repositories.id (저장된 경우에만 non-null)'
required:
- githubRepoId
- nameWithOwner
- url
- contributionCount
- alreadySaved
Document:
type: object
properties:
id:
type: integer
format: int64
documentType:
type: string
enum:
- resume
- award
- certificate
- other
originalFileName:
type: string
mimeType:
type: string
description: '허용 MIME type: application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document,
text/markdown, text/plain'
fileSizeBytes:
type: integer
format: int64
description: 최대 52428800 bytes (50MB)
extractStatus:
type: string
enum:
- pending
- success
- failed
uploadedAt:
type: string
format: date-time
extractedAt:
type: string
format: date-time
nullable: true
extractedText:
type: string
nullable: true
required:
- id
- documentType
- originalFileName
- mimeType
- fileSizeBytes
- extractStatus
- uploadedAt
Application:
type: object
properties:
id:
type: integer
format: int64
applicationTitle:
type: string
nullable: true
companyName:
type: string
nullable: true
jobRole:
type: string
status:
type: string
enum:
- draft
- ready
description: 'draft: 작업 중, ready: jobRole, 1개 이상 source, 1개 이상 question, 모든 question의 유효 답변이 준비되어 면접 질문 생성과 이후 흐름에 사용할 수 있는 상태'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
applicationType:
type: string
nullable: true
description: '지원 유형 예: 신입, 인턴, 경력'
required:
- id
- jobRole
- status
- createdAt
- updatedAt
ApplicationQuestion:
type: object
properties:
id:
type: integer
format: int64
questionOrder:
type: integer
questionText:
type: string
generatedAnswer:
type: string
nullable: true
editedAnswer:
type: string
nullable: true
toneOption:
type: string
nullable: true
enum:
- formal
- balanced
- casual
lengthOption:
type: string
nullable: true
enum:
- short
- medium
- long
description: short<=700 chars, medium<=1200 chars, long<=1800 chars
emphasisPoint:
type: string
nullable: true
required:
- id
- questionOrder
- questionText
InterviewQuestion:
type: object
properties:
id:
type: integer
format: int64
questionOrder:
type: integer
questionType:
type: string
enum:
- experience
- project
- technical_cs
- technical_stack
- behavioral
- follow_up
difficultyLevel:
type: string
enum:
- easy
- medium
- hard
questionText:
type: string
parentQuestionId:
type: integer
format: int64
nullable: true
sourceApplicationQuestionId:
type: integer
format: int64
nullable: true
required:
- id
- questionOrder
- questionType
- difficultyLevel
- questionText
InterviewSession:
type: object
properties:
id:
type: integer
format: int64
questionSetId:
type: integer
format: int64
status:
type: string
enum:
- ready
- in_progress
- paused
- completed
- feedback_completed
description: 'ready: 시작 전, in_progress: 진행 중, paused: 일시중지, completed: 종료,
feedback_completed: 피드백 완료'
totalScore:
type: integer
minimum: 0
maximum: 100
nullable: true
summaryFeedback:
type: string
nullable: true
startedAt:
type: string
format: date-time
nullable: true
endedAt:
type: string
format: date-time
nullable: true
required:
- id
- questionSetId
- status
InterviewSessionCurrentQuestion:
type: object
properties:
id:
type: integer
format: int64
description: 세션 질문 id. 질문 세트 원본 질문 id가 아니라 현재 세션 스냅샷 기준 식별자
questionOrder:
type: integer
questionType:
type: string
enum:
- experience
- project
- technical_cs
- technical_stack
- behavioral
- follow_up
difficultyLevel:
type: string
enum:
- easy
- medium
- hard
questionText:
type: string
required:
- id
- questionOrder
- questionType
- difficultyLevel
- questionText
InterviewSessionAnswerSummary:
type: object
properties:
answerOrder:
type: integer
answerText:
type: string
nullable: true
description: 사용자가 최종 확인한 답변 텍스트. Track A 실시간 음성 입력 v1에서는 확정 transcript도 이 필드에 저장한다.
isSkipped:
type: boolean
required:
- answerOrder
- isSkipped
InterviewSessionTranscriptEntry:
type: object
properties:
question:
$ref: '#/components/schemas/InterviewSessionCurrentQuestion'
answer:
$ref: '#/components/schemas/InterviewSessionAnswerSummary'
required:
- question
- answer
CompletionFollowupContext:
type: object
properties:
rootQuestion:
$ref: '#/components/schemas/InterviewSessionCurrentQuestion'
rootAnswer:
$ref: '#/components/schemas/InterviewSessionAnswerSummary'
runtimeFollowupQuestion:
allOf:
- $ref: '#/components/schemas/InterviewSessionCurrentQuestion'
nullable: true
runtimeFollowupAnswer:
allOf:
- $ref: '#/components/schemas/InterviewSessionAnswerSummary'
nullable: true
completionFollowupQuestion:
$ref: '#/components/schemas/InterviewSessionCurrentQuestion'
parentQuestionOrder:
type: integer
required:
- rootQuestion
- rootAnswer
- completionFollowupQuestion
- parentQuestionOrder
InterviewSessionDetail:
type: object
properties:
id:
type: integer
format: int64
questionSetId:
type: integer
format: int64
status:
type: string
enum:
- ready
- in_progress
- paused
- completed
- feedback_completed
description: 'ready: 시작 전, in_progress: 진행 중, paused: 일시중지, completed: 종료,
feedback_completed: 피드백 완료'
currentQuestion:
allOf:
- $ref: '#/components/schemas/InterviewSessionCurrentQuestion'
nullable: true
completionFollowupContext:
allOf:
- $ref: '#/components/schemas/CompletionFollowupContext'
nullable: true
transcriptEntries:
type: array
description: answered question/answer pair 목록. answerOrder 오름차순이며 현재 미응답 currentQuestion과 system 메시지는 포함하지 않음. Track A 실시간 음성 입력 v1의 현재 interim transcript는 포함하지 않는다.
items:
$ref: '#/components/schemas/InterviewSessionTranscriptEntry'
totalQuestionCount:
type: integer
answeredQuestionCount:
type: integer
remainingQuestionCount:
type: integer
resumeAvailable:
type: boolean
lastActivityAt:
type: string
format: date-time
nullable: true
startedAt:
type: string
format: date-time
nullable: true
endedAt:
type: string
format: date-time
nullable: true
required:
- id
- questionSetId
- status
- completionFollowupContext
- transcriptEntries
- totalQuestionCount
- answeredQuestionCount
- remainingQuestionCount
- resumeAvailable
- totalQuestionCount
- answeredQuestionCount
- remainingQuestionCount
- resumeAvailable
InterviewSessionTransitionData:
type: object
properties:
sessionId:
type: integer
format: int64
status:
type: string
enum:
- in_progress
- paused
updatedAt:
type: string
format: date-time
required:
- sessionId
- status
- updatedAt
ErrorDetail:
type: object
properties:
field:
type: string
reason:
type: string
required:
- field
- reason
FeedbackTag:
type: object
properties:
tagId:
type: integer
format: int64
tagName:
type: string
enum:
- 질문 의도 미충족
- 답변 미완
- 구체성 부족
- 문제 해결 설명 부족
- 답변 구조 미흡
- 근거 부족
- 기술 정확도 부족
- 기술 깊이 부족
- 선택 근거 부족
- 표현 명확성 부족
tagCategory:
type: string
enum:
- content
- structure
- evidence
- communication
- technical
- other
required:
- tagId
- tagName
- tagCategory
InterviewAnswerResult:
type: object
properties:
answerId:
type: integer
format: int64
questionId:
type: integer
format: int64
description: 세션 질문 id
questionType:
type: string
description: 세션 질문 유형. `follow_up`이면 결과 화면에서 꼬리 질문 배지를 표시할 수 있다.
enum:
- experience
- project
- technical_cs
- technical_stack
- behavioral
- follow_up
questionText:
type: string
answerText:
type: string
nullable: true
score:
type: integer
minimum: 0
maximum: 100
evaluationRationale:
type: string
tags:
type: array
maxItems: 3
items:
$ref: '#/components/schemas/FeedbackTag'
required:
- answerId
- questionId
- questionType
- questionText
- score
- evaluationRationale
- tags
InterviewResult:
type: object
properties:
sessionId:
type: integer
format: int64
questionSetId:
type: integer
format: int64
status:
type: string
enum:
- completed
- feedback_completed
totalScore:
type: integer
minimum: 0
maximum: 100
summaryFeedback:
type: string
answers:
type: array
items:
$ref: '#/components/schemas/InterviewAnswerResult'
startedAt:
type: string
format: date-time
nullable: true
endedAt:
type: string
format: date-time
nullable: true
required:
- sessionId
- questionSetId
- status
- totalScore
- summaryFeedback
- answers
Pagination:
type: object
properties:
page:
type: integer
example: 1
size:
type: integer
example: 20
totalElements:
type: integer
example: 1
totalPages:
type: integer
example: 1
required:
- page
- size
- totalElements
- totalPages
AuthorizationStartData:
type: object
properties:
provider:
type: string
enum:
- github
- google
- kakao
authorizationUrl:
type: string
state:
type: string
required:
- provider
- authorizationUrl
- state
OAuthCallbackData:
type: object
properties:
provider:
type: string
enum:
- github
- google
- kakao
isNewUser:
type: boolean
user:
$ref: '#/components/schemas/User'
required:
- provider
- isNewUser
- user
LogoutData:
type: object
properties:
loggedOut:
type: boolean
example: true
required:
- loggedOut
RepositorySelectionData:
type: object
properties:
selectedRepositoryIds:
type: array
items:
type: integer
format: int64
selectedCount:
type: integer
required:
- selectedRepositoryIds
- selectedCount
RepositorySyncData:
type: object
properties:
repositoryId:
type: integer
format: int64
syncStatus:
type: string
description: 동기화 시작 요청의 처리 상태. 저장되는 github_connections.sync_status(pending/success/failed)와는 별개다.
enum:
- queued
- running
- completed
- failed
queuedAt:
type: string
format: date-time
required:
- repositoryId
- syncStatus
- queuedAt
RepoSyncStatus:
type: object
nullable: true
properties:
repositoryId:
type: integer
format: int64
status:
type: string
enum:
- PENDING
- IN_PROGRESS
- COMPLETED
- SKIPPED
- FAILED
description: PENDING=대기중, IN_PROGRESS=처리중, COMPLETED=완료, SKIPPED=분석 생략(skipReason 참조), FAILED=오류
step:
type: string
nullable: true
description: IN_PROGRESS 시 현재 단계 (significance_check|clone|analysis|summary)
startedAt:
type: string
format: date-time
nullable: true
estimatedEndAt:
type: string
format: date-time
nullable: true
completedAt:
type: string
format: date-time
nullable: true
error:
type: string
nullable: true
skipReason:
type: string
nullable: true
description: SKIPPED 상태일 때 skip 이유 (예:"커밋이 없습니다. 커밋 동기화를 먼저 실행해주세요.", "최근 변경량이 기준치에 미달합니다.")
required:
- repositoryId
- status
ApplicationSourceBindingData:
type: object
properties:
applicationId:
type: integer
format: int64
repositoryIds:
type: array
items:
type: integer
format: int64
documentIds:
type: array
items:
type: integer
format: int64
sourceCount:
type: integer
required:
- applicationId
- repositoryIds
- documentIds
- sourceCount
GeneratedApplicationAnswer:
type: object
properties:
questionId:
type: integer
format: int64
questionText:
type: string
generatedAnswer:
type: string
toneOption:
type: string
nullable: true
enum:
- formal
- balanced
- casual
lengthOption:
type: string
nullable: true
enum:
- short
- medium
- long
required:
- questionId
- questionText
- generatedAnswer
ApplicationAnswerGenerationData:
type: object
properties:
applicationId:
type: integer
format: int64
generatedCount:
type: integer
regenerate:
type: boolean
answers:
type: array
items:
$ref: '#/components/schemas/GeneratedApplicationAnswer'
required:
- applicationId
- generatedCount
- regenerate
- answers
QuestionSetJobStatus:
type: object
properties:
jobId:
type: string
format: uuid
status:
type: string
enum:
- PENDING
- IN_PROGRESS
- COMPLETED
- FAILED
questionSetId:
type: integer
format: int64
nullable: true
description: COMPLETED 시 채워진다
error:
type: string
nullable: true
required:
- jobId
- status
InterviewQuestionSetSummary:
type: object
properties:
questionSetId:
type: integer
format: int64
applicationId:
type: integer
format: int64
title:
type: string
questionCount:
type: integer
difficultyLevel:
type: string
enum:
- easy
- medium
- hard
createdAt:
type: string
format: date-time
required:
- questionSetId
- applicationId
- title
- questionCount
- difficultyLevel
- createdAt
InterviewQuestionSetDetail: