-
-
Notifications
You must be signed in to change notification settings - Fork 164
/
webapi.yaml
725 lines (725 loc) · 28.6 KB
/
webapi.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
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
openapi : 3.0.1
info :
title : Little Navmap Web API
description : ''
version : 1.0.0
servers :
- url : http://localhost:8965/api
tags :
- name : Airport
description : AirportActionsController
- name : Map
description : MapActionsController
- name : Sim
description : SimActionsController
- name : UI
description : UiActionsController
paths :
/airport/info :
get :
tags :
- Airport
summary : Get airport information by ICAO code
operationId : airportInfoAction
parameters :
- name : ident
required : true
in : query
description : Airport ICAO code
schema :
type : string
example : eddm
responses :
200 :
description : Airport information
content :
application/json :
schema :
$ref : '#/components/schemas/AirportInfoResponse'
400 :
description : Airport not found
content :
text/plain :
schema :
type : string
example : "Airport not found"
/map/image :
get :
tags :
- Map
summary : Get map image by lat/lon rectangle
operationId : mapImageAction
parameters :
- name : toplat
required : true
in : query
description : Top latitude
schema :
type : number
example : 10
- name : bottomlat
required : true
in : query
description : Bottom latitude
schema :
type : number
example : 15
- name : leftlon
required : true
in : query
description : Left longitude
schema :
type : number
example : 40
- name : rightlon
required : true
in : query
description : Right longitude
schema :
type : number
example : 45
- name : width
required : true
in : query
description : Width in pixels
schema :
type : number
example : 256
- name : height
required : true
in : query
description : Height in pixels
schema :
type : number
example : 256
- name : quality
required : true
in : query
description : Image quality
schema :
type : number
example : 80
- name : format
required : true
in : query
description : Image format
schema :
type : string
enum : [png, jpg]
- name : detailfactor
required : true
in : query
description : Detail factor
schema :
type : integer
minimum : 8
maximum : 15
example : 10
responses :
200 :
description : Resulting map image
content :
image/png :
schema :
type : string
format : binary
/map/features :
get :
tags :
- Map
summary : Get features by lat/lon rectangle
operationId : mapFeaturesAction
parameters :
- name : toplat
required : true
in : query
description : Top latitude
schema :
type : number
example : 10
- name : bottomlat
required : true
in : query
description : Bottom latitude
schema :
type : number
example : 15
- name : leftlon
required : true
in : query
description : Left longitude
schema :
type : number
example : 40
- name : rightlon
required : true
in : query
description : Right longitude
schema :
type : number
example : 45
- name : detailfactor
required : true
in : query
description : Detail factor
schema :
type : integer
minimum : 8
maximum : 15
example : 10
responses :
200 :
description : map feature list
content :
application/json :
schema :
$ref : '#/components/schemas/MapFeaturesResponse'
/map/feature :
get :
tags :
- Map
summary : Get feature by map object id and object type id
operationId : mapFeatureAction
parameters :
- name : object_id
required : true
in : query
description : the map object id
schema :
type : number
example : 10
- name : type_id
required : true
in : query
description : the map object type id
schema :
type : number
example : 1
responses :
200 :
description : map feature list
content :
application/json :
schema :
$ref : '#/components/schemas/MapFeaturesResponse'
/sim/info :
get :
tags :
- Sim
summary : Get active simulation information
operationId : simInfoAction
responses :
200 :
description : Simulation information
content :
application/json :
schema :
$ref : '#/components/schemas/SimInfoResponse'
/ui/info :
get :
tags :
- UI
summary : Get UI information
operationId : uiInfoAction
responses :
200 :
description : UI information
content :
application/json :
schema :
$ref : '#/components/schemas/UiInfoResponse'
components :
schemas :
Coordinates :
type : object
description : Common coordinates type
properties :
lat :
type : number
lon :
type : number
AirportInfoResponse :
type : object
properties :
activeDateTime :
description : The active LNM time
example : "Fr Jul 9 19:54:59 2021 GMT"
type : string
format : date-time
activeDateTimeSource :
description : The active LNM time source
example :
- "simulator date"
- "real date"
type : string
city :
description : The airports city
example : "München"
type : string
closed :
description : airport closed
type : boolean
com :
description : The airports available COM frequencies
type : object
properties :
ATIS :
type : number
description : Only set if available. (Format 000,000 MHz)
example : "123450"
Tower :
type : number
description : Only set if available. (Format 000,000 MHz)
example : "123450"
AWOS :
type : number
description : Only set if available. (Format 000,000 MHz)
example : "123450"
ASOS :
type : number
description : Only set if available. (Format 000,000 MHz)
example : "123450"
UNICOM :
type : number
description : Only set if available. (Format 000,000 MHz)
example : "123450"
country :
description : The airports country
type : string
example : ""
elevation :
description : The airports elevation in feet
type : number
example : "1468"
facilities :
description : Array of airport facilities/features
type : array
items :
type : string
example :
- "Aprons"
- "Taxiways"
- "ILS"
- "Avgas"
- "Jetfuel"
iata :
description : The airports IATA code
type : string
example : ""
icao :
description : The airports ICAO code
type : string
example : ""
ident :
description : The airports ident (ICAO)
type : string
example : "EDDM"
longestRunwayHeading :
description : The airports longest runway heading
type : string
example : "81°M, 261°M"
longestRunwayLength :
description : The airports longest runway length in metres
type : number
example : "13106"
longestRunwaySurface :
description : The airports longest runway surface
type : string
example : "CE"
longestRunwayWidth :
description : The airports longest runway width in metres
type : number
example : "188"
magneticDeclination :
description : The airports magnetic variation/declination (+/East, -/West)
type : number
example : "1.9"
metar :
description : The airports METAR weather reports
type : object
properties :
simulator :
description : Only set if available
type : object
properties :
nearest :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
station :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
activesky :
description : Only set if available
type : object
properties :
nearest :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
station :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
noaa :
description : Only set if available
type : object
properties :
nearest :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
station :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
vatsim :
description : Only set if available
type : object
properties :
nearest :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
station :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
ivao :
description : Only set if available
type : object
properties :
nearest :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
station :
type : string
example : "EDDM 091920Z 35005KT 320V020 9999 -SHRA FEW015 SCT025CB 16/14 Q1022 RESHRA NOSIG"
name :
description : The airports name
type : string
example : "München"
parking :
description : The airports parking capacities
type : object
properties :
gates :
type : integer
description : Only set if available
format : int32
jetWays :
type : integer
description : Only set if available
format : int32
gaRamps :
type : integer
description : Only set if available
format : int32
cargo :
typ : integer
description : Only set if available
format : int32
militaryCargo :
type : integer
description : Only set if available
format : int32
militaryCombat :
type : integer
description : Only set if available
format : int32
helipads :
type : integer
description : Only set if available
format : int32
position :
description : The airports geographical position
$ref : '#/components/schemas/Coordinates'
rating :
description : The airports rating
type : integer
format : int32
region :
description : The airports region
type : string
example : ""
runways :
description : Array of airport runway flags
type : array
items :
type : string
example :
- "Hard"
- "Lighted"
state :
description : The airports state/province
type : string
example : ""
sunrise :
description : The airports sunrise time
type : string
example : "02:40:40"
sunset :
description : The airports sunset time
type : string
example : "19:54:52"
transitionAltitude :
description : The airports transition altitude in feet
type : number
example : "5000"
SimInfoResponse :
type : object
properties :
active :
type : boolean
altitude_above_ground :
description : "ft"
type : number
example : 1737.796875
ground_altitude :
description : "meters (?)"
type : number
example : 0.05364101380109787
ground_speed :
description : "kts"
type : number
example : 178.37759399414062
heading :
type : number
description : "degrees"
example : 155.85145568847656
indicated_altitude :
description : "ft"
type : number
example : 1799.44482421875
indicated_speed :
description : "kts"
type : number
example : 173.4679718017578
position :
description : The user aircrafts geographical position
$ref : '#/components/schemas/Coordinates'
sea_level_pressure :
description : "Mbar"
type : number
example : 1020
simconnect_status :
type : string
example : "No error"
true_airspeed :
description : "kts"
type : number
example : 178.34288024902344
vertical_speed :
description : "fpm"
type : number
example : -4.088292598724365
wind_direction :
description : "degrees corrected by aircrafts position magvar"
type : number
example : 50.69130325317383
wind_speed :
description : "kts"
type : number
example : 4.874995708465576
UiInfoResponse :
type : object
description : Common UI info
properties :
zoom_ui :
description : the zoom value of the map inside LNM UI
type : number
example : 1803
zoom_web :
description : the zoom value of the map inside LNM Web UI
type : number
example : 1803
distance_ui :
description : the distance value of the map inside LNM UI in km
type : number
example : 6.814605113425086
distance_web :
description : the distance value of the map inside LNM Web UI in km
type : number
example : 6.814605113425086
latLonRect_ui :
description : the north latitude, the east longitude, the south latitude, the west longitude of the current view
type : array(float[4])
example : [90.0, 180.0, -90.0, -180.0]
latLonRect_web :
description : the north latitude, the east longitude, the south latitude, the west longitude of the current view
type : array(float[4])
example : [90.0, 180.0, -90.0, -180.0]
MapFeaturesResponse :
type : object
description : List of map features
properties :
airports :
description : airports list
type : object
properties :
count :
type : number
example : 361
result :
type : array
items :
type : object
$ref : '#/components/schemas/MapAirportFeature'
ndbs :
description : NDBs list
type : object
properties :
count :
type : number
example : 361
result :
type : array
items :
type : object
$ref : '#/components/schemas/MapNDBFeature'
vors :
description : VORs list
type : object
properties :
count :
type : number
example : 361
result :
type : array
items :
type : object
$ref : '#/components/schemas/MapVORFeature'
markers :
description : markers list
type : object
properties :
count :
type : number
example : 361
result :
type : array
items :
type : object
$ref : '#/components/schemas/MapMarkerFeature'
waypoints :
description : markers list
type : object
properties :
count :
type : number
example : 361
result :
type : array
items :
type : object
$ref : '#/components/schemas/MapWaypointFeature'
MapObject :
type : object
description : Identifiable map object
properties :
object_id :
description : the map object id
type : number
example : 1
type_id :
description : the map object type id
type : number
example : 1
MapAirportFeature :
type : object
description : Single airport list entry
allOf :
- $ref : '#/components/schemas/MapObject'
properties :
elevation :
description : the airports elevation in ft
type : number
example : 1352
ident :
description : The airports ident (ICAO)
type : string
example : "LOIH"
name :
description : The airpotrts name
type : string
example : "Dornbirn"
position :
description : The airports geographical position
$ref : '#/components/schemas/Coordinates'
MapNDBFeature :
type : object
description : Single NDB list entry
allOf :
- $ref : '#/components/schemas/MapObject'
properties :
elevation :
description : the NDB elevation in ft
type : number
example : 3.40
ident :
description : The NDB ident (ICAO)
type : string
example : "OB"
name :
description : The NDB name
type : string
example : "Overberg"
position :
description : The NDB geographical position
$ref : '#/components/schemas/Coordinates'
MapVORFeature :
type : object
description : Single VOR list entry
allOf :
- $ref : '#/components/schemas/MapObject'
properties :
elevation :
description : the VOR elevation in ft
type : number
example : 659
ident :
description : The VOR ident (ICAO)
type : string
example : "GRV"
name :
description : The VOR name
type : string
example : "George"
position :
description : The VOR geographical position
$ref : '#/components/schemas/Coordinates'
MapMarkerFeature :
type : object
description : Single marker list entry
allOf :
- $ref : '#/components/schemas/MapObject'
properties :
elevation :
description : the marker elevation in ft
type : number
example : 0
ident :
description : The marker ident (ICAO)
type : string
example : "AL"
type :
description : The marker type
type : string
example : "OUTER"
position :
description : The airports geographical position
$ref : '#/components/schemas/Coordinates'
MapWaypointFeature :
type : object
description : Single waypoint list entry
allOf :
- $ref : '#/components/schemas/MapObject'
properties :
elevation :
description : the marker elevation in ft
type : number
example : 0
ident :
description : The marker ident (ICAO)
type : string
example : "AL"
type :
description : The marker type
type : string
example : "OUTER"
position :
description : The airports geographical position
$ref : '#/components/schemas/Coordinates'