forked from czrv-org1/wt-nodejs-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsource.yaml
1188 lines (1168 loc) · 41.9 KB
/
source.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
servers:
- description: Demo deployment
url: 'https://demo-api.windingtree.com'
- description: Localhost
url: 'http://localhost:3000'
info:
description: API for reading inventory from Winding Tree platform
version: 'will-be-set-at-runtime'
title: WT Read API
paths:
/:
get:
summary: API info
responses:
'200':
description: Basic information about this API instance.
content:
application/json:
schema:
type: object
properties:
docs:
type: string
description: Link to the API documentation.
info:
type: string
description: Link to more information about the API.
version:
type: string
description: Deployed API version number.
config:
type: string
description: Which config is the API using. It might be useful to name configs after used ETH networks.
directoryAddresses:
type: object
properties:
airlines:
type: string
description: Ethereum address of used Winding Tree airline directory.
hotels:
type: string
description: Ethereum address of used Winding Tree hotel directory.
ethNetwork:
type: string
description: Name of the ethereum network against which this instance runs.
dataFormatVersions:
description: Version number indicating the data format specification version the server expects from hotels.
type: object
properties:
airlines:
type: string
format: semver
maxLength: 20
hotels:
type: string
format: semver
maxLength: 20
trustClues:
description: Lists all used trust clues and their metadata. Every clue contains name and description field, but it might contiain other fields depending on the clue.
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
/hotels:
get:
summary: Lists hotels
parameters:
- name: limit
in: query
description: maximum number of records to return
required: false
schema:
default: 30
type: integer
format: int32
minimum: 0
maximum: 300
- name: startWith
in: query
description: The `id` of the first record that will be included in the result
required: false
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: fields
in: query
description: >
List of fields to return with the hotel item. Selecting only `id`
field leads to fastest responses as all data are retrieved from
directory only.
required: false
schema:
default:
- id
- name
- location
type: array
items:
type: string
enum:
- address
- amenities
- availability
- bookingUri
- cancellationPolicies
- category
- contacts
- currency
- dataFormatVersion
- orgJsonUri
- defaultCancellationAmount
- defaultLocale
- description
- guarantee
- id
- images
- location
- managerAddress
- name
- notificationsUri
- operator
- ratePlans
- roomTypes
- spokenLanguages
- tags
- timezone
- updatedAt
responses:
'200':
description: >-
List of hotels. The API tries to always fulfil the requested limit,
so in some cases, the `errors` field might be present.
content:
application/json:
schema:
type: object
properties:
items:
type: array
description: List of resolved hotels.
items:
$ref: '#/components/schemas/HotelListItem'
warnings:
type: array
description: List of resolved hotels passing validation with unsupported declared data format version.
items:
$ref: '#/components/schemas/HotelListError'
errors:
type: array
description: >-
List of checked hotels whose requested data cannot be
accessed (i. e. off-chain data cannot be reached) or fail validation.
items:
$ref: '#/components/schemas/HotelListError'
next:
description: >-
Uri to next page of records. When there's no next page,
this is not set.
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/UriType'
'400':
$ref: '#/components/responses/InvalidRequestError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}':
get:
summary: Get hotel by `id`
parameters:
- name: hotelId
required: true
in: path
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: fields
required: false
in: query
schema:
type: array
items:
type: string
default:
- id
- location
- name
- description
- contacts
- address
- currency
- images
- amenities
- updatedAt
enum:
- address
- amenities
- availability
- bookingUri
- cancellationPolicies
- category
- contacts
- currency
- dataFormatVersion
- orgJsonUri
- defaultCancellationAmount
- defaultLocale
- description
- guarantee
- id
- images
- location
- managerAddress
- name
- notificationsUri
- operator
- ratePlans
- roomTypes
- spokenLanguages
- tags
- timezone
- updatedAt
responses:
'200':
description: Hotel object
content:
application/json:
schema:
$ref: '#/components/schemas/HotelDetail'
headers:
X-Data-Validation-Warning:
schema:
type: string
description: Warning in case of a soft validation fail.
'400':
$ref: '#/components/responses/InvalidRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}/meta':
get:
summary: Hotel record meta information - mostly on-chain and off-chain identifiers of places where to reach all of the hotel's data.
parameters:
- name: hotelId
in: path
required: true
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
responses:
'200':
description: Hotel data uris.
content:
application/json:
schema:
$ref: '#/components/schemas/MetaResponse'
'400':
$ref: '#/components/responses/InvalidRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}/roomTypes':
get:
summary: List room types for hotel `id`
parameters:
- name: hotelId
in: path
required: true
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: fields
in: query
required: false
description: Additional fields to return
schema:
type: string
enum:
- ratePlans
- availability
responses:
'200':
description: Room types list
content:
application/json:
schema:
$ref: '#/components/schemas/RoomTypesResponse'
'400':
$ref: '#/components/responses/InvalidRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}/roomTypes/{roomTypeId}':
get:
summary: Get room type `id`
parameters:
- name: hotelId
in: path
required: true
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: roomTypeId
in: path
required: true
description: Id of room type
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
- name: fields
in: query
required: false
description: Additional fields to return
schema:
type: string
enum:
- ratePlans
- availability
responses:
'200':
description: Room type with id = `id`
content:
application/json:
schema:
$ref: '#/components/schemas/RoomTypeResponse'
headers:
X-Data-Validation-Warning:
schema:
type: string
description: Warning in case of a soft validation fail.
'400':
$ref: '#/components/responses/InvalidRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}/roomTypes/{roomTypeId}/ratePlans':
get:
summary: Get rate plans of the room type `id`
parameters:
- name: hotelId
in: path
required: true
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: roomTypeId
in: path
required: true
description: Id of room type
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
responses:
'200':
description: Rate plans for the room type
content:
application/json:
schema:
$ref: '#/components/schemas/RatePlansResponse'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}/roomTypes/{roomTypeId}/availability':
get:
summary: Get availability of the room type `id`. The availability field contains only a single key with room type id.
parameters:
- name: hotelId
in: path
required: true
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: roomTypeId
in: path
required: true
description: Id of room type
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
responses:
'200':
description: Availability for the room type
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityResponse'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}/availability':
get:
parameters:
- name: hotelId
in: path
required: true
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
responses:
'200':
description: Availability data for the hotel
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityResponse'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}/ratePlans':
get:
parameters:
- name: hotelId
in: path
required: true
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
responses:
'200':
description: Rate plans for the hotel
content:
application/json:
schema:
$ref: '#/components/schemas/RatePlansResponse'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/hotels/{hotelId}/ratePlans/{ratePlanId}':
get:
parameters:
- name: hotelId
in: path
required: true
description: Hotel Id as returned by `GET /hotel`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: ratePlanId
in: path
required: true
description: Id of rate plan
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
responses:
'200':
description: Rate plan details
content:
application/json:
schema:
$ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/RatePlan'
headers:
X-Data-Validation-Warning:
schema:
type: string
description: Warning in case of a soft validation fail.
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
/airlines:
get:
summary: Lists airlines
parameters:
- name: limit
in: query
description: maximum number of records to return
required: false
schema:
default: 30
type: integer
format: int32
minimum: 0
maximum: 300
- name: startWith
in: query
description: The `id` of the first record that will be included in the result
required: false
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: fields
in: query
description: >
List of fields to return with the airline item. Selecting only `id`
field leads to fastest responses as all data are retrieved from
directory only.
required: false
schema:
default:
- id
- name
- code
type: array
items:
type: string
enum:
- bookingUri
- cancellationPolicies
- code
- contacts
- currency
- dataFormatVersion
- orgJsonUri
- defaultCancellationAmount
- description
- flights
- flights.items.flightInstances
- id
- managerAddress
- name
- notificationsUri
- operator
- updatedAt
responses:
'200':
description: >-
List of airlines. The API tries to always fulfil the requested limit,
so in some cases, the `errors` field might be present.
content:
application/json:
schema:
type: object
properties:
items:
type: array
description: List of resolved airlines.
items:
$ref: '#/components/schemas/AirlineListItem'
warnings:
type: array
description: List of resolved airlines passing validation with unsupported declared data format version.
items:
$ref: '#/components/schemas/AirlineListError'
errors:
type: array
description: >-
List of checked airlines whose requested data cannot be
accessed (i. e. off-chain data cannot be reached) or fail validation.
items:
$ref: '#/components/schemas/AirlineListError'
next:
description: >-
Uri to next page of records. When there's no next page,
this is not set.
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/UriType'
'400':
$ref: '#/components/responses/InvalidRequestError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/airlines/{airlineId}':
get:
summary: Get airline by `id`
parameters:
- name: airlineId
required: true
in: path
description: Airline id as returned by `GET /airline`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: fields
required: false
in: query
schema:
type: array
items:
type: string
default:
- id
- name
- description
- contacts
- currency
- updatedAt
enum:
- bookingUri
- cancellationPolicies
- code
- contacts
- currency
- dataFormatVersion
- orgJsonUri
- defaultCancellationAmount
- description
- flights
- flights.items.flightInstances
- id
- managerAddress
- name
- notificationsUri
- operator
- updatedAt
responses:
'200':
description: Airline object
content:
application/json:
schema:
$ref: '#/components/schemas/AirlineDetail'
headers:
X-Data-Validation-Warning:
schema:
type: string
description: Warning in case of a soft validation fail.
'400':
$ref: '#/components/responses/InvalidRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/airlines/{airlineId}/flights':
get:
summary: Get flights list by airline id
parameters:
- name: airlineId
in: path
required: true
description: Airline Id as returned by `GET /airline`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: fields
in: query
required: false
description: Additional fields to return (id, origin, destination and segments are always returned).
schema:
type: string
default: []
enum:
- flightInstances
responses:
'200':
description: Flight data
content:
application/json:
schema:
allOf:
- $ref: '@windingtree/wt-airline-schemas/swagger.yaml#/components/schemas/Flights'
- type: object
properties:
warnings:
type: array
description: Array of Flights
items:
$ref: '#/components/schemas/AirlineListError'
errors:
type: array
description: Array of Flights
items:
$ref: '#/components/schemas/AirlineListError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/airlines/{airlineId}/flights/{flightId}':
get:
summary: Get flight by `id`
parameters:
- name: airlineId
in: path
required: true
description: Airline Id as returned by `GET /airline`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: flightId
in: path
required: true
description: Flight Id as returned by `GET /airline` or `GET /airline/:id/flights`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
- name: fields
in: query
required: false
description: Additional fields to return (id, origin, destination and segments are always returned).
schema:
type: string
default: []
enum:
- flightInstances
responses:
'200':
description: Flight data
content:
application/json:
schema:
$ref: '@windingtree/wt-airline-schemas/swagger.yaml#/components/schemas/Flight'
headers:
X-Data-Validation-Warning:
schema:
type: string
description: Warning in case of a soft validation fail.
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/airlines/{airlineId}/flights/{flightId}/meta':
get:
summary: Get flight meta data
parameters:
- name: airlineId
in: path
required: true
description: Airline Id as returned by `GET /airline`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: flightId
in: path
required: true
description: Flight Id as returned by `GET /airline` or `GET /airline/:id/flights`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
responses:
'200':
description: Flight instances
content:
application/json:
schema:
type: object
required:
- flightInstancesUri
properties:
flightInstancesUri:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/UriType'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/airlines/{airlineId}/flights/{flightId}/instances':
get:
summary: Get flight instances list by flight id
parameters:
- name: airlineId
in: path
required: true
description: Airline Id as returned by `GET /airline`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: flightId
in: path
required: true
description: Flight Id as returned by `GET /airline` or `GET /airline/:id/flights`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
responses:
'200':
description: Flight instances
content:
application/json:
schema:
type: object
properties:
items:
$ref: '@windingtree/wt-airline-schemas/swagger.yaml#/components/schemas/FlightInstances'
warnings:
type: array
description: Array of Flights
items:
$ref: '#/components/schemas/AirlineListError'
errors:
type: array
description: Array of Flights
items:
$ref: '#/components/schemas/AirlineListError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
'/airlines/{airlineId}/flights/{flightId}/instances/{flightInstanceId}':
get:
summary: Get flight instance detail
parameters:
- name: airlineId
in: path
required: true
description: Airline Id as returned by `GET /airline`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
- name: flightId
in: path
required: true
description: Flight Id as returned by `GET /airline` or `GET /airline/:id/flights`
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
- name: flightInstanceId
in: path
required: true
description: Id of flight instance
schema:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/ObjectIdType'
responses:
'200':
description: Flight instance details
content:
application/json:
schema:
allOf:
- $ref: '@windingtree/wt-airline-schemas/swagger.yaml#/components/schemas/FlightInstance'
- type: object
properties:
dataFormatVersion:
description: Version number indicating the data format specification version.
type: string
format: semver
maxLength: 20
headers:
X-Data-Validation-Warning:
schema:
type: string
description: Warning in case of a soft validation fail.
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
'502':
$ref: '#/components/responses/HttpBadGatewayError'
components:
responses:
InvalidRequestError:
description: The server does not understand to the request (HTTP code 400)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFoundError:
description: The object was not found (HTTP code 404)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
UnprocessableEntityError:
description: The object was not found (HTTP code 422)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalServerError:
description: Internal server error (HTTP code 500)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
HttpBadGatewayError:
description: Internal server error (HTTP code 502)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
ValidationError:
description: Upstream data validation error (HTTP code 422)
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
data:
description: 'Upstream data that failed validation against api spec or is invalid dataFormatVersion.'
type: object
schemas:
HotelListError:
type: object
required:
- error
properties:
error:
description: Human readable error from the API
type: string
originalError:
description: Text of the original exception that caused this error
type: string
data:
type: object
description: >-
Additional data to this error, typically contains `id` that
identifies the erroring record.
HotelListItem:
allOf:
- $ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/HotelDescriptionBase'
- $ref: '#/components/schemas/ReducedHotelDataIndex'
- type: object
required:
- id
properties:
id:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
managerAddress:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
ratePlans:
$ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/RatePlans'
availability:
$ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/Availability'
roomTypes:
$ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/RoomTypes'
HotelDetail:
allOf:
- $ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/HotelDescription'
- $ref: '#/components/schemas/ReducedHotelDataIndex'
- type: object
required:
- id
properties:
id:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
managerAddress:
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/EthereumAddressType'
ratePlans:
$ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/RatePlans'
availability:
$ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/Availability'
roomTypes:
$ref: '@windingtree/wt-hotel-schemas/swagger.yaml#/components/schemas/RoomTypes'
ReducedHotelDataIndex:
title: Hotel data index fields that can be resolved in read api
type: object
properties:
orgJsonUri:
description: URI of the Hotel ORG.JSON (pointing off-chain)
$ref: '@windingtree/wt-shared-schemas/swagger.yaml#/components/schemas/UriType'
dataFormatVersion:
description: Version number indicating the data format specification version.
type: string