-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
437 lines (424 loc) · 10.7 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
openapi: 3.0.0
info:
title: Udger Local API v4
description: Udger-webservice REST-API provides access to udger-webservice docker container.
version: '1'
servers:
- url: http://udger-webservice.org/
paths:
/parse/ua/{ua}:
get:
summary: Parse single user agent string.
parameters:
- name: ua
in: path
required: true
description: Base64 encoded user agent string
schema:
type: string
responses:
'200':
description: Parsed user agent.
content:
application/json:
schema:
$ref: '#/components/schemas/UaResult'
application/xml:
schema:
$ref: '#/components/schemas/UaResult'
'400':
description: Invalid request.
content:
application/text:
schema:
type: string
/parse/ua-v4:
post:
summary: Parse udger-v4 request.
requestBody:
description: User Agent information to be parsed
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ParseUaV4Request'
application/xml:
schema:
$ref: '#/components/schemas/ParseUaV4Request'
responses:
'200':
description: Parsed user agent.
content:
application/json:
schema:
$ref: '#/components/schemas/UaResult'
application/xml:
schema:
$ref: '#/components/schemas/UaResult'
'400':
description: Invalid request.
content:
application/text:
schema:
type: string
/parse/ip/{ip}:
get:
summary: Parse single IP string.
parameters:
- name: ip
in: path
required: true
description: IP string
schema:
type: string
responses:
'200':
description: Parsed IP.
content:
application/json:
schema:
$ref: '#/components/schemas/IpResult'
application/xml:
schema:
$ref: '#/components/schemas/IpResult'
'400':
description: Invalid request.
content:
application/text:
schema:
type: string
/parse:
get:
summary: Parse single user agent string.
parameters:
- name: ua
in: query
required: true
description: Base64 encoded user agent string
schema:
type: string
- name: ip
in: query
required: true
description: IP string
schema:
type: string
responses:
'200':
description: Parsed user agent and IP.
content:
application/json:
schema:
type: object
properties:
user_agent:
$ref: '#/components/schemas/UaResult'
ip_address:
$ref: '#/components/schemas/IpResult'
application/xml:
schema:
type: object
properties:
user_agent:
$ref: '#/components/schemas/UaResult'
ip_address:
$ref: '#/components/schemas/IpResult'
'400':
description: Invalid request.
content:
application/text:
schema:
type: string
/set/key:
post:
summary: Set client key used in db update operation.
parameters:
- name: access_key
in: query
required: true
description: Client key
schema:
type: string
responses:
'200':
description: OK
content:
application/text:
schema:
type: string
'400':
description: Invalid key.
content:
application/text:
schema:
type: string
/set/updatedata:
post:
summary: Update database file from http://data.udger.com/{key}/udgerdb_v3.dat.gz
responses:
'200':
description: OK
content:
application/text:
schema:
type: string
'400':
description: Invalid request.
content:
application/text:
schema:
type: string
/set/autoupdate:
post:
summary: Set time of daily autoupdate in form HH:mm.
parameters:
- name: time
in: query
required: true
description: Set time of periodic update in form HH:mm
schema:
type: string
responses:
'200':
description: OK
content:
application/text:
schema:
type: string
'400':
description: Invalid request.
content:
application/text:
schema:
type: string
/set/datafile:
post:
summary: Upload data file. Accepts data in gz format.
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
responses:
'200':
description: OK
content:
application/text:
schema:
type: string
'400':
description: Invalid request.
content:
application/text:
schema:
type: string
/statistic:
get:
summary: Get parser statistics.
responses:
'200':
description: Parser statistics.
content:
application/json:
schema:
type: object
properties:
total_requests_ua:
type: integer
total_requests_ip:
type: integer
total_nanos_ua:
type: integer
total_nanos_ip:
type: integer
avg_throughput_ua:
type: number
avg_throughput_ip:
type: number
components:
schemas:
UaResult:
type: object
properties:
user_agent:
type: string
ua_string:
type: string
ua_class:
type: string
ua_class_code:
type: string
ua:
type: string
ua_version:
type: string
ua_version_major:
type: string
ua_uptodate_current_version:
type: string
ua_family:
type: string
ua_family_code:
type: string
ua_family_homepage:
type: string
ua_family_vendor:
type: string
ua_family_vendor_code:
type: string
ua_family_vendor_homepage:
type: string
ua_family_icon:
type: string
ua_family_icon_big:
type: string
ua_family_info_url:
type: string
ua_engine:
type: string
os:
type: string
os_code:
type: string
os_homepage:
type: string
os_icon:
type: string
os_icon_big:
type: string
os_info_url:
type: string
os_family:
type: string
os_family_code:
type: string
os_family_vendor:
type: string
os_family_vendor_code:
type: string
os_family_vendor_homepage:
type: string
device_class:
type: string
device_class_code:
type: string
device_class_icon:
type: string
device_class_icon_big:
type: string
device_class_info_url:
type: string
device_brand:
type: string
device_brand_code:
type: string
device_brand_homepage:
type: string
device_brand_icon:
type: string
device_brand_icon_big:
type: string
device_brand_info_url:
type: string
crawler_last_seen:
type: string
crawler_category:
type: string
crawler_category_code:
type: string
crawler_respect_robotstxt:
type: string
sec_ch_ua:
type: string
sec_ch_ua_full_version_list:
type: string
sec_ch_ua_mobile:
type: string
sec_ch_ua_full_version:
type: string
sec_ch_ua_platform:
type: string
sec_ch_ua_platform_version:
type: string
sec_ch_ua_model:
type: string
IpResult:
type: object
properties:
ip:
type: string
ip_ver:
type: number
ip_classification:
type: string
ip_classification_code:
type: string
ip_hostname:
type: string
ip_last_seen:
type: string
ip_country:
type: string
ip_country_code:
type: string
ip_city:
type: string
crawler_name:
type: string
crawler_ver:
type: string
crawler_ver_major:
type: string
crawler_family:
type: string
crawler_family_code:
type: string
crawler_family_homepage:
type: string
crawler_family_vendor:
type: string
crawler_family_vendor_code:
type: string
crawler_family_vendor_homepage:
type: string
crawler_family_icon:
type: string
crawler_family_info_url:
type: string
crawler_last_seen:
type: string
crawler_category:
type: string
crawler_category_code:
type: string
crawler_respect_robotstxt:
type: string
datacenter_name:
type: string
datacenter_name_code:
type: string
datacenter_homepage:
type: string
ParseUaV4Request:
type: object
properties:
uaString:
type: string
secChUa:
type: string
secChUaFullVersionList:
type: string
secChUaMobile:
type: string
secChUaFullVersion:
type: string
secChUaPlatform:
type: string
secChUaPlatformVersion:
type: string
secChUaModel:
type: string