-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
459 lines (459 loc) · 12.3 KB
/
openapi.yaml
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
openapi: 3.0.1
info:
title: Geolocation API DOCS
description: documentation by OpenAPI3
version: 1.0.0
license:
name: MIT
servers:
- url: /api/v1
paths:
/:
get:
summary: Default API view
description: Default
operationId: run.main_page
responses:
200:
description: Default
content: {}
/geolocations:
get:
tags:
- Geolocalizations
summary: Retrieve all records
description: Listing of all stored geolocalization data
operationId: run.retrieve_all
responses:
200:
description: Successful list operation
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
description: Unique identificatior of single data record
input_data:
type: string
description: User input given for geolocalization
ip:
type: string
description: Collected IP address
type:
type: string
description: Collected IP addres type (IPv4/IPv6)
county_code:
type: string
description: Collected IP addres type (IPv4/IPv6)
country_name:
type: string
region_name:
type: string
city:
type: string
latitude:
type: string
longitude:
type: string
location:
type: object
properties: {}
post:
tags:
- Geolocalizations
summary: Create record
description: Create new geolocation from provided data set
operationId: run.create
requestBody:
description: New geolocation object
content:
application/json:
schema:
type: object
properties:
ip:
type: string
type:
type: string
county_code:
type: string
country_name:
type: string
region_name:
type: string
city:
type: string
latitude:
type: string
longitude:
type: string
location:
type: object
properties: {}
required: true
responses:
200:
description: Successful create operation
content:
application/json:
schema:
type: object
security:
- JWTokenAuth: ['secret']
x-codegen-request-body-name: geolocation
/geolocations/{loc_id}:
get:
tags:
- Geolocalizations
summary: Retrieve single record
description: Geolocalization data from given record
operationId: run.retrieve_one
parameters:
- name: loc_id
in: path
description: ID of the record
required: true
schema:
type: integer
responses:
200:
description: Successful retrieve operation
content:
application/json:
schema:
type: object
put:
tags:
- Geolocalizations
summary: Update record
description: Update geolocalization data for record with given ID
operationId: run.update_one
parameters:
- name: loc_id
in: path
description: ID of the record
required: true
schema:
type: integer
requestBody:
description: object data to update from
content:
application/json:
schema:
type: object
properties:
ip:
type: string
type:
type: string
county_code:
type: string
country_name:
type: string
region_name:
type: string
city:
type: string
latitude:
type: string
longitude:
type: string
location:
type: object
properties: {}
required: true
responses:
200:
description: Successful update operation
content:
application/json:
schema:
type: object
security:
- JWTokenAuth: ['secret']
x-codegen-request-body-name: geolocation
delete:
tags:
- Geolocalizations
summary: Delete record
description: Delete geolocalization data for passed ID
operationId: run.safe_delete
parameters:
- name: loc_id
in: path
description: ID of the record
required: true
schema:
type: integer
responses:
200:
description: Successful delete operation
content: {}
/geolocations/input_ip={input_ip}:
post:
tags:
- Geolocalizations
summary: Create new record
description: Add geolocation data collected from given IP address
operationId: run.create_with_ip
parameters:
- name: input_ip
in: path
description: IP address to send for geolocation
required: true
example: 93.157.100.49
schema:
type: string
responses:
200:
description: Successful create operation
content:
application/json:
schema:
type: object
security:
- JWTokenAuth: ['secret']
/geolocations/input_domain={input_domain}:
post:
tags:
- Geolocalizations
summary: Create new record
description: Add geolocation data obtained from domain address
operationId: run.create_with_domain
parameters:
- name: input_domain
in: path
description: Domain address to send for geolocation
required: true
example: www.mynthon.net
schema:
type: string
responses:
200:
description: Successful create operation
content:
application/json:
schema:
type: object
security:
- JWTokenAuth: ['secret']
/geolocations/deleted:
get:
tags:
- Geolocalizations
summary: Data removed from main collection
description: Records may be permanently removed or restored
operationId: run.list_deleted
responses:
200:
description: Safe-deleted records listing
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: number
ip:
type: string
type:
type: string
country_name:
type: string
city:
type: string
security:
- JWTokenAuth: ['secret']
/geolocations/deleted/{loc_id}:
put:
tags:
- Geolocalizations
summary: 'PUT: Put back to main API.'
description: Send PUT request with record ID to restore for main API.
operationId: run.restore_deleted
parameters:
- name: loc_id
in: path
description: ID of the record
required: true
schema:
type: integer
responses:
200:
description: Data restored
content: {}
security:
- JWTokenAuth: ['secret']
x-swagger-router-controller: run
delete:
tags:
- Geolocalizations
summary: 'DELETE: Delete permanently.'
description: Send DELETE request with record ID for permanent removal from database.
operationId: run.remove_deleted
parameters:
- name: loc_id
in: path
description: ID of the record
required: true
schema:
type: integer
responses:
200:
description: Data removed permanently
content: {}
security:
- JWTokenAuth: ['secret']
x-swagger-router-controller: run
/auth/{public_id}:
get:
tags:
- Auth
summary: JWT shortcut
operationId: run.generate_token
parameters:
- name: public_id
description: User unique identifier
in: path
required: true
schema:
type: string
responses:
'200':
description: JWT token
content:
'application/json':
schema:
type: string
/auth/cookies:
get:
tags:
- Auth
summary: Retrieve token from cookie
description: Refresh
operationId: run.cookie_token
responses:
'200':
description: JWT cookie
content:
'application/json':
schema:
type: string
/auth/login:
post:
tags:
- Auth
summary: POST data for authentication.
description: Authentication through login
operationId: run.log_in
requestBody:
description: Required credentials
content:
application/json:
schema:
type: object
properties:
login:
type: string
password:
type: string
required: true
responses:
200:
description: User authenticated
content: { }
401:
description: Wrong credentials
content: { }
x-codegen-request-body-name: user
/users:
get:
tags:
- Users
summary: Retrieve all users
description: Listing user all users stored in the database
operationId: run.retrieve_all_users
responses:
200:
description: Retrieved all available instances
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: number
login:
type: string
security:
- JWTokenAuth: ['secret']
post:
tags:
- Users
summary: Create new user instance
description: Register new user from given request body
operationId: run.register
requestBody:
description: Object filled with data to create new user
content:
application/json:
schema:
type: object
properties:
login:
type: string
password:
type: string
first_name:
type: string
last_name:
type: string
email:
type: string
required: true
responses:
200:
description: User authenticated
content: { }
401:
description: Wrong credentials
content: { }
x-codegen-request-body-name: user
/users/{user_id}:
get:
tags:
- Users
summary: Retrieve user with given id
description: Detailed view on specified user data
operationId: run.retrieve_one_user
parameters:
- name: user_id
in: path
description: ID of the user
required: true
schema:
type: integer
responses:
200:
description: Record retrieved
content: { }
404:
description: Record not found
content: { }
security:
- JWTokenAuth: [ 'secret' ]
components:
securitySchemes:
JWTokenAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-bearerInfoFunc: run.decode_token