-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
448 lines (438 loc) · 16 KB
/
openapi.yaml
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
openapi: 3.1.0
info:
title: Perfect Match API
version: 1.0.0
components:
schemas:
Profile:
type: object
properties:
complete:
type: boolean
firstName:
type: string
lastName:
type: string
gender:
type: string
genderPref:
type: array
items:
type: string
age:
type: integer
height:
type: integer
city:
type: string
race:
type: array
items:
type: string
year:
type: string
college:
type: string
major:
type: string
commitment:
type: string
relationshipType:
type: string
agePref:
type: object
properties:
youngest:
type: integer
oldest:
type: integer
activities:
type: array
items:
type: string
describeYourself:
type: string
bio:
type: string
Survey:
type: object
properties:
complete:
type: boolean
p1: { type: string, enum: survey.range }
p2: { type: string, enum: survey.range }
p3: { type: string, enum: survey.range }
p4: { type: string, enum: survey.range }
p5: { type: string, enum: survey.range }
p6: { type: string, enum: survey.range }
p7: { type: string, enum: survey.range }
p8: { type: string, enum: survey.range }
p9: { type: string, enum: survey.range }
p10: { type: String, enum: survey.range }
p11: { type: String, enum: survey.range }
p12: { type: String, enum: survey.range }
p13: { type: String, enum: survey.range }
p14: { type: String, enum: survey.range }
p15: { type: String, enum: survey.range }
p16: { type: String, enum: survey.range }
p17: { type: String, enum: survey.range }
p18: { type: String, enum: survey.range }
p19: { type: String, enum: survey.range }
generalPersonality: { type: String }
introvert: { type: Number }
introvert_same: { type: String }
easygoing: { type: Number }
easygoing_same: { type: String }
numdated: { type: Number }
longestrelationship: { type: Number }
ricePurity: { type: String }
pairedwith: { type: String }
apps: { type: Array, items: { type: String } }
politics: { type: Number }
politically_active: { type: Number }
habits:
type: object
properties:
drinking: { type: String }
smoking: { type: String }
weed: { type: String }
other: { type: String }
partner_habits:
type: object
properties:
drinking: { type: String }
smoking: { type: String }
weed: { type: String }
other: { type: String }
deal_breakers:
type: Array
items: { type: String }
partner_deal_breakers:
type: Array
items: { type: String }
User:
type: object
properties:
email:
type: string
format: email
optIn:
type: boolean
profile:
$ref: '#/components/schemas/Profile'
survey:
$ref: '#/components/schemas/Survey'
crushes:
type: Array
items: { type: string }
forbidden:
type: Array
items: { type: string }
matches:
type: Array
items:
type: string
format: objectId
matchReviews:
type: Array
items:
type: string
format: objectId
collab:
type: object
properties:
mutual: { type: boolean }
categoryRanking:
type: Array
items: { type: number }
feedback:
$ref: '#/components/schemas/SurveyFeedback'
Match:
type: object
properties:
partnerAId:
type: string
format: objectId
partnerBId:
type: string
format: objectId
partnerAFeedback:
$ref: '#/components/schemas/MatchFeedback'
partnerBFeedback:
$ref: '#/components/schemas/MatchFeedback'
overallStatus:
type: string
enum: ['pending', 'complete', 'partial']
MatchFeedback:
type: object
properties:
overallRating:
type: number
topReasonForRating:
type: string
metMatch:
type: boolean
numberOfDates:
type: number
inRelationshipWithMatch:
type: boolean
additionalComments:
type: string
dateSubmitted:
type: string
format: date-time
SurveyFeedback:
type: object
properties:
bad:
type: boolean
opportunities:
type: boolean
fun:
type: boolean
joy:
type: boolean
memories:
type: boolean
anticipation:
type: boolean
categoryRanking:
type: Array
items: { type: string }
surveyFeedback:
type: string
otherValentinesDayImpact:
type: string
comments:
type: string
paths:
/api/mutual/matches:
post:
summary: Fetch mutual verified matches
description: This endpoint fetches mutual verified matches for a user with a valid API key, email, and OTP.
operationId: fetchMutualMatches
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- apiKey
- email
- otp
properties:
apiKey:
type: string
email:
type: string
format: email
otp:
type: string
responses:
'200':
description: Successful response with mutual matches
'400':
description: Bad request, invalid inputs
/api/mutual/otp:
post:
summary: Request One-Time Password
description: Requests an OTP for a given email address and validates the API token.
operationId: requestOTP
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- apiKey
properties:
email:
type: string
format: email
apiKey:
type: string
responses:
'200':
description: OTP request successful
'400':
description: Bad request, invalid inputs
/api/review/{matchid}:
post:
summary: Update match review
description: Updates match review details for a given match ID.
operationId: updateMatchReview
parameters:
- name: matchid
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MatchFeedback'
responses:
'200':
description: Match review updated successfully
'400':
description: Bad request, invalid inputs
/api/count:
get:
summary: Retrieve total user count
description: Fetches the total count of registered users.
operationId: getUserCount
responses:
'200':
description: Total user count
content:
application/json:
schema:
type: integer
/api/feedback:
post:
summary: Update user feedback
description: Updates user feedback and returns the updated user profile.
operationId: updateUserFeedback
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SurveyFeedback'
responses:
'200':
description: User feedback updated and profile returned
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
'400':
description: Bad request or invalid session
/api/matches:
get:
summary: Retrieve user matches
description: Retrieves matches for the authenticated user.
operationId: getUserMatches
responses:
'200':
description: List of user matches
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Match'
/api/optin:
post:
summary: Update opt-in status
description: Updates the user's opt-in status for receiving updates or newsletters.
operationId: updateOptInStatus
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- optIn
properties:
optIn:
type: boolean
responses:
'200':
description: Opt-in status updated
'400':
description: Bad request or invalid session
/api/profile:
get:
summary: Retrieve user profile
description: Returns the user's profile details after authentication.
responses:
'200':
description: User profile data retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
'401':
description: Unauthorized access.
post:
summary: Update user profile
description: Updates the user's profile details after authentication.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
responses:
'200':
description: User profile updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
'401':
description: Unauthorized access.
/api/restrict:
post:
summary: Update user's restrictions
description: Updates the user's list of crushes and forbidden users after authentication.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RestrictionUpdate'
responses:
'200':
description: Restriction list updated successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
'401':
description: Unauthorized access.
/api/survey:
post:
summary: Update survey
description: Updates the user's survey details after authentication.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Survey'
responses:
'200':
description: Survey updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Survey'
'401':
description: Unauthorized access.
/api/users:
get:
summary: Retrieve list of users
description: Returns a list of users after verifying admin privileges.
responses:
'200':
description: List of users retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
'401':
description: Unauthorized access.
'403':
description: Access forbidden.