forked from QuickLendX/quicklendx-protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
427 lines (412 loc) · 10.1 KB
/
Copy pathopenapi.yaml
File metadata and controls
427 lines (412 loc) · 10.1 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
openapi: 3.0.3
info:
title: QuickLendX API
description: Invoice factoring and lending platform API
version: 1.0.0
contact:
name: QuickLendX Team
servers:
- url: http://localhost:3000/api/v1
description: Development server
- url: https://api.quicklendx.com/v1
description: Production server
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
Error:
type: object
required:
- error
- message
properties:
error:
type: string
example: "VALIDATION_ERROR"
message:
type: string
example: "Invalid request parameters"
details:
type: object
additionalProperties: true
User:
type: object
required:
- id
- email
- role
- createdAt
properties:
id:
type: string
format: uuid
example: "550e8400-e29b-41d4-a716-446655440000"
email:
type: string
format: email
example: "user@example.com"
role:
type: string
enum: [investor, business, admin]
example: "investor"
kycStatus:
type: string
enum: [pending, approved, rejected]
example: "approved"
createdAt:
type: string
format: date-time
example: "2024-01-15T10:30:00Z"
updatedAt:
type: string
format: date-time
example: "2024-01-15T10:30:00Z"
Invoice:
type: object
required:
- id
- businessId
- amount
- currency
- dueDate
- status
properties:
id:
type: string
format: uuid
businessId:
type: string
format: uuid
amount:
type: string
pattern: '^\d+(\.\d{1,7})?$'
example: "10000.00"
currency:
type: string
enum: [USDC, EURC]
example: "USDC"
dueDate:
type: string
format: date-time
status:
type: string
enum: [pending, active, funded, settled, defaulted]
metadata:
type: object
additionalProperties: true
Bid:
type: object
required:
- id
- invoiceId
- investorId
- amount
- interestRate
- status
properties:
id:
type: string
format: uuid
invoiceId:
type: string
format: uuid
investorId:
type: string
format: uuid
amount:
type: string
pattern: '^\d+(\.\d{1,7})?$'
interestRate:
type: number
format: float
minimum: 0
maximum: 100
status:
type: string
enum: [pending, accepted, rejected, expired]
createdAt:
type: string
format: date-time
AuthResponse:
type: object
required:
- token
- user
properties:
token:
type: string
example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
refreshToken:
type: string
user:
$ref: '#/components/schemas/User'
paths:
/auth/login:
post:
summary: User login
tags: [Authentication]
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
format: email
password:
type: string
format: password
responses:
'200':
description: Successful login
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResponse'
'401':
description: Invalid credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/auth/register:
post:
summary: User registration
tags: [Authentication]
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
- role
properties:
email:
type: string
format: email
password:
type: string
format: password
minLength: 8
role:
type: string
enum: [investor, business]
responses:
'201':
description: User created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResponse'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/users/profile:
get:
summary: Get user profile
tags: [Users]
security:
- bearerAuth: []
responses:
'200':
description: User profile
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/invoices:
get:
summary: List invoices
tags: [Invoices]
security:
- bearerAuth: []
parameters:
- name: status
in: query
schema:
type: string
enum: [pending, active, funded, settled, defaulted]
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 20
- name: offset
in: query
schema:
type: integer
minimum: 0
default: 0
responses:
'200':
description: List of invoices
content:
application/json:
schema:
type: object
required:
- data
- total
properties:
data:
type: array
items:
$ref: '#/components/schemas/Invoice'
total:
type: integer
limit:
type: integer
offset:
type: integer
post:
summary: Create invoice
tags: [Invoices]
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- amount
- currency
- dueDate
properties:
amount:
type: string
pattern: '^\d+(\.\d{1,7})?$'
currency:
type: string
enum: [USDC, EURC]
dueDate:
type: string
format: date-time
metadata:
type: object
responses:
'201':
description: Invoice created
content:
application/json:
schema:
$ref: '#/components/schemas/Invoice'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/invoices/{invoiceId}:
get:
summary: Get invoice by ID
tags: [Invoices]
security:
- bearerAuth: []
parameters:
- name: invoiceId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Invoice details
content:
application/json:
schema:
$ref: '#/components/schemas/Invoice'
'404':
description: Invoice not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/bids:
post:
summary: Create bid
tags: [Bids]
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- invoiceId
- amount
- interestRate
properties:
invoiceId:
type: string
format: uuid
amount:
type: string
pattern: '^\d+(\.\d{1,7})?$'
interestRate:
type: number
format: float
minimum: 0
maximum: 100
responses:
'201':
description: Bid created
content:
application/json:
schema:
$ref: '#/components/schemas/Bid'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/health:
get:
summary: Health check
tags: [System]
responses:
'200':
description: Service is healthy
content:
application/json:
schema:
type: object
required:
- status
- timestamp
properties:
status:
type: string
enum: [healthy]
timestamp:
type: string
format: date-time
version:
type: string