-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yml
1184 lines (1177 loc) · 33.2 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.1.0'
info:
title: HaRSS API
description: An RSS API in rust
version: 0.9.0
contact:
name: Eric
email: eric@pedr0.net
url: https://pedr0.net
servers:
- url: 'https://api.dev.harss.net/api/v1'
description: Dev HaRSS Api, please be kind
- url: 'http://localhost:8080/api/v1'
description: Local HaRSS Api, for tests purpose
security:
- basicAuth: [ ]
- jwt: [ ]
tags:
- name: Channels
description: Channels related operation
- name: Items
description: Items, a.k.a articles related operation
- name: Authentication
description: Login and stuff
- name: Users
description: User management
- name: Miscellaneous
description: Miscellaneous stuff
paths:
/ping:
get:
operationId: ping
security: []
tags:
- Miscellaneous
summary: Check if the API is up
description: Check if the API is up by returning some Doom Eternal quotes
responses:
'200':
$ref: '#/components/responses/DoomQuoteResponse'
default:
$ref: '#/components/responses/Error'
/user/confirm-email/{token}:
get:
operationId: confirm_email
tags:
- Users
summary: Confirm email adress
description: Confirm the user's email
parameters:
- name: token
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
$ref: '#/components/responses/NoContent'
default:
$ref: '#/components/responses/Error'
/user/update-password:
patch:
operationId: update_password
tags:
- Users
summary: Update user's password
description: Update user's password
requestBody:
required: true
description: Update password request
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePasswordRequest'
responses:
'204':
$ref: '#/components/responses/NoContent'
default:
$ref: '#/components/responses/Error'
/user/reset-password-request:
post:
operationId: reset_password_token
security: []
tags:
- Users
summary: Request password reset token
description:
Request for a password reset token that will be sent by email. The user must have registred its email
requestBody:
required: true
description: Reset Password request
content:
application/json:
schema:
$ref: '#/components/schemas/ResetPasswordTokenRequest'
responses:
'204':
$ref: '#/components/responses/NoContent'
/user/reset-password:
post:
operationId: reset_password
security: []
tags:
- Users
summary: Reset password
description: Reset password using the given token
requestBody:
required: true
description: Reset forgotten password request
content:
application/json:
schema:
$ref: '#/components/schemas/ResetPasswordRequest'
responses:
'204':
$ref: '#/components/responses/NoContent'
default:
$ref: '#/components/responses/Error'
/user/{userId}:
delete:
operationId: delete_user
tags:
- Users
summary: Delete a user
description: |
Delete the given user.
The caller must be admin to delete any user, or can only delete itself.
parameters:
- name: userId
in: path
required: true
schema:
$ref: '#/components/schemas/UserID'
responses:
'204':
$ref: '#/components/responses/NoContent'
default:
$ref: '#/components/responses/Error'
/user/{userId}/update-password:
patch:
operationId: update_other_password
tags:
- Users
summary: Update other user's password
description: Update other user's password. Only admin can do this
parameters:
- name: userId
in: path
required: true
schema:
$ref: '#/components/schemas/UserID'
requestBody:
required: true
description: Update other's password request
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOtherPasswordRequest'
responses:
'204':
$ref: '#/components/responses/NoContent'
default:
$ref: '#/components/responses/Error'
/users:
get:
operationId: list_users
tags:
- Users
summary: Return a list of all users
description: |
__Available to administrators only.__
List all registered users.
parameters:
- $ref: '#/components/parameters/PageSizeParameter'
- $ref: '#/components/parameters/PageNumberParameter'
responses:
'200':
description: A list of registered users
content:
application/json:
schema:
$ref: '#/components/schemas/PagedUsers'
default:
$ref: '#/components/responses/Error'
post:
operationId: new_user
tags:
- Users
summary: Create a new user
description: |
__Available to administrators only or to everyone if specified in the configuration file.__
Register a new user.
requestBody:
required: true
description: User creation request.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
responses:
'201':
$ref: '#/components/responses/ObjectCreatedResponse'
default:
$ref: '#/components/responses/Error'
/user:
patch:
operationId: update_user
tags:
- Users
summary: Update your user
description: |
Update your user.
Currently support only email updates. An email will be sent to the new email address for confirmation.
requestBody:
required: true
description: User update request.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
responses:
'204':
$ref: '#/components/responses/NoContent'
'404':
$ref: '#/components/responses/NotFound'
/channels/search:
get:
operationId: search_channels
tags:
- Channels
summary: Returns a list of RSS channels for the given URL.
description: Fetch the content of the URL and search for RSS channels
parameters:
- name: url
in: query
required: true
example: "https://canardpc.com"
schema:
$ref: '#/components/schemas/WebsiteURL'
responses:
'200':
description: A list of found channels
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FoundChannel'
default:
$ref: '#/components/responses/Error'
/channels:
get:
operationId: get_channels
tags:
- Channels
summary: Returns a list of registered channels.
description: List all the rss channels registered.
parameters:
- $ref: '#/components/parameters/PageSizeParameter'
- $ref: '#/components/parameters/PageNumberParameter'
responses:
'200':
description: A list of channels
content:
application/json:
schema:
$ref: '#/components/schemas/PagedChannels'
default:
$ref: '#/components/responses/Error'
post:
operationId: new_channel
tags:
- Channels
summary: Register to a new channel.
description: Register to a new channel.
requestBody:
required: true
description: Channel registration request.
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterChannelRequest'
responses:
'201':
$ref: '#/components/responses/ObjectCreatedResponse'
default:
$ref: '#/components/responses/Error'
/channel/{channelId}:
parameters:
- name: channelId
in: path
description: Unique ID of a channel
required: true
example: 1
schema:
$ref: '#/components/schemas/ChannelID'
delete:
operationId: unsubscribe_channel
tags:
- Channels
summary: Unsubscribe from a single channel.
description: Unsubscribe from a single RSS channel.
responses:
'204':
$ref: '#/components/responses/NoContent'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/Error'
get:
operationId: get_channel
tags:
- Channels
summary: Retrieve a single channel.
description: Retrieve a single RSS channel information.
responses:
'200':
description: A single channel
content:
application/json:
schema:
$ref: '#/components/schemas/Channel'
default:
$ref: '#/components/responses/Error'
/channel/{channelId}/enable:
post:
operationId: enable_channel
tags:
- Channels
summary: Enable the channel and reset it's failure count.
description: Enable the channel and reset it's failure count.
parameters:
- name: channelId
in: path
description: Unique ID of a channel
required: true
example: 1
schema:
$ref: '#/components/schemas/ChannelID'
responses:
'204':
$ref: '#/components/responses/NoContent'
default:
$ref: '#/components/responses/Error'
/channel/{channelId}/read:
post:
operationId: mark_channel_as_read
tags:
- Channels
summary: Marks all the items of the channel as read
description: Marks all the items of the channel as read
parameters:
- name: channelId
in: path
description: Unique ID of a channel
required: true
example: 1
schema:
$ref: '#/components/schemas/ChannelID'
responses:
'204':
$ref: '#/components/responses/NoContent'
default:
$ref: '#/components/responses/Error'
/channel/{channelId}/errors:
get:
operationId: get_errors_of_channel
tags:
- Channels
summary: List fetch errors of channel
description: Return the list of errors of the given channel. Restricted to admin only
parameters:
- name: channelId
in: path
description: Unique ID of a channel
required: true
example: 1
schema:
$ref: '#/components/schemas/ChannelID'
responses:
'200':
description: A list of errors
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ChannelError'
default:
$ref: '#/components/responses/default'
/channel/{channelId}/items:
get:
operationId: get_items_of_channel
tags:
- Channels
- Items
summary: Returns items of a channel
description: Returns the list of items of the given channel
parameters:
- $ref: '#/components/parameters/PageSizeParameter'
- $ref: '#/components/parameters/PageNumberParameter'
- name: channelId
in: path
description: Unique ID of a channel
required: true
example: 1
schema:
$ref: '#/components/schemas/ChannelID'
responses:
'200':
description: A list of item
content:
application/json:
schema:
$ref: '#/components/schemas/PagedItems'
default:
$ref: '#/components/responses/Error'
/auth/login:
post:
operationId: login
tags:
- Authentication
summary: Create a JWT and a refresh token
security:
- { }
description: |
Creates a JWT/refresh token. The generated token is valid for 15 minutes. The refresh token is valid
for 5 days
requestBody:
required: true
description: Users credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequest'
responses:
'200':
description: A token pair
content:
application/json:
schema:
$ref: '#/components/schemas/Token'
'401':
$ref: '#/components/responses/Unauthorized'
default:
$ref: '#/components/responses/Error'
/auth/refresh:
post:
operationId: refresh_auth
tags:
- Authentication
summary: Refresh the JWT
security:
- { }
description: |
Creates a JWT/refresh token. The generated JWT is valid for 15 minutes. The refresh token is valid
for 5 days
requestBody:
required: true
description: Refresh token.
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshRequest'
responses:
'200':
description: A new JWT
content:
application/json:
schema:
properties:
access_token:
$ref: '#/components/schemas/Jwt'
'401':
$ref: '#/components/responses/Unauthorized'
default:
$ref: '#/components/responses/Error'
/items:
get:
operationId: get_all_items
tags:
- Items
summary: Return the last RSS items of the user
description: Return the last RSS items of the user
parameters:
- $ref: '#/components/parameters/PageSizeParameter'
- $ref: '#/components/parameters/PageNumberParameter'
- name: read
in: query
required: false
schema:
$ref: '#/components/schemas/ItemRead'
- name: starred
in: query
required: false
schema:
$ref: '#/components/schemas/ItemStarred'
responses:
'200':
description: The last RSS items for the logged user
content:
application/json:
schema:
$ref: '#/components/schemas/PagedItems'
'401':
$ref: '#/components/responses/Unauthorized'
default:
$ref: '#/components/responses/Error'
/items/read:
post:
operationId: read_items
summary: Set items as read
description: Set the item as read for the current user
tags:
- Items
requestBody:
required: true
description: List of items IDs to read
content:
application/json:
schema:
$ref: '#/components/schemas/ItemIdList'
responses:
'202':
$ref: '#/components/responses/Accepted'
default:
$ref: '#/components/responses/default'
/items/unread:
post:
operationId: unread_items
summary: Set items as unread
description: Set the item as unread for the current user
tags:
- Items
requestBody:
required: true
description: List of items IDs to unread
content:
application/json:
schema:
$ref: '#/components/schemas/ItemIdList'
responses:
'202':
$ref: '#/components/responses/Accepted'
default:
$ref: '#/components/responses/default'
/items/star:
post:
operationId: star_items
summary: Set items as starred
description: Set the item as starred for the current user
tags:
- Items
requestBody:
required: true
description: List of items IDs to star
content:
application/json:
schema:
$ref: '#/components/schemas/ItemIdList'
responses:
'202':
$ref: '#/components/responses/Accepted'
default:
$ref: '#/components/responses/default'
/items/unstar:
post:
operationId: unstar_items
summary: Set items as un-starred
description: Set the item as un-starred for the current user
tags:
- Items
requestBody:
required: true
description: List of items IDs to un-star
content:
application/json:
schema:
$ref: '#/components/schemas/ItemIdList'
responses:
'202':
$ref: '#/components/responses/Accepted'
default:
$ref: '#/components/responses/default'
/item/{itemId}/notes:
put:
operationId: add_item_notes
summary: Add notes to an item
description: Add or overwrite user's notes on an item
tags:
- Items
parameters:
- name: itemId
in: path
required: true
schema:
$ref: '#/components/schemas/ItemID'
requestBody:
required: true
description: The note to the article
content:
application/json:
schema:
type: object
properties:
notes:
$ref: '#/components/schemas/ItemNotes'
responses:
'204':
$ref: '#/components/responses/NoContent'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/default'
/item/{itemId}:
get:
operationId: get_item
summary: Get a single item
description: Retrieve a single item
tags:
- Items
parameters:
- name: itemId
in: path
required: true
schema:
$ref: '#/components/schemas/ItemID'
responses:
'200':
description: The wanted item
content:
application/json:
schema:
$ref: '#/components/schemas/Item'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/default'
components:
parameters:
PageSizeParameter:
in: query
name: size
required: false
schema:
$ref: '#/components/schemas/PageSize'
description: Size of the page to return. Default to 20.
PageNumberParameter:
in: query
name: number
required: false
schema:
$ref: '#/components/schemas/PageNumber'
description: Number of the page to return. Default to 1.
securitySchemes:
basicAuth:
type: http
scheme: basic
jwt:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
ItemIdList:
type: object
description: A list of Item ID.
properties:
ids:
type: array
items:
$ref: '#/components/schemas/ItemID'
PagedChannels:
type: object
allOf:
- $ref: '#/components/schemas/Page'
- type: object
required:
- content
properties:
content:
type: array
items:
$ref: '#/components/schemas/Channel'
PagedUsers:
type: object
allOf:
- $ref: '#/components/schemas/Page'
- type: object
required:
- content
properties:
content:
type: array
items:
$ref: '#/components/schemas/User'
PagedItems:
type: object
allOf:
- $ref: '#/components/schemas/Page'
- type: object
required:
- content
properties:
content:
type: array
items:
$ref: '#/components/schemas/Item'
Page:
type: object
required:
- page_number
- page_size
- total_items
- total_pages
- elements_number
properties:
page:
$ref: '#/components/schemas/PageNumber'
page_size:
$ref: '#/components/schemas/PageSize'
total_pages:
type: integer
description: Total number of pages.
elements_number:
type: integer
description: Number of elements in the content
total_items:
type: integer
description: Total number of elements
PageSize:
type: integer
description: Size of the page to retrieve
minimum: 1
maximum: 200
example: 15
default: 20
PageNumber:
type: integer
description: Number of the page to retrieve
minimum: 1
default: 1
example: 1
ChannelError:
type: object
description: Error occurred when trying to fetch and update a channel
properties:
id:
$ref: '#/components/schemas/ChannelErrorID'
channel_id:
$ref: '#/components/schemas/ChannelID'
channel_name:
$ref: '#/components/schemas/ChannelName'
error_timestamp:
type: string
format: datetime
description: Timestamp of the error
error_reason:
type: string
description: Reason of the error
example: "The server is down or something"
Token:
type: object
required:
- access_token
- refresh_token
properties:
access_token:
$ref: '#/components/schemas/Jwt'
refresh_token:
$ref: '#/components/schemas/RefreshToken'
ChannelErrorID:
type: integer
description: ID of the error
minLength: 1
Jwt:
type: string
description: The JWT.
minLength: 1
RefreshToken:
type: string
description: The refresh token.
minLength: 1
RefreshRequest:
type: object
required:
- token
properties:
token:
$ref: '#/components/schemas/RefreshToken'
LoginRequest:
type: object
description: A login attempt request.
required:
- login
- password
properties:
login:
$ref: '#/components/schemas/UserName'
password:
$ref: '#/components/schemas/UserPassword'
UpdatePasswordRequest:
type: object
description: Update password request.
required:
- current_password
- new_password
- confirm_password
properties:
current_password:
$ref: '#/components/schemas/UserPassword'
new_password:
$ref: '#/components/schemas/UserPassword'
confirm_password:
$ref: '#/components/schemas/UserPassword'
ResetPasswordTokenRequest:
type: object
description: A password reset token request
required:
- email
properties:
email:
$ref: '#/components/schemas/UserEmail'
ResetPasswordRequest:
type: object
description: A reset password request
required:
- token
- new_password
- confirm_password
- login
properties:
username:
$ref: '#/components/schemas/UserName'
token:
type: string
format: uuid
new_password:
$ref: '#/components/schemas/UserPassword'
confirm_password:
$ref: '#/components/schemas/UserPassword'
UpdateOtherPasswordRequest:
type: object
description: Update other's password request.
required:
- new_password
- confirm_password
properties:
new_password:
$ref: '#/components/schemas/UserPassword'
confirm_password:
$ref: '#/components/schemas/UserPassword'
UpdateUserRequest:
type: object
description: User update request
properties:
email:
$ref: '#/components/schemas/UserEmail'
CreateUserRequest:
type: object
description: User Creation request
required:
- username
- password
- confirm_password
- role
properties:
username:
$ref: '#/components/schemas/UserName'
password:
$ref: '#/components/schemas/UserPassword'
confirm_password:
$ref: '#/components/schemas/UserPassword'
role:
$ref: '#/components/schemas/UserRole'
email:
$ref: '#/components/schemas/UserEmail'
User:
type: object
required:
- id
- username
- role
properties:
id:
$ref: '#/components/schemas/UserID'
username:
$ref: '#/components/schemas/UserName'
role:
$ref: '#/components/schemas/UserRole'
email_verified:
type: boolean
description: Whether the user's email is verified, if the user has provided one.
UserRole:
type: string
description: The user's role (i.e. admin or not).
nullable: false
minLength: 1
UserPassword:
type: string
description: The user's password.
format: password
nullable: false
minLength: 1
UserID:
type: integer
description: The user's unique ID.
minimum: 1
UserName:
type: string
description: The user's name.
minLength: 1
nullable: false
UserEmail:
type: string
description: The user's email.
format: email
RegisterChannelRequest:
type: object
description: A RSS Channel creation request.
required:
- url
properties:
url:
$ref: '#/components/schemas/ChannelURL'
name:
$ref: '#/components/schemas/ChannelName'
notes:
$ref: '#/components/schemas/ChannelNotes'
FoundChannel:
type: object
description: A RSS channel found in a website
required:
- title
- url
properties:
title:
$ref: '#/components/schemas/ChannelName'
url:
$ref: '#/components/schemas/ChannelURL'
Channel:
type: object
description: A RSS Channel.
required:
- id
- name
- url
- registration_timestamp
properties:
id:
$ref: '#/components/schemas/ChannelID'
name:
$ref: '#/components/schemas/ChannelName'
notes:
$ref: '#/conponents/schemas/ChannelNotes'
url:
$ref: '#/components/schemas/ChannelURL'
registration_timestamp:
type: string
format: date-time
description: Timestamp of the channel registration
last_update:
type: string
format: date-time
description: Timestamp of the channel last update
items_count:
type: integer
description: Total number of items for this channel
items_read:
type: integer
description: Number of read items for this channel
failure_count:
type: integer
description: Number of time this channel failed to be updated
disabled:
type: boolean
description: Tells if the channel is disabled or not
ChannelID:
type: integer
description: ID of a channel.
example: 1
ChannelName:
type: string
description: Name of channel.
minLength: 1
nullable: false
example: "Canard PC"
ChannelURL:
type: string
format: URL
minLength: 1
nullable: false
description: URL of a RSS channel.
example: "https://canardpc.com/rss.xml"
ChannelNotes: