-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
1019 lines (1019 loc) · 23.9 KB
/
openapi.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
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: News Blog API
description: API documentation for developers of Vedina Co.
version: 1.0.0
contact: {}
servers:
- url: https://api.news.vedina.ir/v1
paths:
/admin-logs:
get:
tags:
- Admin Logs
summary: Get Admin Logs
description: Get Admin Logs
operationId: getAdminLogs
responses:
"200":
description: ""
post:
tags:
- Admin Logs
summary: Create Admin Log
description: Create Admin Log
operationId: createAdminLog
requestBody:
content:
application/json:
schema:
type: object
properties:
actionType:
type: string
example: create
description:
type: string
example: Created a new log.
userId:
type: number
example: 1
examples:
Create Admin Log:
value:
actionType: create
description: Created a new log.
userId: 1
responses:
"200":
description: ""
/admin-logs/{id}:
get:
tags:
- Admin Logs
summary: Get Admin Log by ID
description: Get Admin Log by ID
operationId: getAdminLogById
responses:
"200":
description: ""
delete:
tags:
- Admin Logs
summary: Delete Admin Log by ID
description: Delete Admin Log by ID
operationId: deleteAdminLogById
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
/categories:
get:
tags:
- Categories
summary: Get All Categories
description: Get All Categories
operationId: getAllCategories
parameters:
- name: search
in: query
schema:
type: string
example: استراتژی رشد
- name: limit
in: query
schema:
type: string
example: "100"
responses:
"200":
description: ""
security:
- bearerAuth: []
post:
tags:
- Categories
summary: Create Category
description: Create Category
operationId: createCategory
requestBody:
content:
application/json:
schema:
type: object
properties:
categoryName:
type: string
example: New Category
description:
type: string
example: This is a description.
path:
type: string
example: test
examples:
Create Category:
value:
categoryName: New Category
description: This is a description.
path: test
responses:
"200":
description: ""
security:
- bearerAuth: []
/categories/{id}:
get:
tags:
- Categories
summary: Get Category by ID
description: Get Category by ID
operationId: getCategoryById
responses:
"200":
description: ""
delete:
tags:
- Categories
summary: Delete Category by ID
description: Delete Category by ID
operationId: deleteCategoryById
responses:
"200":
description: ""
security:
- bearerAuth: []
patch:
tags:
- Categories
summary: Update Category by ID
description: Update Category by ID
operationId: updateCategoryById
requestBody:
content:
application/json:
schema:
type: object
properties:
category_name:
type: string
example: Updated Category
description:
type: string
example: Updated description.
examples:
Update Category by ID:
value:
category_name: Updated Category
description: Updated description.
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "14"
/comments:
get:
tags:
- Comments
summary: All Comments
description: All Comments
operationId: allComments
responses:
"200":
description: ""
security:
- bearerAuth: []
post:
tags:
- Comments
summary: Create Comment
description: Create Comment
operationId: createComment
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: number
example: 1
score:
type: number
example: 4
text:
type: string
example: This is a comment.
examples:
Create Comment:
value:
id: 1
score: 4
text: This is a comment.
responses:
"200":
description: ""
security:
- bearerAuth: []
/comments/news/{newsId}:
get:
tags:
- Comments
summary: Get Comments by News ID
description: Get Comments by News ID
operationId: getCommentsByNewsId
responses:
"200":
description: ""
parameters:
- name: newsId
in: path
required: true
schema:
type: string
/comments/{id}:
get:
tags:
- Comments
summary: Get Comment by ID
description: Get Comment by ID
operationId: getCommentById
responses:
"200":
description: ""
delete:
tags:
- Comments
summary: Delete Comment by ID
description: Delete Comment by ID
operationId: deleteCommentById
responses:
"200":
description: ""
security:
- bearerAuth: []
patch:
tags:
- Comments
summary: Update Comment by ID
description: Update Comment by ID
operationId: updateCommentById
requestBody:
content:
application/json:
schema:
type: object
properties:
commentText:
type: string
example: Updated comment text.
examples:
Update Comment by ID:
value:
commentText: Updated comment text.
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "14"
/comments/{id}/replies:
get:
tags:
- Comments
summary: Get Replies to a Comment
description: Get Replies to a Comment
operationId: getRepliesToAComment
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
/likes:
post:
tags:
- Likes
summary: Create Like
description: Create Like
operationId: createLike
requestBody:
content:
application/json:
schema:
type: object
properties:
newsId:
type: number
example: 1
examples:
Create Like:
value:
newsId: 1
responses:
"200":
description: ""
security:
- bearerAuth: []
/likes/news/{newsId}:
get:
tags:
- Likes
summary: Get Likes for News
description: Get Likes for News
operationId: getLikesForNews
responses:
"200":
description: ""
parameters:
- name: newsId
in: path
required: true
schema:
type: string
/likes/{id}:
delete:
tags:
- Likes
summary: Delete Like by ID
description: Delete Like by ID
operationId: deleteLikeById
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
/media:
post:
tags:
- Media
summary: Create Media
description: Create Media
operationId: createMedia
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: http://example.com/image.jpg
newsId:
type: number
example: 1
type:
type: string
example: webp
examples:
Create Media:
value:
id: http://example.com/image.jpg
newsId: 1
type: webp
responses:
"200":
description: ""
/media/news/{newsId}:
get:
tags:
- Media
summary: Get Media by News ID
description: Get Media by News ID
operationId: getMediaByNewsId
responses:
"200":
description: ""
parameters:
- name: newsId
in: path
required: true
schema:
type: string
/media/{id}:
get:
tags:
- Media
summary: Get Media by ID
description: Get Media by ID
operationId: getMediaById
responses:
"200":
description: ""
delete:
tags:
- Media
summary: Delete Media by ID
description: Delete Media by ID
operationId: deleteMediaById
responses:
"200":
description: ""
patch:
tags:
- Media
summary: Update Media by ID
description: Update Media by ID
operationId: updateMediaById
requestBody:
content:
application/json:
schema:
type: object
properties:
mediaType:
type: string
example: image
mediaUrl:
type: string
example: http://example.com/updated.jpg
examples:
Update Media by ID:
value:
mediaType: image
mediaUrl: http://example.com/updated.jpg
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
/news:
get:
tags:
- News
summary: List News
description: List News
operationId: listNews
parameters:
- name: search
in: query
schema:
type: string
example: ژورنال
- name: page
in: query
schema:
type: string
example: "1"
- name: limit
in: query
schema:
type: string
example: "30"
- name: category
in: query
schema:
type: string
example: business
responses:
"200":
description: ""
post:
tags:
- News
summary: Create News
description: Create News
operationId: createNews
requestBody:
content:
application/json:
schema:
type: object
properties:
categoryID:
type: number
example: 1
content:
type: string
example: Some news text.
description:
type: string
example: Some news text.
title:
type: string
example: New Title
examples:
Create News:
value:
categoryID: 1
content: Some news text.
description: Some news text.
title: New Title
responses:
"200":
description: ""
security:
- bearerAuth: []
/news/{id}:
get:
tags:
- News
summary: Get News by ID
description: Get News by ID
operationId: getNewsById
responses:
"200":
description: ""
delete:
tags:
- News
summary: Delete News by ID
description: Delete News by ID
operationId: deleteNewsById
responses:
"200":
description: ""
security:
- bearerAuth: []
patch:
tags:
- News
summary: Update News by ID
description: Update News by ID
operationId: updateNewsById
requestBody:
content:
application/json:
schema:
type: object
properties:
category_id:
type: number
example: 1
text:
type: string
example: Updated text.
title:
type: string
example: Updated Title
examples:
Update News by ID:
value:
category_id: 1
text: Updated text.
title: Updated Title
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "383"
/tags:
get:
tags:
- Tags
summary: Get All Tags
description: Get All Tags
operationId: getAllTags
responses:
"200":
description: ""
post:
tags:
- Tags
summary: Create Tag
description: Create Tag
operationId: createTag
requestBody:
content:
application/json:
schema:
type: object
properties:
tagName:
type: string
example: New Tag
examples:
Create Tag:
value:
tagName: New Tag
responses:
"200":
description: ""
/tags/{id}:
get:
tags:
- Tags
summary: Get Tag by ID
description: Get Tag by ID
operationId: getTagById
responses:
"200":
description: ""
delete:
tags:
- Tags
summary: Delete Tag by ID
description: Delete Tag by ID
operationId: deleteTagById
responses:
"200":
description: ""
patch:
tags:
- Tags
summary: Update Tag by ID
description: Update Tag by ID
operationId: updateTagById
requestBody:
content:
application/json:
schema:
type: object
properties:
tagName:
type: string
example: Updated Tag
examples:
Update Tag by ID:
value:
tagName: Updated Tag
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
/user-activity/user/{userId}:
get:
tags:
- User Activity Logs
summary: Get User Activity Logs
description: Get User Activity Logs
operationId: getUserActivityLogs
responses:
"200":
description: ""
parameters:
- name: userId
in: path
required: true
schema:
type: string
/user-activity/action/{actionType}:
get:
tags:
- User Activity Logs
summary: Get Logs by Action Type
description: Get Logs by Action Type
operationId: getLogsByActionType
responses:
"200":
description: ""
parameters:
- name: actionType
in: path
required: true
schema:
type: string
/user-roles:
get:
tags:
- User Roles
summary: Get All User Roles
description: Get All User Roles
operationId: getAllUserRoles
responses:
"200":
description: ""
post:
tags:
- User Roles
summary: Create User Role
description: Create User Role
operationId: createUserRole
requestBody:
content:
application/json:
schema:
type: object
properties:
permissions:
type: object
properties:
create:
type: boolean
example: true
roleName:
type: string
example: admin
examples:
Create User Role:
value:
permissions:
create: true
roleName: admin
responses:
"200":
description: ""
/user-roles/{id}:
get:
tags:
- User Roles
summary: Get User Role by ID
description: Get User Role by ID
operationId: getUserRoleById
responses:
"200":
description: ""
delete:
tags:
- User Roles
summary: Delete User Role by ID
description: Delete User Role by ID
operationId: deleteUserRoleById
responses:
"200":
description: ""
patch:
tags:
- User Roles
summary: Update User Role by ID
description: Update User Role by ID
operationId: updateUserRoleById
requestBody:
content:
application/json:
schema:
type: object
properties:
permissions:
type: object
properties:
edit:
type: boolean
example: true
roleName:
type: string
example: editor
examples:
Update User Role by ID:
value:
permissions:
edit: true
roleName: editor
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
/users:
get:
tags:
- Users
summary: List Users
description: List Users
operationId: listUsers
parameters:
- name: search
in: query
schema:
type: string
example: یوسف
responses:
"200":
description: ""
security:
- bearerAuth: []
post:
tags:
- Users
summary: Create User
description: Create User
operationId: createUser
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
name:
type: string
example: ترانه محمدی
password:
type: string
example: "@"
phone:
type: string
example: "09999553737"
role_id:
type: number
example: 1
examples:
Create User:
value:
email: [email protected]
name: ترانه محمدی
password: "@"
phone: "09999553737"
role_id: 1
responses:
"200":
description: ""
/users/{id}:
get:
tags:
- Users
summary: Get User by ID
description: Get User by ID
operationId: getUserById
responses:
"200":
description: ""
security:
- bearerAuth: []
delete:
tags:
- Users
summary: Delete User by ID
description: Delete User by ID
operationId: deleteUserById
responses:
"200":
description: ""
parameters:
- name: id
in: path
required: true
schema:
type: string
/users/stats:
get:
tags:
- Users
summary: Get Stats
description: Get Stats
operationId: getStats
responses:
"200":
description: ""
security:
- bearerAuth: []
/users/comments:
get:
tags:
- Users
summary: Get User Comments
description: Get User Comments
operationId: getUserComments
responses:
"200":
description: ""
security:
- bearerAuth: []
/users/favorites:
get:
tags:
- Users
summary: Get User Favorites
description: Get User Favorites
operationId: getUserFavorites
responses:
"200":
description: ""
security:
- bearerAuth: []
/users/:
patch:
tags:
- Users
summary: Update User by ID
description: Update User by ID
operationId: updateUserById
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
name:
type: string
example: ترانه محمدی
phone:
type: string
example: "09999557884"
examples:
Update User by ID:
value:
email: [email protected]
name: ترانه محمدی
phone: "09999557884"
responses:
"200":
description: ""
security:
- bearerAuth: []
/users/password:
put:
tags:
- Users
summary: Change Password
description: Change Password
operationId: changePassword
requestBody:
content:
application/json:
schema:
type: object
properties:
newPassword:
type: string
example: asba
oldPassword:
type: string
example: aaaa
examples:
Change Password:
value:
newPassword: asba
oldPassword: aaaa
responses:
"200":
description: ""
security:
- bearerAuth: []
/users/login:
post:
tags:
- Users
summary: User Login
description: User Login
operationId: userLogin
requestBody:
content:
application/json:
schema:
type: object
properties:
password:
type: string
example: "@"
username:
type: string
example: [email protected]
examples:
User Login:
value:
password: "@"
username: [email protected]