-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathaiplugin-owljourney.owlting.com.yaml
216 lines (212 loc) · 6.5 KB
/
aiplugin-owljourney.owlting.com.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
openapi: 3.0.1
info:
title: OwlJourney Travel API
description: API for hotel recommendations, including but not limited to including lodging and activities.
version: v1
servers:
- url: https://aiplugin-owljourney.owlting.com
paths:
/lodgingProducts:
post:
operationId: lodgingProducts
summary: Get recommended lodging travel products
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LodgingProductsRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/LodgingProductsResponse'
components:
schemas:
LodgingProductsRequest:
type: object
properties:
summary:
type: string
description: Brief search keyword of the question asked by the user for search.
required: true
destination:
type: string
description: The destination can be a city, address, airport, or a landmark.
required: true
checkin:
type: string
format: date
description: Checkin date in YYYY-MM-DD format. If you are unsure of the date, the default is 30 days from the current date. Specify that this field cannot be null.
nullable: false
checkout:
type: string
format: date
description: Checkout date in YYYY-MM-DD format. If you are unsure of the date, the default is 31 days from the current date. Specify that this field cannot be null.
nullable: false
number_of_adults:
type: integer
description: Total number of adult travelers for accommodations. Specify that this field cannot be null.
nullable: false
minimum: 1
number_of_children:
type: integer
description: Total number of child travelers for accommodations. Specify that this field cannot be null.
nullable: false
minimum: 0
min_rooms:
type: integer
description: Minimum number of rooms. Specify that this field cannot be null.
nullable: false
minimum: 1
language:
type: string
description: User's the question language. ex Chinese (Traditional). Specify that this field cannot be null.
nullable: false
maxPrice:
type: number
format: float
minimum: 0
description: The maximum price for accommodations. Specify that this field cannot be null.
nullable: false
currency:
type: string
enum:
- twd
- usd
- jpy
- eur
- thb
- cny
description: The currency code for the price. Specify that this field cannot be null.
nullable: false
amenities:
type: array
items:
type: string
description: An array of desired amenities. Specify that this field cannot be null.
nullable: false
star_ratings:
type: array
items:
type: integer
minimum: 1
maximum: 5
description: An array of desired star ratings. Specify that this field cannot be null.
nullable: false
guest_rating:
type: string
enum:
- WONDERFUL
- VERY_GOOD
- GOOD
description: Desired guest rating. Specify that this field cannot be null.
nullable: false
sort_type:
type: string
enum:
- CHEAPEST
- DISTANCE
- MOST_EXPENSIVE
description: Sort order for the results. Specify that this field cannot be null.
nullable: false
property_type:
type: string
enum:
- Hotel
- Apartment
- Hostel
- Motel
- Resort
- Bed and breakfast
- Ryokan
- Farm stay
- Resort village
- Villa
- Campground
- Boat
- Guesthouse
- Inn
- Condo hotel
- Vacation home
- Lodge
- Homestay
- Country House
- Luxury Tent
- Capsule Hotel
- Love Hotel
- Riad
- Chalet
- Condo
- Cottage
- Economy hotel
- Gite
- Health resort
- Others
- Business hotel
- Quarantine
description: Desired property type. Specify that this field cannot be null.
nullable: false
required:
- summary
- destination
LodgingProductsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Hotel'
status:
type: integer
description: The status code of the response.
target_language:
type: string
description: The language of the response.
Hotel:
type: object
properties:
hotel_uuid:
type: string
description: The unique identifier of the hotel.
hotel_name:
type: string
description: The name of the hotel.
currency:
type: string
description: The currency code for the price.
places_text:
type: string
description: The location text of the hotel.
hotel_type:
type: string
description: The type of the hotel.
distance:
type: number
format: float
description: The distance to the hotel in kilometers.
price:
type: integer
description: The price of the hotel.
description:
type: string
description: The description of the hotel.
country_text:
type: string
description: The country where the hotel is located.
city_text:
type: string
description: The city where the hotel is located.
address:
type: string
description: The address of the hotel.
url:
type: string
format: uri
description: The URL for booking the hotel.
imageUrl:
type: string
format: uri
description: The URL of the hotel's image.