-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTripianAPIV3-0-2-a-1.YAML
3017 lines (3014 loc) · 82.9 KB
/
TripianAPIV3-0-2-a-1.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: Tripian Recommendation Engine
description: "Tripian Recommendation Engine API Documentation Welcome to Tripian. Our API allows you to generate personalized recommendations of places of interest and daily itineraries based on user preferences and trip details. From top attractions to trendy restaurants, hidden local gems to cool finds, explore over 1M POIs in 200 cities world-wide.\nBase URLs:\n \nEmail: <a href=\"mailto:api@tripian.com\" target=\"_blank\">Support</a> Web: <a href=\"https://www.tripian.com\" target=\"_blank\">Support</a><br><br>\n<b>Requirements</b><br><br> <b>API Requests:</b><br> Authenticate your account by including your private key in API requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.<br><br>\n<b>Creating A New Trip:</b><br> 1.First, you need to register a user (customer).<br> 2.Login as a user and obtain an access token to be able to create a trip on behalf of the user.<br><br>\n<b>Standart request and response structure</b><br><br>\n<b>Successful response:</b><br> `{\"status\": 200,\"success\": true,\"message\": \"Success\",\"data\": {returned objects}}`<br><br>\n<b>Error:</b><br> `{\"status\": \"Error code\",\"success\": false,\"message\": {error messages}}`<br><br>\n<b>Call with pagination:</b><br> `{\"status\": 200,\"success\": true,\"message\": \"Success\",\"data\": {returned objects},\"pagination\": {\"count\":{returned record count},\"total\": {total record number},\"per_age\": {record count per page},\"current_page\": {active page number},\"total_page\": {total page number},\"links\": {\"previous\": {previous page url},\"next\": {next page url}}}}`<br><br>\n<b>Other Useful Tips</b><br> - If a call supports pagination, you can send page and limit parameters<br> - <b>\"limit\"</b> parameter states no of record to display<br> - <b>\"page\"</b> parameter states which page to display"
version: 3.0.2-a.1
contact:
name: TRIPIAN INC.
url: 'https://www.tripian.com'
email: info@tripian.com
servers:
- url: 'https://fgzpwfdoy1.execute-api.eu-west-1.amazonaws.com/api'
description: Tripian API v3.0.2-a.1
tags:
- name: City List
description: City informations
- name: Places of Intereset
description: POI categories and POI informations
- name: User Profile
description: User Profile Services
- name: Trip Planner
description: Trip planner process
- name: Quick Recommendations
description: Recommendations
- name: Tripian Internal
description: Namespaces For internal Use
paths:
/city:
get:
tags:
- City List
summary: Available Cities
description: Obtain the list of all available cities and city_ids.
operationId: get-cities
parameters:
- name: search
in: query
description: Search term for in city name
required: false
schema:
type: string
example: tor
- name: countrycode
in: query
description: Country's code to look cities for
required: false
schema:
type: string
example: ca
- name: limit
in: query
description: 'Record limit (Default: 20)'
required: false
schema:
type: integer
example: 20
minimum: 1
maximum: 300
- name: page
in: query
description: Page of displayed records
required: false
schema:
type: integer
example: 1
minimum: 1
maximum: 5000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CitiesResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'/city/{id}':
get:
tags:
- City List
summary: City Info
description: 'Obtain information (such as ) on a specific city. Returned results include city_id, featured image, coordinates, country and continent.'
operationId: get-city
parameters:
- name: id
in: path
description: City id
required: true
schema:
type: integer
example: 1
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CityResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
/poi-category:
get:
tags:
- Places of Intereset
summary: POI Categories
description: |-
Obtain the list of all categories, such as attractions, restaurants, cafes, bars, religious places, cool finds, shopping centers, museums, bakeries and art galleries. Returned results include category ids.<br><br>
*This call supports "pagination
operationId: get-poi-categories
parameters: []
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/POICategoriesResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
/poi:
get:
tags:
- Places of Intereset
summary: All POI
description: |-
Obtain the list of all POIs in our database. Returned results include, POI id, city id, category id, name, address, coordinates, phone number, website, opening/closing times, tags, icon, description (if available), price range and images.<br><br>
Use city id to obtain POIs of a specific city.<br> Use coordinates to obtain nearby POIs (use category or distance parameters to filter)
operationId: get-pois
parameters:
- name: city_id
in: query
description: City id is required if you are not using the coordinate parameter
schema:
type: integer
example: 1
- name: coordinate
in: query
description: 'Coordinate is required if you are not using the city_id parameter (Format: latitude,longitude)'
required: false
schema:
type: string
example: '43.653226,-79.38318429999998'
- name: search
in: query
description: 'Search terms for in poi names or tags (for example "restaurant", "museum", "bar" etc.)'
required: false
schema:
type: string
example: cafe
- name: poi_ids
in: query
description: 'Requested POI ids seperated by , Example: 123,7748,345'
required: false
explode: true
schema:
type: string
example: '1,2,3'
- name: must_try_ids
in: query
description: 'Requested Must Try ids separated by commas, e.g: 123,456,789'
required: false
explode: true
schema:
type: string
example: '123,456,789'
- name: poi_categories
in: query
description: Poi categories
required: false
explode: true
schema:
type: string
example: '1,2'
- name: distance
in: query
description: 'Distance parameter value is in <strong>km</strong>. This parameter cannot be used without the coordinate parameter. Default value: 50(km)'
required: false
schema:
type: number
example: 10.5
- name: limit
in: query
description: 'Record limit (Default: 20)'
required: false
schema:
type: integer
example: 20
minimum: 1
maximum: 100
- name: page
in: query
description: Page of displayed records
required: false
schema:
type: integer
example: 1
- schema:
type: string
in: query
name: bounds
description: 'Search boundaries (lat_max,lat_min,lng_max,lng_min)'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/POIsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'/poi/{id}':
get:
tags:
- Places of Intereset
summary: POI Info
description: 'Obtain information on a specific POI by using POI id. Returned results include, POI id, city id, category id, name, address, coordinates, phone number, website, opening/closing times, tags, icon, description (if available), price range and images.'
operationId: get-poi
parameters:
- name: id
in: path
description: Place id
required: true
schema:
type: integer
example: 1
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/POIResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
/top-ten:
get:
tags:
- Places of Intereset
summary: Top 10 places of interest
description: 'Get top 10 places of interest in one particular city based on category'
operationId: get-top-ten
parameters:
- name: city_id
in: query
description: City id is required to see what is the top 10 places in the city.
required: true
schema:
type: integer
example: 1
- name: poi_categories
in: query
description: 'Poi category ids to see the top 10 places in those categories'
required: true
schema:
type: string
example: '1,2,3,4'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TopTenResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
/register:
post:
tags:
- User Profile
summary: Register
description: Create a new user (customer) by posting the required parameters indicated below. No extra step needed to active the new user.
operationId: add-user
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterRequest'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
/login:
post:
tags:
- User Profile
summary: Login
description: 'Obtain the access token for API calls that require user identification. You can login with username. Also, you can login with trip hash. For login with trip hash use the trip_hash attribute in body of the request.'
operationId: user-login
parameters: []
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/LoginRequestEmail'
- $ref: '#/components/schemas/LoginRequestTripHash'
- $ref: '#/components/schemas/LoginRequestUsername'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LoginResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
/refresh:
post:
tags:
- User Profile
summary: Refresh Token
description: Obtain the new access token when token is expired
operationId: token-refresh
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshRequest'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
/user:
get:
tags:
- User Profile
summary: User Info
description: 'Obtain personal user information (must be logged in with access token), such as username and preferences.'
operationId: get-user
parameters: []
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
put:
tags:
- User Profile
summary: Update User Info
description: 'Update user information (must be logged in with access token), such as personal preferences.'
operationId: update-user
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateRequest'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
/user-trip:
get:
tags:
- User Profile
summary: User Trips
description: 'Obtain list of user’s past and upcoming trips (must be logged in with access token). Returned result include, trip id, hash (secure version of trip id), city, arrival/departure details, trip creating time and pagination.'
operationId: get-user-trips
parameters:
- name: from
in: query
description: 'Trip filter start date (Format: yyyy-mm-dd)'
required: false
schema:
type: string
example: '2019-06-28'
- name: to
in: query
description: 'Trip filter end date (Format: yyyy-mm-dd)'
required: false
schema:
type: string
example: '2019-06-30'
- name: limit
in: query
description: 'Record limit (default: 20)'
required: false
schema:
type: integer
example: 20
- name: page
in: query
description: Page of displayed records
required: false
schema:
type: integer
example: 1
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TripsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'/user-trip/{trip_hash}':
get:
tags:
- User Profile
summary: Trip Profile
description: 'Get users trip profile with trip_hash'
operationId: get-trip-profile
parameters:
- name: trip_hash
in: path
description: Trip's hash
required: true
schema:
type: string
example: 9c235c40209d69ffceb4661a0e07a813
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TripReferenceSuccessfulResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
/user-favorite:
post:
tags:
- User Profile
summary: Add Favorite POI
description: Add user favorite POI
operationId: add-user-favorite
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FavoriteRequest'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/FavoriteResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
get:
tags:
- User Profile
summary: User Favorite POI
description: Get user all favorite POI list
operationId: get-user-favorites
parameters:
- name: city_id
in: query
description: POI city id
required: false
schema:
type: integer
example: 1
- name: trip_hash
in: query
description: Trip hash string
required: false
schema:
type: string
example: 9c235c40209d69ffceb4661a0e07a813
- name: limit
in: query
description: 'Record limit (Default: 20)'
required: false
schema:
type: integer
example: 20
- name: page
in: query
description: Page of displayed records
required: false
schema:
type: integer
example: 1
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/FavoritesResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'/user-favorite/{id}':
put:
tags:
- User Profile
summary: Update A Favorite
description: 'Update companion information (must be logged in with access token), such as poi_id and trip_hash'
operationId: update-user-favorite
parameters:
- name: id
in: path
description: Favorite id
required: true
schema:
type: integer
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FavoriteUpdateRequest'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/FavoriteResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
delete:
tags:
- User Profile
summary: Delete A Favorite
description: This request deletes a favorite record.
operationId: delete-user-favorite
parameters:
- name: id
in: path
description: Favorite id
required: true
schema:
type: integer
example: 1
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
/user-companion:
get:
tags:
- User Profile
summary: User Companion
description: Get user companion list
operationId: get-user-companions
parameters:
- name: limit
in: query
description: 'Record limit (Default: 20)'
required: false
schema:
type: integer
example: 20
- name: page
in: query
description: Page of displayed records
required: false
schema:
type: integer
example: 1
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CompanionsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
post:
tags:
- User Profile
summary: Add A Companion
description: Add a new companion
operationId: add-user-companions
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanionRequest'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CompanionResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'/user-companion/{id}':
put:
tags:
- User Profile
summary: Update A Companion
description: 'Update companion information (must be logged in with access token), such as name and answers'
operationId: edit-user-companion
parameters:
- name: id
in: path
description: Companion id
required: true
schema:
type: integer
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanionRequest'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CompanionResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
delete:
tags:
- User Profile
summary: Delete A Companion
description: This request deletes a companion record.
operationId: delete-user-companion
parameters:
- name: id
in: path
description: Companion id
required: true
schema:
type: integer
example: 1
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
/question:
get:
tags:
- Trip Planner
summary: Questions
description: Get questions from this namespace.
operationId: get-questions
parameters:
- name: city_id
in: query
description: 'City id, add "," for multiple cities'
required: true
schema:
type: integer
example: 144
- name: category
in: query
description: 'Question category (trip, profile or companion) Default: trip'
required: false
schema:
type: string
example: trip
enum:
- trip
- profile
- companion
- name: language_code
in: query
description: 'Language code (Values: en,fr) Default: en'
required: false
schema:
type: string
example: en
enum:
- en
- fr
- name: limit
in: query
description: 'Record limit (default: 20)'
required: false
schema:
type: integer
example: 20
- name: page
in: query
description: Page of displayed records
required: false
schema:
type: integer
example: 1
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/QuestionsResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
/trip:
post:
tags:
- Trip Planner
summary: Create A Trip
description: Generate a new trip.
operationId: add-trip
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TripProfile'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Trip'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'/trip/{trip_hash}':
get:
tags:
- Trip Planner
summary: Trip Info
description: Get info of a specific trip.
operationId: get-trip
parameters:
- name: trip_hash
in: path
description: Trip hash
required: true
schema:
type: string
example: 9c235c40209d69ffceb4661a0e07a813
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TripResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
put:
tags:
- Trip Planner
summary: Update A Trip
description: Update a trip.
operationId: edit-trip
parameters:
- name: trip_hash
in: path
description: Trip hash
required: true
schema:
type: string
example: 9c235c40209d69ffceb4661a0e07a813
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TripProfile'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TripResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
delete:
tags:
- Trip Planner
summary: Delete A Trip
description: Delete a trip
operationId: delete-trip
parameters:
- name: trip_hash
in: path
description: Trip hash
required: true
schema:
type: string
example: 9c235c40209d69ffceb4661a0e07a813
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
/step:
post:
tags:
- Trip Planner
summary: Add A Step
description: Add a step
operationId: add-step
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StepRequest'
responses:
'200':
description: Successful operation
content: