-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
736 lines (734 loc) · 18.2 KB
/
swagger.yml
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
basePath: /
consumes:
- application/json
definitions:
Comment:
properties:
body:
description: Body of the comment
maxLength: 255
minLength: 5
type: string
x-go-name: Body
createdAt:
description: Time comment was created at
type: string
x-go-name: CreatedAt
feedbackId:
description: Id of the feedback this comment is related to
format: int64
minimum: 1
type: integer
x-go-name: FeedbackId
id:
description: Id of the comment
format: int64
minimum: 1
type: integer
x-go-name: Id
parentId:
description: Id of the comment that this comment relates to
format: int64
minimum: 1
type: integer
x-go-name: ParentId
updatedAt:
description: Time comment was updated at
type: string
x-go-name: UpdatedAt
userId:
description: Id of the user who created the comment
format: int64
minimum: 1
type: integer
x-go-name: UserId
type: object
x-go-package: product-feedback/comment
CreateFeedbackInput:
properties:
body:
description: Body of the feedback
maxLength: 1000
minLength: 10
type: string
x-go-name: Body
category:
description: Category of the feedback
type: string
x-go-name: Category
status:
description: Status of the feedback
type: string
x-go-name: Status
title:
description: Title of the feedback
maxLength: 50
minLength: 5
type: string
x-go-name: Title
required:
- title
- body
- category
type: object
x-go-package: product-feedback/feedback
Feedback:
properties:
body:
description: Body of the feedback
maxLength: 1000
minLength: 10
type: string
x-go-name: Body
category:
description: |-
Category of the feedback
Possible categories: 'ui', 'ux', 'enhancement', 'bug', 'feature'
type: string
x-go-name: Category
createdAt:
description: Time feedback was created at
type: string
x-go-name: CreatedAt
id:
description: Id of the feedback
format: int64
minimum: 1
type: integer
x-go-name: Id
status:
description: |-
Status of the feedback
Possible statuses: 'idea', 'defined', 'in-progress', 'done'
type: string
x-go-name: Status
title:
description: Title of the feedback
maxLength: 50
minLength: 5
type: string
x-go-name: Title
updatedAt:
description: Time feedback was updated at
type: string
x-go-name: UpdatedAt
userId:
description: Id of a user who created a feedback
format: int64
minimum: 1
type: integer
x-go-name: UserId
type: object
x-go-package: product-feedback/feedback
UpdateFeedbackInput:
properties:
body:
description: Body of the feedback
maxLength: 1000
minLength: 10
type: string
x-go-name: Body
category:
description: Category of the feedback
type: string
x-go-name: Category
status:
description: Status of the feedback
type: string
x-go-name: Status
title:
description: Title of the feedback
maxLength: 50
minLength: 5
type: string
x-go-name: Title
type: object
x-go-package: product-feedback/feedback
User:
properties:
avatar_url:
description: Avatar URL
type: string
x-go-name: AvatarUrl
created_at:
description: Time the user was created at
type: string
x-go-name: CreatedAt
email:
description: Email of the user
example: user@company.com
type: string
x-go-name: Email
id:
description: Id of the user
format: int64
minimum: 1
type: integer
x-go-name: Id
name:
description: Name of the user
maxLength: 50
minLength: 2
type: string
x-go-name: Name
updated_at:
description: Time the user was updated at
type: string
x-go-name: UpdatedAt
user_name:
description: User name
maxLength: 50
minLength: 2
type: string
x-go-name: UserName
type: object
x-go-package: product-feedback/user
Vote:
properties:
createdAt:
description: Time this vote was created at
type: string
x-go-name: CreatedAt
feedbackId:
description: Feedback id that this vote is related to
format: int64
minimum: 1
type: integer
x-go-name: FeedbackId
id:
description: Id of the vote
format: int64
minimum: 1
type: integer
x-go-name: Id
updatedAt:
description: Time this vote was updated at
type: string
x-go-name: UpdatedAt
userId:
description: Id of a user that created this vote
format: int64
minimum: 1
type: integer
x-go-name: UserId
type: object
x-go-package: product-feedback/vote
createCommentInput:
properties:
body:
description: Body of the comment
maxLength: 255
minLength: 5
type: string
x-go-name: Body
feedbackId:
description: Id of the feedback this comment is related to
format: int64
minimum: 1
type: integer
x-go-name: FeedbackId
parentId:
description: Id of the comment that this comment relates to
format: int64
minimum: 1
type: integer
x-go-name: ParentId
required:
- body
- feedbackId
type: object
x-go-package: product-feedback/comment
createVoteInput:
properties:
feedbackId:
description: The id of the feedback vote is related to
format: int64
minimum: 1
type: integer
x-go-name: FeedbackId
required:
- feedbackId
type: object
x-go-package: product-feedback/vote
toggleVoteInput:
properties:
feedbackId:
description: The id of the feedback vote is related to
format: int64
minimum: 1
type: integer
x-go-name: FeedbackId
required:
- feedbackId
type: object
x-go-package: product-feedback/vote
refreshAccessTokenInput:
properties:
refreshToken:
description: |-
Refresh token in format of JWT is used to get
access token in exchange
type: string
x-go-name: RefreshToken
required:
- refreshToken
type: object
x-go-package: product-feedback/auth
info:
description: Documentation Product Feedback API
title: Product Feedback API
version: 1.0.0
paths:
/api/auth/github:
get:
description: Redirects to GitHub authentication
operationId: loginWithGitHub
parameters:
- description: |-
Code to handle login with GitHub.
GitHub itself provides it.
in: query
name: code
required: true
type: string
x-go-name: Code
responses:
"302":
$ref: '#/responses/foundResponse'
tags:
- auth
/api/auth/github/callback:
get:
description: Redirects to GitHub authentication
operationId: loginWithGitHub
parameters:
- description: |-
Code to handle login with GitHub.
GitHub itself provides it.
in: query
name: code
required: true
type: string
x-go-name: Code
responses:
"302":
$ref: '#/responses/foundResponse'
tags:
- auth
/api/auth/refresh-token:
post:
description: Redirects to GitHub authentication
operationId: refreshAccessToken
parameters:
- description: Refresh token is used to get access token
in: body
name: Body
required: true
schema:
$ref: '#/definitions/refreshAccessTokenInput'
responses:
"200":
$ref: '#/responses/refreshAccessTokenResponse'
"403":
$ref: '#/responses/errorResponse'
tags:
- auth
/api/comments:
get:
description: Returns a list of all comments in the system
operationId: getAllComments
parameters:
- description: |-
Feedback id can be used to filter out
comments by feedback they relate to.
It's possible to pass multimple feedback ids
(ids should be comma delimited).
example: /api/comments?feedbackId=1,2,3,4,5
in: query
name: feedbackId
type: string
x-go-name: FeedbackId
responses:
"200":
$ref: '#/responses/getAllCommentsResponse'
security:
- Bearer: []
tags:
- comments
post:
description: Creates a comment
operationId: createComment
parameters:
- description: Comment data structure to create comment
in: body
name: Body
required: true
schema:
$ref: '#/definitions/createCommentInput'
responses:
"200":
$ref: '#/responses/createCommentResponse'
security:
- Bearer: []
tags:
- comments
/api/comments/:id:
get:
description: Returns comment by id
operationId: getCommentById
parameters:
- description: The id of the commnet for which the operation relates
format: int64
in: path
name: Id
required: true
type: integer
responses:
"200":
$ref: '#/responses/getCommentByIdResponse'
"404":
$ref: '#/responses/errorResponse'
security:
- Bearer: []
tags:
- comments
/api/feedback:
get:
description: Returns all product feedback in the system
operationId: getAllFeedback
responses:
"200":
$ref: '#/responses/getAllFeedbackResponse'
security:
- Bearer: []
tags:
- feedback
post:
description: Create product feedback
operationId: createFeedback
parameters:
- description: Feedback data structure to create feedback
in: body
name: Body
required: true
schema:
$ref: '#/definitions/CreateFeedbackInput'
responses:
"200":
$ref: '#/responses/createFeedbackResponse'
security:
- Bearer: []
tags:
- feedback
/api/feedback/:id:
delete:
description: Delete product feedback
operationId: deleteFeedback
parameters:
- description: The id of the feedback for which the operation relates
format: int64
in: path
name: id
required: true
type: integer
x-go-name: Id
responses:
"200":
$ref: '#/responses/okResponse'
"404":
$ref: '#/responses/errorResponse'
security:
- Bearer: []
tags:
- feedback
get:
description: Returns product feedback by id
operationId: getFeedbackById
parameters:
- description: The id of the feedback for which the operation relates
format: int64
in: path
name: id
required: true
type: integer
x-go-name: Id
responses:
"200":
$ref: '#/responses/getFeedbackByIdResponse'
"404":
$ref: '#/responses/errorResponse'
security:
- Bearer: []
tags:
- feedback
put:
description: Returns product feedback by id
operationId: updateFeedback
parameters:
- description: Feedback data structure to update feedback
in: body
name: Body
required: true
schema:
$ref: '#/definitions/UpdateFeedbackInput'
- description: The id of the feedback for which the operation relates
format: int64
in: path
name: id
required: true
type: integer
x-go-name: Id
responses:
"200":
$ref: '#/responses/okResponse'
"400":
$ref: '#/responses/errorResponse'
"404":
$ref: '#/responses/errorResponse'
security:
- Bearer: []
tags:
- feedback
/api/users/:id:
get:
description: Returs user data by id
operationId: getUserById
parameters:
- description: The id of the user for which the operation relates
format: int64
in: path
name: id
required: true
type: integer
x-go-name: Id
responses:
"200":
$ref: '#/responses/getUserResponse'
"404":
$ref: '#/responses/errorResponse'
security:
- Bearer: []
tags:
- users
/api/users:
get:
description: Returns a list of all users in the system
operationId: getAllUsers
parameters:
- description: |-
Parameter 'userId' can be used to filter out
users by IDs.
It's possible to pass multimple IDs
(IDs should be comma delimited).
example: /api/users?userId=1,2,3,4,5
in: query
name: userId
type: string
x-go-name: userId
responses:
"200":
$ref: '#/responses/getAllUsersResponse'
"400":
$ref: '#/responses/errorResponse'
"500":
$ref: '#/responses/errorResponse'
security:
- Bearer: []
tags:
- users
/api/users/me:
get:
description: Returs user data
operationId: getMe
responses:
"200":
$ref: '#/responses/getUserResponse'
security:
- Bearer: []
tags:
- users
/api/votes:
get:
description: Returns a list of votes in the system
operationId: getAllVotes
parameters:
- description: |-
Feedback id can be used to filter out
votes by feedback they relate to.
It's possible to pass multimple feedback ids
(ids should be comma delimited).
example: /api/votes/?feedbackId=1,2
in: query
name: feedbackId
type: string
x-go-name: FeedbackId
responses:
"200":
$ref: '#/responses/getAllVotesResponse'
security:
- Bearer: []
tags:
- votes
post:
description: Creates a vote
operationId: createVote
parameters:
- description: Vote data structure to create vote
in: body
name: Body
required: true
schema:
$ref: '#/definitions/createVoteInput'
responses:
"200":
$ref: '#/responses/createVoteResponse'
security:
- Bearer: []
tags:
- votes
/api/votes/toggle:
post:
description: Toggles a vote
operationId: toggleVote
parameters:
- description: Data structure to toggle vote
in: body
name: Body
required: true
schema:
$ref: '#/definitions/toggleVoteInput'
responses:
"200":
$ref: '#/responses/okResponse'
"400":
$ref: '#/responses/errorResponse'
"500":
$ref: '#/responses/errorResponse'
security:
- Bearer: []
tags:
- votes
/api/votes/:id:
delete:
description: Deletes a vote
operationId: deleteVote
parameters:
- description: The id of the vote for which the operation relates
format: int64
in: path
name: id
required: true
type: integer
x-go-name: Id
responses:
"200":
$ref: '#/responses/okResponse'
"404":
$ref: '#/responses/errorResponse'
security:
- Bearer: []
tags:
- votes
produces:
- application/json
responses:
createCommentResponse:
description: Create comment response
schema:
properties:
commentId:
description: id of a newly created comment
type: string
x-go-name: CommentId
type: object
createFeedbackResponse:
description: OK response
schema:
properties:
feedbackId:
description: id of a newly created feedback
type: string
x-go-name: FeedbacId
type: object
createVoteResponse:
description: OK response
schema:
properties:
voteId:
description: id of a newly created vote
type: string
x-go-name: VoteId
type: object
errorResponse:
description: Error response
schema:
properties:
message:
description: Error message
type: string
x-go-name: Message
type: object
foundResponse:
description: Redirects to login route
getAllCommentsResponse:
description: Returns a list of all comments in the system
schema:
items:
$ref: '#/definitions/Comment'
type: array
getAllFeedbackResponse:
description: Returns all product feedback in the system
schema:
items:
$ref: '#/definitions/Feedback'
type: array
getAllUsersResponse:
description: Returns a list of all users in the system
schema:
items:
$ref: '#/definitions/User'
type: array
getAllVotesResponse:
description: OK response
schema:
items:
$ref: '#/definitions/Vote'
type: array
getCommentByIdResponse:
description: Returns a comment with the specified Id
schema:
$ref: '#/definitions/Comment'
getFeedbackByIdResponse:
description: Returns product feedback by id
schema:
$ref: '#/definitions/Feedback'
getUserResponse:
description: OK response
schema:
$ref: '#/definitions/User'
okResponse:
description: OK response
schema:
properties:
message:
description: OK message
type: string
x-go-name: Message
type: object
refreshAccessTokenResponse:
description: OK response
schema:
properties:
accessToken:
description: Access token
type: string
x-go-name: AccessToken
type: object
schemes:
- http
securityDefinitions:
Bearer:
in: header
name: Authorization
type: apiKey
swagger: "2.0"