-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathserverless.doc.yml
190 lines (179 loc) · 6 KB
/
serverless.doc.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
documentation:
version: '2'
title: 'Shortlinker API'
description: 'Simple link shortener'
models:
- name: MessageResponce
description: Occures on failure and on success (if no additional data)
contentType: application/json
schema: ${file(models/response/MessageResponse.json)}
- name: LinksResponse
description: List of links basically
contentType: application/json
schema: ${file(models/response/LinksResponse.json)}
- name: TokenResponse
description: JWT token
contentType: application/json
schema: ${file(models/response/TokenResponse.json)}
- name: LoginDataRequest
description: Login data (email and password)
contentType: application/json
schema: ${file(models/request/LoginDataRequest.json)}
- name: VerifyRequest
description: Verify data (email and code)
contentType: application/json
schema: ${file(models/request/VerifyRequest.json)}
- name: LinkCreationRequest
description: Make Alias for link
contentType: application/json
schema: ${file(models/request/LinkCreationRequest.json)}
- name: WithAliasRequest
description: Alias only
contentType: application/json
schema: ${file(models/request/WithAliasRequest.json)}
endpoints:
register:
summary: Register new user
description: Registers new user by email and password; then sends verification email
requestBody:
description: User email and password
requestModels:
application/json: LoginDataRequest
methodResponses:
- statusCode: 200
description: Successful registration
responseModels:
application/json: MessageResponce
- statusCode: 400
description: Bad request possible validation failure or email already in use
responseModels:
application/json: MessageResponce
- statusCode: 500
description: Internal server error
responseModels:
application/json: MessageResponce
login:
summary: Login
description: Logs in user by email and password. returns JWT token.
requestBody:
description: User email and password
requestModels:
application/json: LoginDataRequest
methodResponses:
- statusCode: 200
description: Successful login
responseModels:
application/json: TokenResponse
- statusCode: 400
description: Bad request. Invalid email or password
responseModels:
application/json: MessageResponce
- statusCode: 404
description: User not found
responseModels:
application/json: MessageResponce
- statusCode: 500
description: Internal server error
responseModels:
application/json: MessageResponce
verify:
summary: Verify email
description: Verifies user's email by confirmation code
requestBody:
description: User email and code
requestModels:
application/json: VerifyRequest
methodResponses:
- statusCode: 200
description: Successful verification
responseModels:
application/json: MessageResponce
- statusCode: 400
description: Bad request. Invalid email or code
responseModels:
application/json: MessageResponce
- statusCode: 500
description: Internal server error
responseModels:
application/json: MessageResponce
createLink:
summary: Creates link
description: Creates new pseudonim for link
requestBody:
description: Real link, alias, ttl for link (ONE_TIME, ONE_DAY, THREE_DAYS, ONE_WEEK, NEVER)
requestModels:
application/json: LinkCreationRequest
methodResponses:
- statusCode: 200
description: Successful creation
responseModels:
application/json: MessageResponce
- statusCode: 400
description: Bad request. Might be validation failure
responseModels:
application/json: MessageResponce
- statusCode: 500
description: Internal server error
responseModels:
application/json: MessageResponce
deactivateLink:
summary: deactivates link
description: deactivates link, quite simple
requestModels:
application/json: WithAliasRequest
requestBody:
description: link alias
methodResponses:
- statusCode: 200
description: Successful registration
responseModels:
application/json: MessageResponce
- statusCode: 400
description: Bad request. User has not this link
responseModels:
application/json: MessageResponce
- statusCode: 500
description: Internal server error
responseModels:
application/json: MessageResponce
manageLinks:
summary: get uer links
description: returns information about user links
methodResponses:
- statusCode: 200
description: Successful registration
responseModels:
application/json: LinksResponse
- statusCode: 400
description: Bad request. Problems with token
responseModels:
application/json: MessageResponce
- statusCode: 500
description: Internal server error
responseModels:
application/json: MessageResponce
useLink:
summary: get link
description: get links by alias, increment counter, deactivate one-time link
requestModels:
application/json: WithAliasRequest
requestBody:
description: alias
pathParams:
- name: alias
description: link alias
schema:
type: string
methodResponses:
- statusCode: 200
description: Successful link retrieval.
responseModels:
application/json: MessageResponce
- statusCode: 400
description: Bad request. Problems with token
responseModels:
application/json: MessageResponce
- statusCode: 500
description: Internal server error
responseModels:
application/json: MessageResponce