-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
568 lines (567 loc) · 16.2 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
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
openapi: 3.0.3
info:
title: Example
version: 0.0.1
description: My vision of an architectural backend using clean architecture and DDD
contact:
email: fromsi665@gmail.com
name: FromSi
url: https://fromsi.net
externalDocs:
description: Find out more about OpenAPI 3.0.3
url: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
servers:
- url: localhost:8080
description: make run
tags:
- name: auth
description: Authorization User
externalDocs:
url: https://github.com/FromSi/example/blob/master/internal/app/apiserver/presentation/controllers/auth.go
description: Go Controllers
- name: user
description: User Profiles
externalDocs:
url: https://github.com/FromSi/example/blob/master/internal/app/apiserver/presentation/controllers/user.go
description: Go Controllers
- name: post
description: User Posts To Provide Information
externalDocs:
url: https://github.com/FromSi/example/blob/master/internal/app/apiserver/presentation/controllers/post.go
description: Go Controllers
paths:
/auth/login:
get:
summary: Get Mnemonic For Login
tags:
- auth
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- mnemonic
properties:
mnemonic:
type: string
format: bip39_mnemonic
example: 'number orphan liquid radio tray stadium they dune female sheriff tourist talent'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
summary: LogIn Or SignUp
tags:
- auth
requestBody:
content:
application/json:
schema:
type: object
properties:
mnemonic:
type: string
format: bip39_mnemonic
example: 'number orphan liquid radio tray stadium they dune female sheriff tourist talent'
refresh_token:
type: string
format: uuid
example: '09d0ce56-33ab-4fce-90bb-d2b4d6d844ba'
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- token_type
- access_token
- refresh_token
- access_token_expires_in
- refresh_token_expires_in
properties:
token_type:
type: string
format: string
example: bearer
enum:
- bearer
access_token:
type: string
format: jwt_hs256
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJleGFtcGxlIiwiYXVkIjoidXNlciIsInN1YiI6ImJjMXFmcG12N3kydnI2dGs1MHZ4bHlodHA2cGh6MHp0cnFtc2Fud2E2dCIsImlhdCI6MTUxNjIzOTAyMiwiZXhwIjoxNTE2MzAwMDAwfQ.GWtkHCOw1bl6PjwPdSDqwRDi_5bXz4w6tSHzkTVWkQ0'
refresh_token:
type: string
format: uuid
example: '09d0ce56-33ab-4fce-90bb-d2b4d6d844ba'
access_token_expires_in:
type: integer
format: unix
example: 1516300000
refresh_token_expires_in:
type: integer
format: unix
example: 1516300000
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/auth/sessions:
get:
summary: Get User Sessions
tags:
- auth
security:
- BearerAuth: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- id
- agent
- ip
- created_at
- updated_at
properties:
id:
type: string
format: uuid
example: '09d0ce56-33ab-4fce-90bb-d2b4d6d844ba'
user_id:
type: string
format: bech32
example: 'bc1qfpmv7y2vr6tk50vxlyhtp6phz0ztrqmsanwa6t'
agent:
type: string
format: text
example: 'Mozilla/5.0 (X11; Linux x86_64; rv:121.0)'
ip:
type: string
format: text
example: '1.1.1.1'
expired_at:
type: string
format: date-time
example: 2024-07-16T21:31:26.335809566+05:00
created_at:
type: string
format: date-time
example: 2024-07-16T21:31:26.335809566+05:00
updated_at:
type: string
format: date-time
example: 2024-07-16T21:31:26.335809566+05:00
/auth/revoke:
post:
summary: Revoke User Session
tags:
- auth
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
session_id:
type: string
format: uuid
example: '09d0ce56-33ab-4fce-90bb-d2b4d6d844ba'
refresh_token:
type: string
format: uuid
example: '09d0ce56-33ab-4fce-90bb-d2b4d6d844ba'
responses:
'200':
description: Successful
/users/my:
get:
summary: Get The Profile Of The Current User
tags:
- user
security:
- BearerAuth: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- id
properties:
id:
type: string
format: bech32
example: 'bc1qfpmv7y2vr6tk50vxlyhtp6phz0ztrqmsanwa6t'
/users/{id}:
get:
summary: Get The Profile Of The Current User
tags:
- user
parameters:
- name: id
in: path
description: ID of user
required: true
schema:
$ref: '#/components/schemas/Bech32Query'
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- id
properties:
id:
type: string
format: bech32
example: 'bc1qfpmv7y2vr6tk50vxlyhtp6phz0ztrqmsanwa6t'
/posts:
post:
summary: Create New Post
tags:
- post
requestBody:
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
type: string
format: text
example: Hello World!
responses:
'202':
description: Successful
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
summary: Get List Post
tags:
- post
parameters:
- name: page1
in: query
description: Page of pageable
required: false
schema:
$ref: '#/components/schemas/PageQuery'
- name: limit
in: query
description: Limit of pageable
required: false
schema:
$ref: '#/components/schemas/LimitQuery'
- name: sort[id]
in: query
description: Multy-Sort by fields
required: false
schema:
$ref: '#/components/schemas/SortQuery'
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
required:
- data
- pageable
properties:
data:
type: array
items:
type: object
required:
- id
- text
- created_at
- updated_at
properties:
id:
type: string
format: uuid
example: '09d0ce56-33ab-4fce-90bb-d2b4d6d844ba'
text:
type: string
format: text
example: Hello World!
created_at:
type: string
format: date-time
example: 2024-07-16T21:31:26.335809566+05:00
updated_at:
type: string
format: date-time
example: 2024-07-16T21:31:26.335809566+05:00
pageable:
$ref: '#/components/schemas/Pageable'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
/posts/{id}:
get:
summary: Get One Post By ID
tags:
- post
parameters:
- name: id
in: path
description: ID of post
required: true
schema:
$ref: '#/components/schemas/UUIDQuery'
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- id
- text
- created_at
- updated_at
properties:
id:
type: string
format: uuid
example: '09d0ce56-33ab-4fce-90bb-d2b4d6d844ba'
text:
type: string
format: text
example: Hello World!
created_at:
type: string
format: date-time
example: 2024-07-16T21:31:26.335809566+05:00
updated_at:
type: string
format: date-time
example: 2024-07-16T21:31:26.335809566+05:00
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
'410':
description: Deleted
patch:
summary: Update One Post By ID
tags:
- post
parameters:
- name: id
in: path
description: ID of post
required: true
schema:
$ref: '#/components/schemas/UUIDQuery'
requestBody:
content:
application/json:
schema:
type: object
properties:
text:
type: string
format: text
example: Hello World!
responses:
'202':
description: Successful
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Delete One Post By ID
tags:
- post
parameters:
- name: id
in: path
description: ID of post
required: true
schema:
$ref: '#/components/schemas/UUIDQuery'
responses:
'202':
description: Successful
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
summary: Restore One Post By ID
tags:
- post
parameters:
- name: id
in: path
description: ID of post
required: true
schema:
$ref: '#/components/schemas/UUIDQuery'
responses:
'202':
description: Successful
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
Error:
type: object
required:
- data
properties:
data:
type: object
required:
- message
properties:
message:
type: string
format: text
example: Any Message
Pageable:
type: object
required:
- pageable
properties:
pageable:
type: object
required:
- total
- total_pages
- next
- page
- prev
- limit
properties:
total:
type: integer
format: int64
example: 1
total_pages:
type: integer
format: int64
example: 1
next:
type: integer
format: int64
example: 1
page:
type: integer
format: int64
example: 1
prev:
type: integer
format: int64
example: 1
limit:
type: integer
format: int64
example: 25
UUIDQuery:
type: string
format: uuid
example: '09d0ce56-33ab-4fce-90bb-d2b4d6d844ba'
Bech32Query:
type: string
format: bech32
example: 'bc1qfpmv7y2vr6tk50vxlyhtp6phz0ztrqmsanwa6t'
PageQuery:
type: integer
format: int64
example: 1
LimitQuery:
type: integer
format: int64
example: 25
SortQuery:
type: string
format: sort
example: desc
enum:
- asc
- desc