-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCV_Management_API_OpenAPI_v1.6.0.yaml
More file actions
10265 lines (10265 loc) · 321 KB
/
Copy pathCV_Management_API_OpenAPI_v1.6.0.yaml
File metadata and controls
10265 lines (10265 loc) · 321 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.1.1
info:
title: CV Management and Deterministic Internship Candidate Filtering API
version: 1.6.0
description:
REST/JSON API contract for the locked Version 1 scope. Version 1.6.0 preserves the finalized Sprint 1-6 contracts
and freezes the Sprint 7 Admin Student inspection, company and internship-request contracts plus the Sprint 8 deterministic
filtering, manual shortlist, finalization, and export contracts.
x-revision-summary:
- Preserved every valid Sprint 1-6 path and operationId from OpenAPI v1.5.0.
- Finalized read-only Admin Student deep-dive and latest-saved CV availability/download semantics.
- Finalized company metadata with Admin-managed CRUD and destructive deletion; no active/inactive lifecycle.
- Finalized internship requests with taxonomy-backed required skills and no persisted GPA criteria.
- Finalized persisted deterministic filtering runs using runtime official GPA and declared skills only.
- Finalized manual draft shortlists, non-blocking guidance acknowledgement, and atomic conflict-aware finalization.
- Separated asynchronous CSV shortlist-summary export from ZIP latest-saved-CV export.
- Added explicit missing-CV reporting, constrained pagination/sorting, optimistic concurrency, and endpoint-specific errors.
- Expanded deterministic frontend metadata and scope-preservation validation for Sprint 7-8.
x-implementation-status:
frontendContract: READY
backendImplementation: PLANNED
sprint7FrontendImplementation: BLOCKED_BY_INTEGRATION
sprint8FrontendImplementation: BLOCKED_BY_INTEGRATION
x-academic-ledger-file-contract:
format: CSV
mediaType: text/csv
extension: .csv
charset: UTF-8
maxSizeBytes: 5242880
headerRowRequired: true
headerOrderRequired: true
columns:
- name: student_index_number
required: true
description: Existing eligible Student index number.
- name: course_code
required: true
description: Canonical subject code resolved by the backend.
- name: credits
required: true
description: Positive subject credit value.
- name: letter_grade
required: true
description: Grade resolved through the developer-managed grade scale.
- name: semester
required: true
description: Official semester or period label.
- name: academic_year
required: true
description: Academic year in YYYY/YYYY form.
- name: attempt_number
required: true
description: Positive attempt number.
- name: result_status
required: true
description:
Closed official result status. Use PASSED for A+ through C, FAILED for C- through E,
and ABSENT only for E*.
derivedFields:
- studentId
- courseTitle
- gradePoint
duplicateBehavior:
The backend may compute an internal content digest. Identical content matching an active or committed
upload is rejected with 409. A prior PROCESSING_FAILED or VALIDATION_FAILED batch does not prevent a corrected file
upload.
x-sprint-7-8-contract-decisions:
companyDeletion: DELETE permanently removes the company and cascades to its linked internship requests.
requestDeletion: DELETE permanently removes the internship request and its required-skill associations.
requestSkillMutation: Create/update may atomically replace the full skill set; nested endpoints support incremental edits.
filterRuns: Persisted sanitized runtime metadata; candidate results are recomputed from latest committed data.
shortlistCardinality: One shortlist resource per internship request in Version 1.
shortlistGuidance: Advisory only; acknowledgement permits finalization when exceeded.
summaryExport: Asynchronous CSV.
bulkCvExport: Asynchronous ZIP of available latest-saved ATS-compliant PDF CVs with explicit missing-CV reporting.
servers:
- url: /api/v1
security:
- bearerAuth: []
tags:
- name: Authentication
- name: Student Verification and OTP
- name: Password Reset
description: Shared OTP-based password recovery for supported STUDENT and ADMIN accounts.
- name: Student Dashboard
description: Authenticated Student summary metrics sourced from persisted backend data.
- name: Student Profile
description: Authenticated Student-owned profile, CV-supporting records, and profile file operations.
- name: Declared Skills and Taxonomy
- name: Project Portfolio
- name: Academic Records
- name: CV Generation and Active CV
- name: Admin Dashboard
- name: Academic Ledger
- name: Registered Students
- name: Company Metadata
- name: Internship Requests
- name: Candidate Filtering
- name: Shortlists
- name: Exports
- name: Audit/System Events
paths:
/auth/student/login:
post:
tags:
- Authentication
summary: Authenticate a Student using university email and password.
operationId: postAuthStudentLogin
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/AuthTokenResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public. Audit: Security. Authenticates an existing Student account only; no Admin approval, company
login, or temporary-password workflow.'
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StudentLoginRequest'
/auth/admin/login:
post:
tags:
- Authentication
summary: Authenticate a predefined Department Admin.
operationId: postAuthAdminLogin
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/AuthTokenResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public. Audit: Security. Authenticates a predefined, enabled Department Admin only; no Admin self-registration
or account creation is permitted.'
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminLoginRequest'
/auth/logout:
post:
tags:
- Authentication
summary: End the current authenticated session or token context.
operationId: postAuthLogout
responses:
'204':
description: No content.
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Student/Admin. Audit: Security. No request body is required. The backend invalidates server-side
session or refresh-token state where supported; clients must clear local auth state.'
/auth/me:
get:
tags:
- Authentication
summary: Return current authenticated user context and role claims.
operationId: getAuthMe
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentUserResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description: 'Access: Student/Admin. Audit: Security. Frontend route guards cannot replace backend authorization.'
/student-verifications:
post:
tags:
- Student Verification and OTP
summary: Start Student sign-up auto-verification using full name, index number and university email.
operationId: postStudentVerifications
responses:
'201':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/StudentVerificationResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public. Audit: Security. Full name is display data only; index number and university email are
verification authority.'
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StudentVerificationStartRequest'
/student-verifications/{verificationId}/otp/verify:
post:
tags:
- Student Verification and OTP
summary: Verify the OTP issued after successful student auto-verification.
operationId: postStudentVerificationsByVerificationIdOtpVerify
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/OtpVerifyResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description: 'Access: Public. Audit: Security. Raw OTP is never returned or logged.'
security: []
parameters:
- name: verificationId
in: path
required: true
schema:
type: string
format: uuid
description: verificationId identifier.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OtpVerifyRequest'
/student-verifications/{verificationId}/otp/resend:
post:
tags:
- Student Verification and OTP
summary: Resend a valid OTP after expiry or non-delivery subject to rate limits.
operationId: postStudentVerificationsByVerificationIdOtpResend
responses:
'202':
description: OTP resend request accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/OtpResendResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public. Audit: Security. Enforces expiry, resend cooldown, resend limits, and anti-abuse controls.
Raw OTP values are never returned or logged.'
security: []
parameters:
- name: verificationId
in: path
required: true
schema:
type: string
format: uuid
description: verificationId identifier.
/student-verifications/{verificationId}/password:
post:
tags:
- Student Verification and OTP
summary: Create initial Student password after OTP verification.
operationId: postStudentVerificationsByVerificationIdPassword
responses:
'204':
description: Initial Student password created successfully; no response body.
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public with a verified onboarding context. Audit: Security. Creates the initial Student password
hash only; no temporary password is generated or returned.'
security: []
parameters:
- name: verificationId
in: path
required: true
schema:
type: string
format: uuid
description: verificationId identifier.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordCreateRequest'
/password-resets:
post:
tags:
- Password Reset
summary: Start OTP-based password reset for a supported Student or Admin account.
operationId: postPasswordResets
responses:
'202':
description: Password-reset request accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetResponse'
'400':
$ref: '#/components/responses/Error400'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public. Audit: Security. Supports STUDENT and predefined ADMIN accounts. For every syntactically
valid request, the API returns the same 202 status and safe response shape. The response must not confirm whether
an eligible account exists. This endpoint never creates accounts, approves registrations, or issues temporary passwords.'
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetStartRequest'
/password-resets/{resetId}/otp/verify:
post:
tags:
- Password Reset
summary: Verify the OTP for an active password-reset context.
operationId: postPasswordResetsByResetIdOtpVerify
responses:
'200':
description: Password-reset OTP verified.
content:
application/json:
schema:
$ref: '#/components/schemas/OtpVerifyResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public with a valid reset context. Audit: Security. Enforces OTP expiry, verification-attempt
limits, and rate limits. Raw OTP values are never returned or logged.'
security: []
parameters:
- name: resetId
in: path
required: true
schema:
type: string
format: uuid
description: resetId identifier.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OtpVerifyRequest'
/password-resets/{resetId}/otp/resend:
post:
tags:
- Password Reset
summary: Resend the OTP for an active password-reset context.
operationId: postPasswordResetsByResetIdOtpResend
responses:
'202':
description: Password-reset OTP resend request accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/OtpResendResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public with a valid reset context. Audit: Security. Enforces expiry, resend cooldown, resend limits,
and anti-abuse controls. Raw OTP values are never returned or logged.'
security: []
parameters:
- name: resetId
in: path
required: true
schema:
type: string
format: uuid
description: Opaque resetId identifier.
/password-resets/{resetId}/password:
post:
tags:
- Password Reset
summary: Set a new password after successful password-reset OTP verification.
operationId: postPasswordResetsByResetIdPassword
responses:
'204':
description: Password updated successfully; no response body.
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Public with a verified reset context. Audit: Security. Updates only the password hash, closes
the reset context, and returns no password or temporary credential.'
security: []
parameters:
- name: resetId
in: path
required: true
schema:
type: string
format: uuid
description: resetId identifier.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordCreateRequest'
/me/dashboard/metrics:
get:
tags:
- Student Dashboard
summary: Retrieve persisted summary metrics for the authenticated Student dashboard.
operationId: getMeDashboardMetrics
description:
'Access: Student. Audit: No. Returns only the authenticated Student’s persisted project, declared-skill,
shortlist, and official GPA summary values. Counts are never calculated from frontend demo data. A null officialCumulativeGpa
means no committed GPA is available.'
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/StudentDashboardMetricsResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
/me/profile:
get:
tags:
- Student Profile
summary: Retrieve the authenticated Student profile and immutable identity fields.
operationId: getMeProfile
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/StudentProfileResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Student. Audit: No. Returns only the authenticated Student’s profile, immutable identity values,
read-only Student level/cohort context, current profile photo metadata, and entity version.'
patch:
tags:
- Student Profile
summary: Update editable profile fields and CV-supporting profile summary.
operationId: patchMeProfile
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/StudentProfileResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'428':
$ref: '#/components/responses/Error428'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Student. Audit: Yes. Updates only editable own-profile fields. Index number, university email,
Student level, and cohort year are immutable and are not accepted in the request body. Successful changes must update
CV-source freshness metadata.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StudentProfileUpdateRequest'
parameters:
- $ref: '#/components/parameters/IfMatchVersion'
/me/profile/upload-policy:
get:
tags:
- Student Profile
summary: Retrieve the active upload constraints for Student profile files.
operationId: getMeProfileUploadPolicy
description:
'Access: Student. Audit: No. Returns server-controlled MIME-type and maximum-size limits so the frontend
can validate and display accurate upload guidance without hardcoded limits.'
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileUploadPolicyResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
/me/profile/photo:
put:
tags:
- Student Profile
summary: Upload or replace the authenticated Student profile photo.
operationId: putMeProfilePhoto
description:
'Access: Student. Audit: Yes. Replaces the current profile photo atomically after ownership, MIME-type,
size, and file-safety validation. Returns the updated Profile and incremented version.'
parameters:
- $ref: '#/components/parameters/IfMatchVersion'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
additionalProperties: false
required:
- file
properties:
file:
type: string
format: binary
description: Profile image that satisfies the current profilePhoto upload policy.
responses:
'200':
description: Profile photo updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/StudentProfileResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'413':
$ref: '#/components/responses/Error413'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'428':
$ref: '#/components/responses/Error428'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
delete:
tags:
- Student Profile
summary: Remove the authenticated Student profile photo.
operationId: deleteMeProfilePhoto
description:
'Access: Student. Audit: Yes. Removes only the authenticated Student’s current profile photo and returns
the updated Profile.'
parameters:
- $ref: '#/components/parameters/IfMatchVersion'
responses:
'200':
description: Profile photo removed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/StudentProfileResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'428':
$ref: '#/components/responses/Error428'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
/me/profile/contact-links:
get:
tags:
- Student Profile
summary: List own Student contact link records used by profile and CV generation.
operationId: getMeProfileContactLinks
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/PagedContactLinkResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description:
'Access: Student. Audit: No. Own records only. Search applies to label and URL. Approved sort fields: displayOrder,
label, createdAt, updatedAt.'
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/Size'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Search'
post:
tags:
- Student Profile
summary: Create an own Student contact link record.
operationId: postMeProfileContactLinks
responses:
'201':
description: Resource created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactLinkResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'409':
$ref: '#/components/responses/Error409'
'412':
$ref: '#/components/responses/Error412'
'415':
$ref: '#/components/responses/Error415'
'422':
$ref: '#/components/responses/Error422'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
'503':
$ref: '#/components/responses/Error503'
description: 'Access: Student. Audit: Yes. Own records only.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ContactLinkCreateRequest'
/me/profile/contact-links/{contactLinkId}:
patch:
tags:
- Student Profile
summary: Update an own Student contact link record.
operationId: patchMeProfileContactLinksByContactLinkId
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactLinkResponse'
'400':
$ref: '#/components/responses/Error400'