-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
1467 lines (1449 loc) · 46 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.1"
info:
title: Attoly
version: v1
x-logo:
url: /site/img/logo.svg
altText: Attoly Logo
description: |
This is the backend of the Attoly URL shortener platform, responsible for
data storage and exchange. Attoly allows creating short links as aliases
for long URLs, which are easier to embed in websites, chats and documents.
# Introduction
This is the official documentation of the Attoly RESTful API. Based on
simple REST principles, the Attoly RESTful API endpoints return JSON
metadata about created and managed short link URL mappings aka shortcuts.
This API also provides access to user related data, like account information
and your personal shortcut library.
# Overview
The following settings and techniques apply to the entire Attoly RESTful API.
## HTTP Verbs
There are a couple of possible HTTP verbs used for the RESTful API. The following
table clearly clarifies their use and meaning within the API.
| Verb | Description |
|--------------|-------------------------------------------------------------------|
| HEAD | Can be ran against any resource to get just the HTTP header info. |
| GET | Used for retrieving resources. |
| POST | Used for creating resources. |
| PATCH | Used for updating resources partially. |
| PUT | Used for replacing resources or collections. |
| DELETE | Used for deleting resources. |
## Timestamps
Timestamps are returned in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format with the time zone offset of the server: `YYYY-MM-DDTHH:mm:ss.sss`.
The time stamp is always specified with the offset addition in the server's
time zone. Despite the specification of the fractions of the second, inaccuracies
can occur with the timestamps in the millisecond range.
## Pagination
Some of the queries read from a larger subset of the data set. In these cases,
pagination is used to avoid performance problems. In general, the pagination
behaviour is controlled by the query parameters `page` and `perPage`. You can
specify the page offset with the `page` parameter. For some resources, its is
also possible set a custom page size with the `perPage` parameter.
---
**NOTE**
The offset numbering is zero-based. Omitting the offset parameter sets the
requested page to zero by default and returns the first X elements of a
collection. Requests that return multiple items will be paginated to 25
items by default.
---
In addition to pagination, all endpoints that support pagination also support
sorting. The sorting is implemented via the query parameter `sort`. The sorting
should be specified in the following format: `property,property(,ASC|DESC)(,IgnoreCase)`.
The default sort direction is case-sensitive ascending.
```
?page=0&perPage=30&sort=firstname&sort=lastname,desc&sort=city,ignorecase
```
## Filtering
Some endpoints, usually the same ones that support pagination, also support
result filtering. Result filtering can be used to determine which results
are to be displayed on the basis of RSQL/FIQL. The filtering is implemented
via the query parameter `filter`. See
[FIQL: The Feed Item Query Language](https://datatracker.ietf.org/doc/html/draft-nottingham-atompub-fiql-00)
for syntax details.
## Internationalization
In principle, this API supports internationalization, but to a limited extent.
Currently internationalization is supported for error messages and validation
as well as server-generated responses. By default, the server responds in
English. If another language is desired, this can be controlled via the
`Accept-Language` header.
```
Accept-Language: en
```
At the moment the following languages are supported on the server side:
- English (en)
- German (de)
## Authentication
Some of the endpoints require authentication to function properly. This applies
in principle but not exclusively to all user account-related operations.
Authentication is achieved by a stateless token based authentication mechanism
that is using the *HTTP Bearer Authentication* scheme.
```
Authorization: Bearer <ACCESS TOKEN>
```
So-called JWT access tokens are used, which can be requested once in exchange
for credentials and are now used for authentication instead of email and
password. There are also opaque refresh tokens that can be used to generate
new access tokens without having to resend the credentials. This is necessary
to stay logged in for a longer period of time, as the access tokens have a
relatively short lifespan.
<SecurityDefinitions />
license:
name: MIT
url: https://opensource.org/licenses/MIT
contact:
name: "0x1C1B"
url: https://github.com/0x1C1B
servers:
- url: http://localhost:8080/api/v1
description: Development Server
tags:
- name: User
description: Everything about user and account management.
- name: Role
description: Manage roles and user permissions.
- name: Auth
description: Allows the client to authenticate themselves.
- name: Shortcut
description: Allows shortcuts to be managed.
- name: Complaint
description: Manages complaints of shortcuts, i.e. all complaints about potentially unwanted shortcuts.
paths:
/users:
post:
tags:
- User
summary: Creates a new user.
description: >
Creates a new user account. The user account is irretrievably linked
to the stored email and must first be activated by verifying the email.
security: [ ]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RegistrationDto"
example:
email: [email protected]
password: Abc123
responses:
201:
description: Successfully created the new user.
content:
application/json:
schema:
$ref: "#/components/schemas/UserDto"
example:
id: 3377cf8f-da29-4aa7-9036-91951b8fce87
email: [email protected]
createdAt: 2022-06-27T15:18:16.706776+02:00
422:
$ref: "#/components/responses/UnprocessableEntity"
get:
tags:
- User
summary: Returns all user details.
description: >
Returns all user details. This endpoint is only available to administrators.
parameters:
- name: page
in: query
description: Zero based index of page to load.
required: false
schema:
type: integer
example: 0
- name: perPage
in: query
description: Number of elements per page.
required: false
schema:
type: integer
example: 25
- name: sort
in: query
description: Sort criteria.
required: false
schema:
type: string
example: createdAt,desc
- name: filter
in: query
description: RSQL/FIQL based filter.
required: false
schema:
type: string
example: name=like=test
responses:
200:
description: Successfully fetched all available shortcuts.
content:
application/json:
schema:
$ref: "#/components/schemas/PrincipalPageDto"
example:
page: 0
perPage: 25
totalElements: 1
totalPages: 1
content:
- id: 3377cf8f-da29-4aa7-9036-91951b8fce87
email: [email protected]
createdAt: 2022-06-27T15:18:16.706776+02:00
emailVerified: true
/users/{id}:
get:
tags:
- User
summary: Gets a user by its identifier.
description: >
Gets a user's details by its identifier. You'll need administrative privileges to retrieve a user's details.
parameters:
- name: id
in: path
description: The identifier of the user.
required: true
schema:
type: string
format: uuid
responses:
200:
description: Successfully retrieved the user's details.
content:
application/json:
schema:
$ref: "#/components/schemas/PrincipalDto"
example:
id: 3377cf8f-da29-4aa7-9036-91951b8fce87
email: [email protected]
createdAt: 2022-06-27T15:18:16.706776+02:00
emailVerified: true
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
patch:
tags:
- User
summary: Updates the details of a single user.
description: >
Updates a user's details. Without higher rights, only your own user can be updated. Therefore, this endpoint
is only available for administrators.
parameters:
- name: id
in: path
description: Unique identifier of the user.
required: true
schema:
type: string
format: uuid
example: 3377cf8f-da29-4aa7-9036-91951b8fce87
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PrincipalUpdateDto"
example:
password: Def456
responses:
200:
description: Successfully updated the selected user.
content:
application/json:
schema:
$ref: "#/components/schemas/PrincipalDto"
example:
id: 3377cf8f-da29-4aa7-9036-91951b8fce87
email: [email protected]
createdAt: 2022-06-27T15:18:16.706776+02:00
emailVerified: true
422:
$ref: "#/components/responses/UnprocessableEntity"
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
delete:
tags:
- User
summary: Deletes a single user.
description: >
Allows deleting a user account. Even if the path is generic, it is
only possible to delete your own user without higher rights due to
the security policy. Warning, the deletion is immediate executed
and irreversible. To delete other user accounts, you have to be
an administrator.
parameters:
- name: id
in: path
description: Unique identifier of the user.
required: true
schema:
type: string
format: uuid
example: 3377cf8f-da29-4aa7-9036-91951b8fce87
responses:
204:
description: Successfully deleted the selected user.
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
/user/me:
get:
tags:
- User
summary: Retrieves the currently authenticated user.
description: >
Returns the account details of the currently authenticated user.
Only the account information of your own authenticated account can be queried.
responses:
200:
description: Successfully fetched the authenticated user.
content:
application/json:
schema:
$ref: "#/components/schemas/UserDto"
example:
id: 3377cf8f-da29-4aa7-9036-91951b8fce87
email: [email protected]
createdAt: 2022-06-27T15:18:16.706776+02:00
401:
$ref: "#/components/responses/Unauthenticated"
patch:
tags:
- User
summary: Updates your own user account.
description: >
Updates the account of the currently authenticated user.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserUpdateDto"
example:
password: Def456
responses:
200:
description: Successfully updated your user account.
content:
application/json:
schema:
$ref: "#/components/schemas/UserDto"
example:
id: 3377cf8f-da29-4aa7-9036-91951b8fce87
email: [email protected]
createdAt: 2022-06-27T15:18:16.706776+02:00
422:
$ref: "#/components/responses/UnprocessableEntity"
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
delete:
tags:
- User
summary: Deletes a your own user account.
description: >
Allows deleting a user account. Warning, the deletion is immediate
executed and irreversible. To delete other user accounts, you have
to be an administrator.
responses:
204:
description: Successfully deleted your user account.
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
/user/verify:
post:
tags:
- User
summary: Activates a user by verifying email.
description: >
Activates a user by verifying email. Without this verification, the user
cannot be logged in and the account cannot be used. The verification is
carried out by sending a verification token to the user via email
beforehand and the user must include this in the request.
security: [ ]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserVerificationDto"
example:
verificationToken: vT6Nafaz
responses:
204:
description: Successfully verified and enabled the user account.
422:
$ref: "#/components/responses/UnprocessableEntity"
410:
$ref: "#/components/responses/Gone"
get:
tags:
- User
summary: Requests a verification token via email.
description: >
Causes a verification token to be sent via email. This token is
used to verify the email and activate the account.
security: [ ]
parameters:
- name: email
in: query
description: Email of the user for whom a verification token should be sent.
required: true
schema:
type: string
format: email
example: [email protected]
responses:
204:
description: Successfully sent a verification token.
404:
$ref: "#/components/responses/NotFound"
/user/reset:
post:
tags:
- User
summary: Resets a user's password.
description: >
Resets a user's password using a reset token. This variant can be
used to recover an account for which the password has been forgotten.
A reset token is sent to the user via email and must be included in
the request along with the new password.
security: [ ]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserResetDto"
example:
resetToken: WlDXlr/b
password: Def456
responses:
204:
description: Successfully reset the user's password.
422:
$ref: "#/components/responses/UnprocessableEntity"
410:
$ref: "#/components/responses/Gone"
get:
tags:
- User
summary: Requests a reset token via email.
description: >
Causes a reset token to be sent to the user via email. This
sent token can be used to reset the password.
security: [ ]
parameters:
- name: email
in: query
description: Email of the user for whom a reset token should be sent.
required: true
schema:
type: string
format: email
example: [email protected]
responses:
204:
description: Successfully sent a reset token.
404:
$ref: "#/components/responses/NotFound"
/auth/token:
post:
tags:
- Auth
summary: Signs in a user.
description: >
Signs in a user stateless by generating a JWT access token and an opaque
refresh token in exchange for the credentials. The access token can be
used in all further requests for authentication.
security: [ ]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CredentialsDto"
example:
email: [email protected]
password: Abc123
responses:
200:
description: Successfully signed in the user.
content:
application/json:
schema:
$ref: "#/components/schemas/TokenDto"
example:
type: Bearer
principal: [email protected]
refreshToken: Z2xFlZIH8mw32hXYhmidIA==
accessToken: >
eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJtYXhpMTIzIiwiaWF0IjoxNjU2MzM1ODg2LCJleHAiOjE2NTYzMzY0ODZ9.p4KjWLKOsgly
J4Dqme3fPAkqtsf0jsksPr6Y-0pZe3hPYUdWz18eKius8fmijsQFf-5lxVM4kQLKBI4tmBQ3Dw
accessExpiresIn: 300000
refreshExpiresIn: 7200000
401:
$ref: "#/components/responses/Unauthenticated"
/auth/refresh:
post:
tags:
- Auth
summary: Renews the user's authentication session.
description: >
Refreshes a user's stateless session by requesting a new access token in
exchange for a valid refresh token. Despite the short-lived access token,
it is possible for a user to remain logged in for a longer period of time
by repeatedly requesting new access tokens.
security: [ ]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RefreshSessionDto"
example:
refreshToken: /QwSXxYuhkPmdwqSZQ4wjQ==
responses:
200:
description: Successfully renewed the user's session.
content:
application/json:
schema:
$ref: "#/components/schemas/TokenDto"
example:
type: Bearer
principal: [email protected]
refreshToken: Z2xFlZIH8mw32hXYhmidIA==
accessToken: >
eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJtYXhpMTIzIiwiaWF0IjoxNjU2MzM1ODg2LCJleHAiOjE2NTYzMzY0ODZ9.p4KjWLKOsgly
J4Dqme3fPAkqtsf0jsksPr6Y-0pZe3hPYUdWz18eKius8fmijsQFf-5lxVM4kQLKBI4tmBQ3Dw
accessExpiresIn: 300000
refreshExpiresIn: 7200000
401:
$ref: "#/components/responses/Unauthenticated"
/roles:
get:
tags:
- Role
summary: Lists all available security roles.
description: >
Lists all available security roles. Only administrators can retrieve all available roles.
responses:
200:
description: Successfully fetched all available roles.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/RoleDto"
example:
- id: 97aeee91-1fd4-4228-9c76-33564188e6fd
name: ROLE_ADMIN
401:
$ref: "#/components/responses/Unauthenticated"
403:
$ref: "#/components/responses/AccessDenied"
/roles/{id}:
get:
tags:
- Role
summary: Gets a role by its identifier.
description: >
Gets a role by its identifier. You'll need administrative privileges to retrieve a role.
parameters:
- name: id
in: path
description: The identifier of the role.
required: true
schema:
type: string
format: uuid
responses:
200:
description: Successfully retrieved the role.
content:
application/json:
schema:
$ref: "#/components/schemas/RoleDto"
example:
id: 97aeee91-1fd4-4228-9c76-33564188e6fd
name: ROLE_ADMIN
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
/users/{userId}/roles:
get:
tags:
- Role
summary: Lists all security roles of a user.
description: >
Lists all security roles of a user. Only administrators can see a user's roles.
parameters:
- name: userId
in: path
description: The identifier of the user.
required: true
schema:
type: string
format: uuid
responses:
200:
description: Successfully fetched all roles.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/RoleDto"
example:
- id: 97aeee91-1fd4-4228-9c76-33564188e6fd
name: ROLE_ADMIN
401:
$ref: "#/components/responses/Unauthenticated"
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
/user/me/roles:
get:
tags:
- Role
summary: Lists all security roles of the current user.
description: >
Lists all security roles of the current user.
responses:
200:
description: Successfully fetched all roles.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/RoleDto"
example:
- id: 97aeee91-1fd4-4228-9c76-33564188e6fd
name: ROLE_USER
401:
$ref: "#/components/responses/Unauthenticated"
/users/{userId}/roles/{roleId}:
post:
tags:
- Role
summary: Adds a role to a user.
description: >
Adds a role to a user. You need administrative privileges to grant permissions/roles.
parameters:
- name: userId
in: path
description: The identifier of the user.
required: true
schema:
type: string
format: uuid
- name: roleId
in: path
description: The identifier of the role.
required: true
schema:
type: string
format: uuid
responses:
204:
description: Successfully added the role.
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
delete:
tags:
- Role
summary: Removes a role from a user.
description: >
Removes a role from a user. You'll need administrative privileges to revoke permissions/roles.
parameters:
- name: userId
in: path
description: The identifier of the user.
required: true
schema:
type: string
format: uuid
- name: roleId
in: path
description: The identifier of the role.
required: true
schema:
type: string
format: uuid
responses:
204:
description: Successfully revoked the role.
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
/shortcuts:
post:
tags:
- Shortcut
summary: Creates a new shortcut.
description: >
Creates a new shortcut for a URL to be abbreviated. Access can be
authenticated, in which case the shortcut is assigned to the user,
or unauthenticated, in which case an anonymous shortcut is created.
While user shortcuts are permanently available, anonymous shortcuts
are deleted after some time.
security:
- { }
- jwt: [ ]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ShortcutCreationDto"
example:
url: http://localhost:8080
responses:
201:
description: Successfully created the new shortcut.
content:
application/json:
schema:
$ref: "#/components/schemas/ShortcutDto"
example:
id: 97aeee91-1fd4-4228-9c76-33564188e6fd
tag: hluEinvI
url: http://localhost:8080
createdAt: 2022-06-27T15:18:16.706776+02:00
422:
$ref: "#/components/responses/UnprocessableEntity"
401:
$ref: "#/components/responses/Unauthenticated"
get:
tags:
- Shortcut
summary: Lists all shortcuts.
description: >
Lists all available shortcuts. Only administrators can retrieve all available shortcuts.
parameters:
- name: page
in: query
description: Zero based index of page to load.
required: false
schema:
type: integer
example: 0
- name: perPage
in: query
description: Number of elements per page.
required: false
schema:
type: integer
example: 25
- name: sort
in: query
description: Sort criteria.
required: false
schema:
type: string
example: createdAt,desc
- name: filter
in: query
description: RSQL/FIQL based filter.
required: false
schema:
type: string
example: name=like=test
responses:
200:
description: Successfully fetched all available shortcuts.
content:
application/json:
schema:
$ref: "#/components/schemas/ShortcutPageDto"
example:
page: 0
perPage: 25
totalElements: 1
totalPages: 1
content:
- id: 97aeee91-1fd4-4228-9c76-33564188e6fd
tag: hluEinvI
url: http://localhost:8080
createdAt: 2022-06-27T15:18:16.706776+02:00
401:
$ref: "#/components/responses/Unauthenticated"
403:
$ref: "#/components/responses/AccessDenied"
/shortcuts/{tag}:
get:
tags:
- Shortcut
summary: Resolves a shortcut.
description: >
Resolves a shortcut based on its short link or tag.
security: [ ]
parameters:
- name: tag
in: path
description: Unique tag of the shortcut.
required: true
schema:
type: string
example: hluEinvI
responses:
200:
description: Successfully resolved the shortcut.
content:
application/json:
schema:
$ref: "#/components/schemas/ShortcutDto"
example:
id: 97aeee91-1fd4-4228-9c76-33564188e6fd
tag: hluEinvI
url: http://localhost:8080
createdAt: 2022-06-27T15:18:16.706776+02:00
404:
$ref: "#/components/responses/NotFound"
delete:
tags:
- Shortcut
summary: Deletes a single shortcut.
description: >
Deletes a personal shortcut based on its tag. Only your own personal
shortcuts can be deleted. Anonymous shortcuts cannot be deleted and
will be automatically removed after some time.
parameters:
- name: tag
in: path
description: Unique tag of the shortcut.
required: true
schema:
type: string
example: hluEinvI
responses:
204:
description: Successfully deleted the selected shortcut.
403:
$ref: "#/components/responses/AccessDenied"
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
/user/me/shortcuts:
get:
tags:
- Shortcut
summary: Retrieves all shortcuts of current user.
description: >
Loads the list of all personal shortcuts of the currently authenticated
user. The result is returned in pages because of the possible size.
parameters:
- name: page
in: query
description: Zero based index of page to load.
required: false
schema:
type: integer
example: 0
- name: perPage
in: query
description: Number of elements per page.
required: false
schema:
type: integer
example: 25
- name: sort
in: query
description: Sort criteria.
required: false
schema:
type: string
example: createdAt,desc
responses:
200:
description: Successfully fetched all available shortcuts.
content:
application/json:
schema:
$ref: "#/components/schemas/ShortcutPageDto"
example:
page: 0
perPage: 25
totalElements: 1
totalPages: 1
content:
- id: 97aeee91-1fd4-4228-9c76-33564188e6fd
tag: hluEinvI
url: http://localhost:8080
createdAt: 2022-06-27T15:18:16.706776+02:00
401:
$ref: "#/components/responses/Unauthenticated"
/shortcuts/{tag}/complaints:
post:
tags:
- Complaint
summary: Complaints a shortcut.
description: >
Complains a shortcut based on its tag. The complaint is sent to the
administrator of the service. The administrator can then decide
whether to delete the shortcut or not.
parameters:
- name: tag
in: path
description: Unique tag of the shortcut.
required: true
schema:
type: string
example: hluEinvI
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ComplaintCreationDto"
example:
reason: SPAM
comment: Contains offensive content.
responses:
204:
description: Successfully complained the shortcut.
404:
$ref: "#/components/responses/NotFound"
401:
$ref: "#/components/responses/Unauthenticated"
403:
$ref: "#/components/responses/AccessDenied"
/complaints:
get:
tags:
- Complaint
summary: Retrieves all complaints.
description: >
Loads the list of all complaints. The result is returned in pages
because of the possible size. Only administrators are able to
retrieve complaints.
parameters:
- name: page
in: query
description: Zero based index of page to load.
required: false
schema:
type: integer
example: 0
- name: perPage
in: query
description: Number of elements per page.
required: false
schema:
type: integer
example: 25
- name: sort
in: query
description: Sort criteria.
required: false
schema:
type: string
example: createdAt,desc
responses:
200:
description: Successfully fetched all available complaints.
content:
application/json:
schema:
$ref: "#/components/schemas/ComplaintPageDto"
example: