-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
215 lines (213 loc) · 5.34 KB
/
swagger.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
swagger: '2.0'
info:
version: '1.0.0'
title: Referral System API
definitions:
User:
type: object
properties:
userId:
type: string
description: Unique identifier for the user
username:
type: string
description: Unique username
password:
type: string
description: Hashed password for security
balance:
type: number
description: User's balance
referralLink:
type: string
description: User's referral link
referralCount:
type: integer
description: Number of times the referral link has been used
referralExpiry:
type: string
format: date-time
description: Expiry date of the referral link
referralLinkUsageHistory:
type: array
items:
type: object
properties:
referralLink:
type: string
description: Referral link used
dateUsed:
type: string
format: date-time
description: Date when the link was used
users:
type: array
items:
type: string
description: Users who used the link
role:
type: string
enum: [user, admin]
description: User's role
paths:
/api/register:
post:
summary: Register a new user
parameters:
- in: body
name: user
schema:
$ref: '#/definitions/User'
responses:
'201':
description: User registered successfully
'400':
description: Validation error
'500':
description: Server error
/api/login:
post:
summary: Login a user
parameters:
- in: body
name: user
schema:
$ref: '#/definitions/User'
responses:
'200':
description: User logged in successfully
'400':
description: Validation error
'500':
description: Server error
/api/referral/verify:
post:
summary: Verify and use a referral link
parameters:
- in: body
name: user
schema:
$ref: '#/definitions/User'
responses:
'200':
description: Referral link verified successfully
'400':
description: Validation error
'500':
description: Server error
/api/add-balance:
post:
summary: Add balance to a user's account
parameters:
- in: body
name: user
schema:
$ref: '#/definitions/User'
responses:
'200':
description: Balance added successfully
'400':
description: Validation error
'500':
description: Server error
/api/referral/expire:
post:
summary: Expire a user's referral link
parameters:
- in: body
name: user
schema:
$ref: '#/definitions/User'
responses:
'200':
description: Referral link expired successfully
'400':
description: Validation error
'500':
description: Server error
/api/referral/generate:
get:
summary: Generate a referral link for a user
responses:
'200':
description: Referral link generated successfully
'429':
description: Too many requests
'500':
description: Server error
/api/balance:
get:
summary: Get a user's balance
responses:
'200':
description: Balance retrieved successfully
'500':
description: Server error
/api/myProfile:
get:
summary: Get a user's profile
responses:
'200':
description: User profile retrieved successfully
'500':
description: Server error
/api/users:
get:
summary: Get all users (admin only)
responses:
'200':
description: Users retrieved successfully
'403':
description: Forbidden
'500':
description: Server error
/api/users/{userId}:
get:
summary: Get a specific user by their ID (admin only)
parameters:
- in: path
name: userId
required: true
type: string
responses:
'200':
description: User retrieved successfully
'403':
description: Forbidden
'500':
description: Server error
put:
summary: Update a user's balance (admin only)
parameters:
- in: path
name: userId
required: true
type: string
- in: body
name: user
schema:
$ref: '#/definitions/User'
responses:
'200':
description: User balance updated successfully
'400':
description: Validation error
'403':
description: Forbidden
'500':
description: Server error
/api/referral/expire/{userId}:
put:
summary: Expire a user's referral link (admin only)
parameters:
- in: path
name: userId
required: true
type: string
responses:
'200':
description: Referral link expired successfully
'403':
description: Forbidden
'500':
description: Server error