-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
1312 lines (1288 loc) · 41.9 KB
/
swagger.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:
title: EasyTrip
version: 1.0.0
description: EasyTrip official API
license:
name: Licensed Under MIT
url: https://spdx.org/licenses/MIT.html
contact:
name: JSONPlaceholder
url: https://jsonplaceholder.typicode.com
servers:
- url: http://localhost:12349
description: EasyTrip Facade server
- url: http://localhost:12348
description: Path Search server
- url: http://localhost:12347
description: Point Search server
- url: http://localhost:12346
description: OSM Tools server
- url: http://localhost:12345
description: Auth Tools server
paths:
'/v1/users/login':
post:
summary: Authentication of an user and get a new token
description: Authentication of an used based on the username and password and get a token
tags:
- Auth Tools
requestBody:
content:
application/json:
schema:
type: object
required:
- username
- password
properties:
username:
type: string
example: 'user1'
password:
type: string
example: 'user1_password'
responses:
'200':
description: Token sucessfully created
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/user'
- description: User results object
'400':
$ref: '#/components/responses/BadRequest'
'/v1/users/auth/google':
get:
summary: Authentication of an user via google and get a token
description: Authentication of an user based on the google account and get a token. The user is redirected to the Google Authentication Page; if the authentication ends correctly it returns the username of the user with his email
tags:
- Auth Tools
responses:
'200':
description: Token sucessfully created
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/user'
- description: User results object
'400':
$ref: '#/components/responses/BadRequest'
'/v1/users/signup':
post:
summary: Create new user and get a new token
description: Create a new user and get a token
tags:
- Auth Tools
requestBody:
content:
application/json:
schema:
type: object
required:
- username
- email
- password
- passwordConfirm
properties:
username:
type: string
example: 'user1'
email:
type: string
example: 'user@domain.com'
password:
type: string
example: 'user1_password'
passwordConfirm:
type: string
example: 'user1_password'
responses:
'200':
description: New user sucessfully created
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/user'
- description: User results object
'400':
$ref: '#/components/responses/BadRequest'
'409':
$ref: '#/components/responses/ExistingUser'
'/v1/routing/geocode':
get:
summary: Get coordinates and various informations of a given address
description: Get coordinates and various informations of a given address
tags:
- OSM Tools
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/limit'
- name: closestTo
in: query
description: If specified, the endpoint will return the result closest to this point (if any), otherwise it will return up to <limit> results
schema:
$ref: '#/components/schemas/pointStr'
example: "45.439124213114084,10.994315086270243"
- name: onlyPlaces
in: query
description: If true, results will be only OSM places (es. city, ...)
schema:
type: boolean
example: false
responses:
'200':
description: Geocode results retrieved
content:
application/json:
schema:
type: object
properties:
hits:
type: array
items:
$ref: '#/components/schemas/geocode'
example:
- $ref: 'docExamples/arenaGeocode.json'
locale:
type: string
description: Language used
example: "en"
'400':
$ref: '#/components/responses/BadRequest'
'/v1/routing/route':
get:
summary: Get the route between two points
description: Get the route between two points
tags:
- OSM Tools
parameters:
- name: point
in: query
description: Points of the route. You have to specify point singularly (the order count). E.g., &point=45.439124213114084,10.994315086270243&point46.06339563874866,11.114865753180371
schema:
type: array
minItems: 2
items:
$ref: '#/components/schemas/pointStr'
example: ["45.439124213114084,10.994315086270243","46.06339563874866,11.114865753180371"]
- $ref: '#/components/parameters/profile'
- name: shortAnswer
in: query
description: If true the endpoint will return only information about the route, otherwise it will return points and instructions
schema:
type: boolean
example: false
responses:
'200':
description: Resulting route retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/route'
'400':
$ref: '#/components/responses/BadRequest'
'/v1/locations/poi':
get:
summary: Get points of interests within an area
description: Get points of interests within an area
tags:
- OSM Tools
parameters:
- $ref: '#/components/parameters/requiredInterest'
- name: point
in: query
description: Center of search (Format <latitude>,<longitude>)
schema:
$ref: '#/components/schemas/pointStr'
example: ["45.438611","10.992778"]
- name: squareSide
in: query
description: Side of the bounding box created from point
schema:
type: number
minimum: 0
default: 20000
example: 20000
- name: bbox
in: query
description: If specified, point and squareSide are ignored and this become the area of search
schema:
$ref: '#/components/schemas/bboxStr'
example: "10.8768512,45.3494402,11.1239,45.5418375"
responses:
'200':
description: Resulting points of interests retrieved
content:
application/json:
schema:
type: object
properties:
version:
$ref: '#/components/schemas/overpassVersion'
generator:
$ref: '#/components/schemas/overpassGenerator'
osm3s:
$ref: '#/components/schemas/overpassOsm3s'
elements:
$ref: '#/components/schemas/poiArray'
'400':
$ref: '#/components/responses/BadRequest'
'/v1/locations/nearbyCities':
get:
summary: Get residential areas around a point
description: Get residential areas around a point
tags:
- OSM Tools
parameters:
- name: point
in: query
description: Center of search (Format <latitude>,<longitude>)
schema:
$ref: '#/components/schemas/pointStr'
example: ["45.438611","10.992778"]
- name: range
in: query
description: Range of search
schema:
type: number
minimum: 0
default: 5000
example: 5000
responses:
'200':
description: Resulting cities
content:
application/json:
schema:
type: object
properties:
version:
$ref: '#/components/schemas/overpassVersion'
generator:
$ref: '#/components/schemas/overpassGenerator'
osm3s:
$ref: '#/components/schemas/overpassOsm3s'
elements:
$ref: '#/components/schemas/citiesArray'
'400':
$ref: '#/components/responses/BadRequest'
'/v1/weather/current':
get:
summary: Get current weather given a certain place
description: Return the information about the current weather status for the searched city
tags:
- Point Search
parameters:
- $ref: '#/components/parameters/city'
responses:
'200':
description: Return a JSON with current weather status on given city
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
description: Success of request
text:
type: string
example: 'current weather in Trento is Clear sky'
description: description of the current weather status in natural language
message:
type: string
example: 'Clear sky'
description: current weather statusDocumenti
'/v1/weather/forecast':
get:
summary: Get weather forecast given a certain place
tags:
- Point Search
parameters:
- $ref: '#/components/parameters/city'
description: Return an array of weather forecasts up to 16 days for the searched city
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
description: Success of request
text:
type: string
example: 'In the next 16 days, in Trento the weather will be: on day 0, Few clouds, on day 1, Clear Sky, on day 2, Mix snow/rain, on day 3, Flurries, on day 4, Flurries, on day 5, Few clouds, on day 6, Broken clouds, on day 7, Flurries, on day 8, Few clouds, on day 9, Broken clouds, on day 10, Clear Sky, on day 11, Clear Sky, on day 12, Light snow, on day 13, Heavy snow, on day 14, Heavy snow, on day 15, Mix snow/rain.'
description: description of the weather forecasts for the next 16 days in natuaral language
message:
type: array
example:
- "Few clouds"
- "Clear Sky"
- "Mix snow/rain"
- "Flurries"
- "Flurries"
- "Few clouds"
- "Broken clouds"
- "Flurries"
- "Few clouds"
- "Broken clouds"
- "Clear Sky"
- "Clear Sky"
- "Light snow"
- "Heavy snow"
- "Heavy snow"
- "Mix snow/rain"
description: array of weather forecasts of the next 16 days
items:
type: string
'/v1/bikes/networks':
get:
summary: Get data about bike sharing available in a certain place
tags:
- Point Search
parameters:
- $ref: '#/components/parameters/city'
description: Return information about the bike sharing service available in the searched city
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Success of request
message:
$ref: '#/components/schemas/bikes'
'404':
description: Not found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Outcome of the Request
message:
type: string
description: Empty message
'/v2/combined/about':
get:
summary: Get information about weather, bike sharing and points of interest in a certain location based on some choices
description: Return the information about weather, bike sharing and points of interest in a certain location (can choose if all three fields will be returned or if some of them) based on some interests
tags:
- Point Search
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/weather'
- $ref: '#/components/parameters/bikes'
- $ref: '#/components/parameters/interest'
responses:
'200':
description: Object about requested information and points of interest
content:
application/json:
schema:
type: object
properties:
address:
$ref: '#/components/schemas/start'
weather:
$ref: '#/components/schemas/weather'
bike:
$ref: '#/components/schemas/bikes'
poi:
$ref: '#/components/schemas/poiArray'
'400':
$ref: '#/components/responses/BadRequest'
'/v1/path/stops':
get:
summary: Get stops, based on user interests, for a travel
description: Get stops, based on user interests, for a travel
tags:
- Path Search
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/requiredInterest'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/minDistance'
- $ref: '#/components/parameters/maxDetour'
- $ref: '#/components/parameters/profile'
- name: poisDescriptions
in: query
description: If false returns a short answer with only the number of points of interests per stop. Otherwise return points of interests in full
schema:
type: boolean
default: true
example: true
responses:
'200':
description: Resulting stops retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/routeStops'
'400':
$ref: '#/components/responses/BadRequest'
'/v1/path/route':
get:
summary: Get route with stops based on user interests
description: Get route with stops based on user interests
tags:
- Path Search
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/requiredInterest'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/minDistance'
- $ref: '#/components/parameters/maxDetour'
- $ref: '#/components/parameters/profile'
responses:
'200':
$ref: '#/components/responses/pathRoute'
'400':
$ref: '#/components/responses/BadRequest'
post:
summary: Get route with stops based on user interests
description: Get route with stops based on user interests
tags:
- Path Search
parameters:
- $ref: '#/components/parameters/profile'
requestBody:
description: Stops of the route
required: true
content:
application/json:
schema:
type: object
properties:
stops:
$ref: '#/components/schemas/routeStops'
responses:
'200':
$ref: '#/components/responses/pathRoute'
'400':
$ref: '#/components/responses/BadRequest'
'/v1/trip/destination':
get:
summary: Get the information the destination of the trip
description: Return information about the weather, bike sharing and points of interest for the destination of the trip
tags:
- EasyTrip Facade
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/weather'
- $ref: '#/components/parameters/bikes'
- $ref: '#/components/parameters/interest'
responses:
'200':
description: Object about requested information and points of interest
content:
application/json:
schema:
$ref: '#/components/schemas/endInfo'
'400':
$ref: '#/components/responses/BadRequest'
'/v1/trip/travel':
get:
summary: Get information of the travel of the trip
description: Get information of the travel of the trip
tags:
- EasyTrip Facade
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/weather'
- $ref: '#/components/parameters/bikes'
- $ref: '#/components/parameters/travelInterest'
- $ref: '#/components/parameters/travelLimit'
- $ref: '#/components/parameters/minDistance'
- $ref: '#/components/parameters/maxDetour'
- $ref: '#/components/parameters/profile'
responses:
'200':
description: Resoulting travel
content:
application/json:
schema:
type: object
properties:
start:
type: object
description: Beginning of the trip
properties:
address:
$ref: '#/components/schemas/start'
end:
allOf:
- $ref: '#/components/schemas/endInfo'
- description: Destination of the trip
intermediates:
type: array
description: Intermediary stops
items:
$ref: '#/components/schemas/intermediateInfo'
paths:
$ref: '#/components/schemas/paths'
'400':
$ref: '#/components/responses/BadRequest'
'/v1/history':
post:
summary: Clean errors and save a research
description: Clean errors and save a destination or travel research
tags:
- EasyTrip Facade
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/searchToSave'
responses:
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/ServerError'
get:
summary: Get the history of the research of a user
description: Return the history of the research of a user (both destination and travel search)
tags:
- EasyTrip Facade
parameters:
- $ref: '#/components/parameters/token'
responses:
'200':
description: History of the user retrieved
content:
application/json:
schema:
type: object
properties:
history:
allOf:
- $ref: '#/components/schemas/history'
- description: History results object
'401':
$ref: '#/components/responses/NoToken'
'403':
$ref: '#/components/responses/InvalidToken'
'500':
$ref: '#/components/responses/ServerError'
'/v1/history/{id}':
delete:
summary: Delete a research saved in the history
description: Delete a research in the history for the user identified by the token and based on the id given
tags:
- EasyTrip Facade
parameters:
- $ref: '#/components/parameters/token'
- name: id
in: path
required: true
description: The id of the search to delete
schema:
type: string
responses:
'200':
description: Search deleted
'401':
$ref: '#/components/responses/NoToken'
'403':
$ref: '#/components/responses/InvalidToken'
'500':
$ref: '#/components/responses/ServerError'
components:
parameters:
city:
name: city
in: query
schema:
type: string
required: true
address:
description: Address to search
name: address
in: query
schema:
type: string
required: true
example: "Verona"
limit:
description: Max number of results
name: limit
in: query
schema:
$ref: '#/components/schemas/limit'
example: 1
travelLimit:
description: Max number of results. If interest is not specified this does not count
name: limit
in: query
schema:
$ref: '#/components/schemas/limit'
example: 1
token:
name: x-access-token
in: header
required: true
description: user jwt of the session
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0.yRQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw'
schema:
type: string
weather:
name: weather
in: query
description: describe if in the request user wants weather forecasts
schema:
$ref: '#/components/schemas/weatherIndicator'
example: false
bikes:
name: bikes
in: query
description: describe if in the request user wants bike sharing
schema:
$ref: '#/components/schemas/bikesIndicator'
example: false
interest:
name: interest
in: query
description: User interests. If not specified it the searchs won't be performed
schema:
$ref: '#/components/schemas/interests'
requiredInterest:
name: interest
in: query
description: User interests
required: true
schema:
$ref: '#/components/schemas/interests'
travelInterest:
name: interest
in: query
description: User interests. If not specified it the searchs of point of interests and intermediates stops won't be performed
schema:
$ref: '#/components/schemas/interests'
profile:
name: profile
in: query
description: describe the type of travel
schema:
$ref: '#/components/schemas/profile'
example: "car"
start:
description: Starting address
name: start
in: query
schema:
type: string
required: true
example: "Arena Verona"
end:
description: Ending address
name: end
in: query
schema:
type: string
required: true
example: "I portoni della brà"
minDistance:
name: minDistance
in: query
description: Minimum distance between two stops
schema:
$ref: '#/components/schemas/minDistance'
example: 20000
maxDetour:
name: maxDetour
in: query
description: Max distance of a detour for a stop. It has to be less or equal then minDistance/2, otherwise its default value wil be that value
schema:
$ref: '#/components/schemas/maxDetour'
example: 10000
schemas:
limit:
type: integer
minimum: 0
weatherIndicator:
type: boolean
description: describe if in the request user wants weather forecasts
default: false
example: false
bikesIndicator:
type: boolean
description: describe if in the request user wants bike sharing
default: false
example: false
interests:
type: array
items:
type: string
description: interest of the search for the points of interests
enum:
- "sustenance"
- "education"
- "entertainment"
- "tourism"
- "accomodation"
profile:
type: string
description: describe the type of travel. If limit is not specified this does not count
enum:
- "car"
- "foot"
- "bike"
default: "car"
example: "car"
minDistance:
type: number
description: Minimum distance between two stops. If limit is not specified this does not count
minimum: 0
default: 20000
example: 20000
maxDetour:
type: number
description: Max distance of a detour for a stop. It has to be less or equal then minDistance/2, otherwise its default value wil be that value. if minDistance is not specified this does not count
minimum: 0
example: 10000
user:
type: object
properties:
username:
type: string
description: username of the user
example: user1
token:
type: string
description: token of the user
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0.yRQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw'
commonHistoryParameters:
type: object
additionalProperties: false
properties:
interest:
$ref: '#/components/schemas/interests'
weather:
$ref: '#/components/schemas/weatherIndicator'
bikes:
$ref: '#/components/schemas/bikesIndicator'
travelParameters:
allOf:
- type: object
description: parameters for travel search
required:
- start
- end
properties:
start:
type: string
description: Starting address
end:
type: string
description: Ending address
limit:
allOf:
- $ref: '#/components/schemas/limit'
- description: Max number of results. If interest is not specified this does not count
default: 0
example: 0
minDistance:
$ref: '#/components/schemas/minDistance'
maxDetour:
$ref: '#/components/schemas/maxDetour'
profile:
$ref: '#/components/schemas/profile'
- $ref: '#/components/schemas/commonHistoryParameters'
destinationParameters:
allOf:
- type: object
description: parameters for destination search
required:
- address
properties:
address:
type: string
description: Destination address
- $ref: '#/components/schemas/commonHistoryParameters'
historyElementBase:
type: object
properties:
route:
type: string
description: First part of the endpoint used for the research
type:
type: string
description: Final part of the endpoint used for the research
enum:
- travel
- destination
searchToSave:
allOf:
- $ref: '#/components/schemas/historyElementBase'
- description: Search information to save
properties:
parameters:
oneOf:
- $ref: '#/components/schemas/travelParameters'
- $ref: '#/components/schemas/destinationParameters'
example:
$ref: 'docExamples/searchToSave.json'
historyElementNewParams:
type: object
properties:
_id:
type: string
description: ID of the research
dateTime:
type: string
description: date of when the search was made
url:
type: string
description: Path and query to replicate the research
travelHistoryElement:
allOf:
- $ref: '#/components/schemas/historyElementBase'
- $ref: '#/components/schemas/historyElementNewParams'
- description: Search information to save
properties:
parameters:
$ref: '#/components/schemas/travelParameters'
destinationHistoryElement:
allOf:
- $ref: '#/components/schemas/historyElementBase'
- $ref: '#/components/schemas/historyElementNewParams'
- description: Search information to save
properties:
parameters:
$ref: '#/components/schemas/destinationParameters'
history:
type: object
properties:
travel:
type: array
description: Travel search results
items:
$ref: '#/components/schemas/travelHistoryElement'
destination:
type: array
items:
$ref: '#/components/schemas/destinationHistoryElement'
example:
$ref: 'docExamples/history.json'
geocode:
type: object
description: Geocode result
properties:
point:
type: object
properties:
lat:
$ref: '#/components/schemas/latitude'
lng:
$ref: '#/components/schemas/longitude'
description: Coordinates
osm_id:
type: string
description: The OSM ID of the entity
osm_type:
type: string
description: N = node, R = relation, W = way
osm_key:
type: string
description: The OSM key of the entity
osm_value:
type: string
description: The OSM value of the entity
name:
type: string
description: The name of the entity. Can be a boundary, POI, address, etc
country:
type: string
description: The country of the address
countrycode:
type: string
description: Code representation of country
city:
type: string
description: The city of the address
state:
type: string
description: The state of the address
street:
type: string
description: The street of the address
housenumber:
type: string
description: The housenumber of the address
postcode:
type: string
description: The postcode of the address
start:
allOf:
- $ref: '#/components/schemas/geocode'
- example:
$ref: 'docExamples/arenaGeocode.json'
end:
allOf:
- $ref: '#/components/schemas/geocode'
- example:
$ref: 'docExamples/portoniBraGeocode.json'
intermediate:
allOf:
- $ref: '#/components/schemas/geocode'
- example:
$ref: 'docExamples/veronaGeocode.json'
bikes:
type: object
properties:
company:
type: string
example: 'Comunicare S.r.l.'
description: The company providing the bike sharing service
gbfs_href:
type: string
description: Website url of the bike sharing service
href:
type: string
example: '/v2/networks/e-motion-trento'
description: resource URI on bike sharing API Website
id:
type: string
example: 'e-motion-trento'
description: bike sharing identifier
location:
type: object
properties:
city:
type: string
example: 'Trento'
description: City where the bike sharing service is available
country:
type: string
example: 'IT'
description: Country where the city is located