-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
2049 lines (1983 loc) · 66.9 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
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
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: "3.0.0"
info:
version: "1.0.0"
title: "Datenplattform Darmstadt API"
description: "Datenplattform der Wissenschaftsstadt Darmstadt
Die Datenplattform soll nach Angaben der Digitalstadt Darmstadt GmbH zum Sammeln, Verarbeiten, Vernetzen, Analysieren und Visualisieren von Daten aus dem städtischen Alltag dienen.
Die Plattform ging im Februar 2021 online und die Kosten sollen sich in den Jahren 2020-2026 auf maximal 6,3 Mio. Euro (!) belaufen. Hierbei ist die Datenplattform nicht Open Source, es sollen allerdings 'einzelne Bestandteile' gesondert als Open Source zur Verfügung gestellt werden [[Quelle](https://www.digitalstadt-darmstadt.de/datenplattform-beteiligung/)].
### CORS
Die Datenplattform verfügt leider nicht über einen `Access-Control-Allow-Origin: *` Header. Daher funktionieren die Testabfragen innerhalb der Swagger UI nicht. Die angegebenen `CURL`-Befehle funktionieren in einer Konsole.
Zum Testen kann ein kostenloser CORS-Service verwendet werden (siehe Serverauswahl). Dieser CORS-Server wird von imjacobclark zur Verfügung gestellt. Die Abfragegeschwindigkeit ist reduziert [[GitHub](https://github.com/imjacobclark/cors-container)].
### [Link zur Datenplattform](https://datenplattform.darmstadt.de/#!/tiles/)
"
contact:
name: "Digitalstadt Darmstadt GmbH"
url: "https://www.digitalstadt-darmstadt.de/"
email: "[email protected]"
license:
name: Nutzungsbedingungen
url: https://datenplattform.darmstadt.de/legal/nutzungsbedingungen.html
servers:
- url: "https://datenplattform.darmstadt.de"
- url : "https://cors-container.herokuapp.com/https://datenplattform.darmstadt.de"
description: Enable CORS with free CORS-Container
tags:
- name: Map
- name: Klimaherzen
- name: Corona
- name: Open Weather
- name: Smart Waste
- name: Environment Data
- name: Events
- name: Traffic Directions
- name: Traffic
paths:
/Map/layers/1/features:
get:
summary: "Öffentliche WLAN Hotspots"
description: "Übersicht über die öffentlich WLAN Hotspots"
operationId: getPublicWlanHotspots
tags:
- Map
parameters:
- in: query
name: filter
explode: false
schema:
type: array
items:
type: string
examples:
Kein Filter:
value: []
areaName:
value: [areaName]
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/publicwlanhotspots"
/Map/layers/2/features:
get:
summary: "Temperatur"
description: "Temperaturdaten"
operationId: getEnvironmentTemperature
tags:
- Map
parameters:
- $ref: "#/components/parameters/filter"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/environment.temperature"
/Map/layers/3/features:
get:
summary: "Wassertemperatur"
description: "Wassertemperatur im Woog"
operationId: getEnvironmentWatertemperature
tags:
- Map
parameters:
- $ref: "#/components/parameters/filter"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/environment.watertemperature"
/Map/layers/4/features:
get:
summary: "Wetter Darmstadt"
description: "Wetter in Darmstadt"
operationId: getWeather
tags:
- Map
parameters:
- in: query
name: filter
explode: false
schema:
type: array
items:
type: string
examples:
Kein Filter:
value: []
temp-city:
value: [temp,city]
description: Temperatur, Stadt
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/weather"
/Map/layers/5/features:
get:
summary: "Glasscontainer"
description: "Füllstand der Glasscontainer in Darmstadt"
operationId: getGlassContainer
tags:
- Map
parameters:
- in: query
name: filter
explode: false
schema:
type: array
items:
type: string
examples:
Kein Filter:
value: []
value-location-status:
value: [value, location, status]
description: Wert, Ort, Status
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/glasscontainer"
/Map/layers/6/features:
get:
deprecated: true
summary: "PM10"
description: "PM10 Messstellen"
operationId: getPM10
tags:
- Map
parameters:
- $ref: "#/components/parameters/filter"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/environment.dust_pm10"
/Map/layers/7/features:
get:
deprecated: true
summary: "NO2"
description: "NO2 Messstellen"
operationId: getNO2
tags:
- Map
parameters:
- $ref: "#/components/parameters/filter"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/environment.no2"
/Map/layers/8/features:
get:
deprecated: true
summary: "O3"
description: "O3 Messstellen"
operationId: getO3
tags:
- Map
parameters:
- $ref: "#/components/parameters/filter"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/environment.o3"
/Map/layers/9/features:
get:
summary: "Verkehrslage"
description: "Messstellen und Informationen zur Verkehrslage"
operationId: getTraffic
tags:
- Map
parameters:
- in: query
name: filter
explode: false
schema:
type: array
items:
type: string
examples:
Kein Filter:
value: []
state:
value: [state]
description: State
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/traffic"
/Map/layers/2/features/14:
# TODO
get:
summary: "Datenabfrage"
description: "O3 Messstellen"
operationId: getO3_2
tags:
- Map
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/environment.temperature"
/Corona/events:
get:
summary: "Coronazahlen"
description: "Aktuelle Coronafallzahlen aus Darmstadt"
operationId: getEventsCorona
tags:
- Corona
parameters:
- $ref: "#/components/parameters/date"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/corona-events"
/SmartWaste/events:
get:
summary: "Smart Waste"
description: "Aktuelle Coronafallzahlen aus Darmstadt"
operationId: getEventsSmartWaste
tags:
- Smart Waste
parameters:
- $ref: "#/components/parameters/date"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/smartwaste-events"
/OpenWeatherMap/events:
get:
summary: "Open Weather"
description: "Open Weather für Darmstadt"
operationId: getEventsOpenWeather
tags:
- Open Weather
parameters:
- $ref: "#/components/parameters/date"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/open-weather-events"
/EnvironmentGeneric/events:
get:
summary: "Environment Data"
description: "Median oder historische Daten der Umweltsensoren von Darmstadt"
operationId: getEventsEnvironmentData
tags:
- Environment Data
parameters:
- $ref: "#/components/parameters/date"
- $ref: "#/components/parameters/since"
- $ref: "#/components/parameters/until"
responses:
"200":
description: OK
content:
application/json:
schema:
anyOf:
- $ref: "#/components/schemas/enviroment-events"
- $ref: "#/components/schemas/enviroment-historic-events"
/ZTIXEventCalendar/events:
get:
summary: "Events ZTIX"
description: "Zeigt Events von [ZTIX](https://www.ztix.de/hp/) an."
operationId: getEventsZTIX
tags:
- Events
parameters:
- $ref: "#/components/parameters/date"
responses:
"200":
description: OK
/Klimaherzen/events:
get:
summary: "Klimaherzen Daten"
description: "Zeigt Daten rund um die Klimaherzen-Aktion an. Die Daten werden mithilfe der App 'Darmstadt im Herzen' gesammelt [[Link](https://www.darmstadtimherzen.de/leben-in-darmstadt/darmstadt-im-herzen-app/)]."
operationId: getEventsKlimaherzen
tags:
- Klimaherzen
parameters:
- $ref: "#/components/parameters/date"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/klimaherzen-events"
/TrafficDirections/events:
get:
summary: "Verkehrsdaten"
description: "Aufgrund von 12 großen Kreuzungen um Darmstadt wird der Eingangs- und Ausgangsverkehr erfasst und in Relation gesetzt. "
operationId: getEventsTraffic
tags:
- Traffic Directions
parameters:
- $ref: "#/components/parameters/date"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/traffic-events"
/verkehr/apps/backend/sensordata:
get:
summary: "Verkehrsdaten"
description: "Die Werte für die Verkehrszählung stammen aus dem Verkehrsleitsystem. Die Daten sind im CSV-Format verfügbar und werden jede Minute aktualisiert."
operationId: getTrafficData
tags:
- Traffic
parameters:
- $ref: "#/components/parameters/since"
- $ref: "#/components/parameters/until"
- $ref: "#/components/parameters/lsa"
- $ref: "#/components/parameters/customHeaders"
responses:
"200":
description: OK
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/traffic-events"
/verkehr/apps/backend/config:
get:
summary: "Sensor Konfiguration"
description: "Sensor Konfiguration"
operationId: getTrafficSensorConfig
tags:
- Traffic
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/traffic-config"
components:
schemas:
publicwlanhotspots:
type: object
properties:
publicwlanhotspots:
type: array
items:
type: object
properties:
id:
type: number
format: int32
example: 1
identifier:
type: string
example: Wilhelminenstraße
geometry:
type: object
properties:
type:
type: string
example: Polygon
coordinates:
type: array
items:
type: array
items:
type: array
example: [ 8.65083, 49.87384]
items:
type: number
content:
type: object
properties:
areaName:
type: string
example: Wilhelminenstraße
environment.temperature:
type: object
properties:
environment.temperature:
type: array
items:
type: object
properties:
id:
type: number
format: int32
example: 14
identifier:
type: string
example: 70B3D5FFFEBF64CA_temperature
lng:
type: number
example: 8.67022277
lat:
type: number
example: 49.8729462
content:
type: object
properties:
deviceName:
type: string
example: 70B3D5FFFEBF64CA
environment.watertemperature:
type: object
properties:
environment.watertemperature:
type: array
items:
type: object
properties:
id:
type: number
format: int32
example: 13
identifier:
type: string
example: 70B3D5FFFEBF64CA_watertemperature
lng:
type: number
example: 8.67022277
lat:
type: number
example: 49.8729462
content:
type: object
properties:
deviceType:
type: string
example: Waterquality
layerTitle:
type: string
example: watertemperature
sensorLabel:
type: string
example: watertemperature
lon:
type: number
example: 8.67022277
rawTimestamp:
type: string
format: date-time
example: "2022-08-26T17:01:27.081+0000"
deviceName:
type: string
example: 70B3D5FFFEBF64CA
SID:
type: string
example: 2af4f631-237f-449e-bdd9-516351d13a4f
featureIdentifier:
type: string
example: 70B3D5FFFEBF64CA_watertemperature
belowThreshold:
type: string
nullable: true
unit:
type: string
nullable: true
layerName:
type: string
example: environment.watertemperature
value:
type: number
example: 25.670000076293945
lat:
type: number
example: 49.8729462
timestamp:
type: string
format: date-time
example: "2022-08-26T17:01:27.252+0000"
upSensorDescription:
type: object
properties:
reference:
type: object
properties:
deviceName:
type: string
example: 70B3D5FFFEBF64CA
sensorLabel:
type: string
example: watertemperature
weather:
type: object
properties:
weather.Darmstadt:
type: array
items:
type: object
properties:
id:
type: number
example: 111
identifier:
type: string
example: 9d4d7a0f-aa19-4eb2-9d70-ff78eff2879a
lng:
type: number
example: 8.6494
lat:
type: number
example: 49.8706
content:
type: object
properties:
temp:
type: number
example: 10.55
sunrise:
type: string
format: date-time
example: "2022-09-29T05:21:52.000+0000"
weather_id:
type: number
example: 804
visibility:
type: number
example: 6000
city:
type: string
example: Darmstadt
countrycode:
type: string
example: DE
lon:
type: number
example: 8.6494
pressure:
type: number
example: 1003
clouds:
type: number
example: 100
weather_icon:
type: string
example: 04d
temp_max:
type: number
example: 13.87
SID:
type: string
example: 9d4d7a0f-aa19-4eb2-9d70-ff78eff2879a
featureIdentifier:
type: string
example: 9d4d7a0f-aa19-4eb2-9d70-ff78eff2879a
zipcode:
type: string
example: "64293"
_headers:
type: object
properties:
eventType:
type: string
example: OpenWeatherMapEventType
temp_min:
type: number
example: 7.7
wind_deg:
type: number
example: 220
sunset:
type: string
format: date-time
example: "2022-09-29T17:09:36.000+0000"
humidity:
type: number
example: 79
wind_speed:
type: number
example: 1.54
layerName:
type: string
example: weather.Darmstadt
lat:
type: number
example: 49.8706
timestamp:
type: string
format: date-time
example: "2022-09-29T09:25:14.538+0000"
glasscontainer:
type: object
properties:
wasteGlass:
type: array
items:
type: object
properties:
id:
type: number
example: 648
identifier:
type: string
example: "2027597"
lng:
type: number
example: 8.674068
lat:
type: number
example: 49.896324
content:
type: object
properties:
layerTitle:
type: string
example: WasteGlass
otherTypes:
type: array
example: []
location:
type: string
example: Borsdorffstraße / Strahringerplatz | An der Straßenbahnhaltestelle
lon:
type: number
example: 8.674068
layerName:
type: string
example: wasteGlass
value:
type: number
example: 99
lat:
type: number
example: 49.896324
SID:
type: string
example: 723bd39b-f03d-40e0-b5a9-87cc847e8002
timestamp:
type: string
format: date-time
example: "2022-07-19T07:01:00.705+0000"
featureIdentifier:
type: string
example: "2027597"
status:
type: string
example: full
environment.dust_pm10:
type: object
properties:
environment.dust_pm10:
type: array
items:
type: object
properties:
id:
type: number
example: 331
identifier:
type: string
example: 0115_dust_pm10
lng:
type: number
example: 8.6537515
lat:
type: number
example: 49.86945564
content:
type: object
properties:
deviceType:
type: string
example: HLNUG
layerTitle:
type: string
example: dust_pm10
sensorLabel:
type: string
example: dust_pm10
lon:
type: number
example: 8.6537515
rawTimestamp:
type: string
format: date-time
example: "2022-09-29T09:00:00.000+0000"
deviceName:
type: string
example: "0115"
SID:
type: string
example: 81d93124-e972-43d0-b0af-4870ebc93fe2
featureIdentifier:
type: string
example: 0115_dust_pm10
belowThreshold:
type: boolean
unit:
type: string
example: µg/m³
layerName:
type: string
example: environment.dust_pm10
value:
type: number
example: 20.7
lat:
type: number
example: 49.86945564
timestamp:
type: string
format: date-time
example: "2022-09-29T09:31:23.828+0000"
upSensorDescription:
type: object
properties:
reference:
type: object
properties:
station:
type: string
example: "0115"
eventName:
type: string
example: pm10
environment.no2:
type: object
properties:
environment.no2:
type: array
items:
type: object
properties:
id:
type: number
example: 551
identifier:
type: string
example: 0115_no2
lng:
type: number
example: 8.6537515
lat:
type: number
example: 49.86945564
content:
type: object
properties:
deviceType:
type: string
example: HLNUG
layerTitle:
type: string
example: no2
sensorLabel:
type: string
example: no2
lon:
type: number
example: 8.6537515
rawTimestamp:
type: string
format: date-time
example: "2022-09-29T09:00:00.000+0000"
deviceName:
type: string
example: "0115"
SID:
type: string
example: 20365e06-9fe9-4f0b-8e0d-29ad4620fba1
featureIdentifier:
type: string
example: 0115_no2
belowThreshold:
type: boolean
unit:
type: string
example: µg/m³
layerName:
type: string
example: environment.no2
value:
type: number
example: 22.1
lat:
type: number
example: 49.86945564
timestamp:
type: string
format: date-time
example: "2022-09-29T09:36:23.828+0000"
upSensorDescription:
type: object
properties:
reference:
type: object
properties:
station:
type: string
example: "0115"
eventName:
type: string
example: no2
environment.o3:
type: object
properties:
environment.o3:
type: array
items:
type: object
properties:
id:
type: number
example: 441
identifier:
type: string
example: 0104_o3
lng:
type: number
example: 8.66461944
lat:
type: number
example: 49.87230278
content:
type: object
properties:
deviceType:
type: string
example: HLNUG
layerTitle:
type: string
example: o3
sensorLabel:
type: string
example: o3
lon:
type: number
example: 8.66461944
rawTimestamp:
type: string
format: date-time
example: "2022-09-29T09:00:00.000+0000"
deviceName:
type: string
example: "0104"
SID:
type: string
example: 03ecbcf4-564e-4a3d-9845-ed6a9d25036b
featureIdentifier:
type: string
example: 0104_o3
belowThreshold:
type: boolean
unit:
type: string
example: µg/m³
layerName:
type: string
example: environment.o3
value:
type: number
example: 18.2
lat:
type: number
example: 49.87230278
timestamp:
type: string
format: date-time
example: "2022-09-29T09:36:23.828+0000"
upSensorDescription:
type: object
properties:
reference:
type: object
properties:
station:
type: string
example: "0104"
eventName:
type: string
example: o3
traffic:
type: object
properties:
trafficCongestion:
type: array
items:
type: object
properties:
id:
type: number
example: 224
identifier:
type: string
example: "120682496"
geometry:
type: object
properties:
type:
type: string
example: LineString
coordinates:
type: array
items:
type: array
example: [8.6575842,49.8834932]
items:
type: number