serverless-shortlinker-app/openapi.yml at main · pavukach/serverless-shortlinker-app · GitHub

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
openapi: 3.0.0
components:
  schemas:
    MessageResponce:
      type: object
      properties:
        statusCode:
          type: integer
        body:
          type: string
      required:
        - statusCode
        - body
      additionalProperties: false
    LinksResponse:
      type: object
      properties:
        statusCode:
          type: integer
        body:
          type: object
          properties:
            links:
              type: array
              items:
                type: object
                properties:
                  link:
                    type: string
                  alias:
                    type: string
                  creator:
                    type: string
                  uses:
                    type: integer
                  active:
                    type: boolean
                  one_time:
                    type: boolean
                required:
                  - link
                  - alias
                  - creator
                  - uses
                  - active
                  - one_time
                additionalProperties: false
          required:
            - links
          additionalProperties: false
      required:
        - statusCode
        - body
      additionalProperties: false
    TokenResponse:
      type: object
      properties:
        statusCode:
          type: integer
        body:
          type: object
          properties:
            token:
              type: string
          required:
            - token
          additionalProperties: false
      required:
        - statusCode
        - body
      additionalProperties: false
    LoginDataRequest:
      type: object
      properties:
        body:
          type: object
          properties:
            email:
              type: string
              format: email
            password:
              type: string
          required:
            - email
            - password
          additionalProperties: false
      required:
        - body
      additionalProperties: false
    VerifyRequest:
      type: object
      properties:
        body:
          type: object
          properties:
            email:
              type: string
              format: email
            verification_code:
              type: integer
          required:
            - email
            - code
          additionalProperties: false
      required:
        - body
      additionalProperties: false
    LinkCreationRequest:
      type: object
      properties:
        body:
          type: object
          properties:
            alias:
              type: string
            link:
              type: string
              format: url
          required:
            - alias
            - link
          additionalProperties: false
      required:
        - body
      additionalProperties: false
    WithAliasRequest:
      type: object
      properties:
        body:
          type: object
          properties:
            alias:
              type: string
          required:
            - alias
          additionalProperties: false
      required:
        - body
      additionalProperties: false
  securitySchemes: {}
info:
  title: Shortlinker API
  description: Simple link shortener
  version: '2'
paths:
  /auth/register:
    post:
      operationId: register
      summary: Register new user
      description: Registers new user by email and password; then sends verification email
      responses:
        '200':
          description: Status 200 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '400':
          description: Status 400 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '500':
          description: Status 500 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
  /auth/login:
    post:
      operationId: login
      summary: Login
      description: Logs in user by email and password. returns JWT token.
      responses:
        '200':
          description: Status 200 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '400':
          description: Status 400 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '404':
          description: Status 404 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '500':
          description: Status 500 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
  /auth/verify:
    post:
      operationId: verify
      summary: Verify email
      description: Verifies user's email by confirmation code
      responses:
        '200':
          description: Status 200 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '400':
          description: Status 400 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '500':
          description: Status 500 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
  /link/createLink:
    post:
      operationId: createLink
      summary: Creates link
      description: Creates new pseudonim for link
      responses:
        '200':
          description: Status 200 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '400':
          description: Status 400 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '500':
          description: Status 500 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
  /link/deactivateLink:
    post:
      operationId: deactivateLink
      summary: deactivates link
      description: 'deactivates link, quite simple'
      responses:
        '200':
          description: Status 200 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '400':
          description: Status 400 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '500':
          description: Status 500 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
  /link/manageLinks:
    post:
      operationId: manageLinks
      summary: get uer links
      description: returns information about user links
      responses:
        '200':
          description: Status 200 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinksResponse'
        '400':
          description: Status 400 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '500':
          description: Status 500 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
  '/link/useLink/{alias}':
    post:
      operationId: useLink
      summary: get link
      description: 'get links by alias, increment counter, deactivate one-time link'
      responses:
        '200':
          description: Status 200 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '400':
          description: Status 400 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'
        '500':
          description: Status 500 Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponce'