@voyant-travel/openapi 0.2.5 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +8 -5
- package/spec/admin/accommodations.json +1395 -0
- package/spec/admin/action-ledger.json +6202 -0
- package/spec/admin/booking-requirements.json +5689 -0
- package/spec/admin/bookings.json +18794 -0
- package/spec/admin/catalog.json +690 -0
- package/spec/admin/distribution.json +19581 -0
- package/spec/admin/external-refs.json +1382 -0
- package/spec/admin/extras.json +4648 -0
- package/spec/admin/finance.json +35506 -0
- package/spec/admin/identity.json +4072 -0
- package/spec/admin/legal.json +14339 -0
- package/spec/admin/markets.json +5286 -0
- package/spec/admin/notifications.json +8409 -0
- package/spec/admin/operations.json +39806 -0
- package/spec/admin/operator-settings.json +1389 -0
- package/spec/admin/pricing.json +10640 -0
- package/spec/admin/products.json +22131 -0
- package/spec/admin/promotions.json +2730 -0
- package/spec/admin/quotes.json +7033 -0
- package/spec/admin/relationships.json +13911 -0
- package/spec/admin/sellability.json +4840 -0
- package/spec/admin/storefront.json +1953 -0
- package/spec/admin/suppliers.json +5850 -0
- package/spec/admin/trips.json +9357 -0
- package/spec/framework-admin.json +2552 -276
- package/spec/framework-openapi.json +2785 -708
- package/spec/framework-storefront.json +252 -451
- package/spec/storefront/booking-requirements.json +367 -0
- package/spec/storefront/bookings.json +6137 -0
- package/spec/storefront/catalog.json +690 -0
- package/spec/storefront/customer-portal.json +6038 -0
- package/spec/storefront/finance.json +4824 -0
- package/spec/storefront/legal.json +2082 -0
- package/spec/storefront/markets.json +256 -0
- package/spec/storefront/operator-settings.json +309 -0
- package/spec/storefront/pricing.json +585 -0
- package/spec/storefront/products.json +2910 -0
- package/spec/storefront/storefront-verification.json +909 -0
- package/spec/storefront/storefront.json +4067 -0
- package/spec/storefront/trips.json +9357 -0
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.1.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Voyant Framework API",
|
|
5
|
+
"version": "0.0.0",
|
|
6
|
+
"description": "Generated from the Voyant framework's standard module composition. Do not edit by hand."
|
|
7
|
+
},
|
|
8
|
+
"components": {
|
|
9
|
+
"schemas": {
|
|
10
|
+
"CatalogSearchFilter": {
|
|
11
|
+
"anyOf": [
|
|
12
|
+
{
|
|
13
|
+
"type": "object",
|
|
14
|
+
"properties": {
|
|
15
|
+
"kind": {
|
|
16
|
+
"type": "string",
|
|
17
|
+
"enum": [
|
|
18
|
+
"eq"
|
|
19
|
+
]
|
|
20
|
+
},
|
|
21
|
+
"field": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"minLength": 1
|
|
24
|
+
},
|
|
25
|
+
"value": {
|
|
26
|
+
"anyOf": [
|
|
27
|
+
{
|
|
28
|
+
"type": "string"
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"type": "number"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"type": "boolean"
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
}
|
|
38
|
+
},
|
|
39
|
+
"required": [
|
|
40
|
+
"kind",
|
|
41
|
+
"field",
|
|
42
|
+
"value"
|
|
43
|
+
]
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"type": "object",
|
|
47
|
+
"properties": {
|
|
48
|
+
"kind": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"enum": [
|
|
51
|
+
"in"
|
|
52
|
+
]
|
|
53
|
+
},
|
|
54
|
+
"field": {
|
|
55
|
+
"type": "string",
|
|
56
|
+
"minLength": 1
|
|
57
|
+
},
|
|
58
|
+
"values": {
|
|
59
|
+
"type": "array",
|
|
60
|
+
"items": {
|
|
61
|
+
"anyOf": [
|
|
62
|
+
{
|
|
63
|
+
"type": "string"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"type": "number"
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"required": [
|
|
73
|
+
"kind",
|
|
74
|
+
"field",
|
|
75
|
+
"values"
|
|
76
|
+
]
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"type": "object",
|
|
80
|
+
"properties": {
|
|
81
|
+
"kind": {
|
|
82
|
+
"type": "string",
|
|
83
|
+
"enum": [
|
|
84
|
+
"range"
|
|
85
|
+
]
|
|
86
|
+
},
|
|
87
|
+
"field": {
|
|
88
|
+
"type": "string",
|
|
89
|
+
"minLength": 1
|
|
90
|
+
},
|
|
91
|
+
"gte": {
|
|
92
|
+
"type": "number"
|
|
93
|
+
},
|
|
94
|
+
"lte": {
|
|
95
|
+
"type": "number"
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
"required": [
|
|
99
|
+
"kind",
|
|
100
|
+
"field"
|
|
101
|
+
]
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"type": "object",
|
|
105
|
+
"properties": {
|
|
106
|
+
"kind": {
|
|
107
|
+
"type": "string",
|
|
108
|
+
"enum": [
|
|
109
|
+
"and"
|
|
110
|
+
]
|
|
111
|
+
},
|
|
112
|
+
"clauses": {
|
|
113
|
+
"type": "array",
|
|
114
|
+
"items": {
|
|
115
|
+
"$ref": "#/components/schemas/CatalogSearchFilter"
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
"required": [
|
|
120
|
+
"kind",
|
|
121
|
+
"clauses"
|
|
122
|
+
]
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"type": "object",
|
|
126
|
+
"properties": {
|
|
127
|
+
"kind": {
|
|
128
|
+
"type": "string",
|
|
129
|
+
"enum": [
|
|
130
|
+
"or"
|
|
131
|
+
]
|
|
132
|
+
},
|
|
133
|
+
"clauses": {
|
|
134
|
+
"type": "array",
|
|
135
|
+
"items": {
|
|
136
|
+
"$ref": "#/components/schemas/CatalogSearchFilter"
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
"required": [
|
|
141
|
+
"kind",
|
|
142
|
+
"clauses"
|
|
143
|
+
]
|
|
144
|
+
}
|
|
145
|
+
]
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"parameters": {}
|
|
149
|
+
},
|
|
150
|
+
"paths": {
|
|
151
|
+
"/v1/public/markets": {
|
|
152
|
+
"get": {
|
|
153
|
+
"responses": {
|
|
154
|
+
"200": {
|
|
155
|
+
"description": "The supported markets, locales, and currencies for anonymous discovery",
|
|
156
|
+
"content": {
|
|
157
|
+
"application/json": {
|
|
158
|
+
"schema": {
|
|
159
|
+
"type": "object",
|
|
160
|
+
"properties": {
|
|
161
|
+
"data": {
|
|
162
|
+
"type": "array",
|
|
163
|
+
"items": {
|
|
164
|
+
"type": "object",
|
|
165
|
+
"properties": {
|
|
166
|
+
"id": {
|
|
167
|
+
"type": "string"
|
|
168
|
+
},
|
|
169
|
+
"code": {
|
|
170
|
+
"type": "string"
|
|
171
|
+
},
|
|
172
|
+
"name": {
|
|
173
|
+
"type": "string"
|
|
174
|
+
},
|
|
175
|
+
"regionCode": {
|
|
176
|
+
"type": [
|
|
177
|
+
"string",
|
|
178
|
+
"null"
|
|
179
|
+
]
|
|
180
|
+
},
|
|
181
|
+
"countryCode": {
|
|
182
|
+
"type": [
|
|
183
|
+
"string",
|
|
184
|
+
"null"
|
|
185
|
+
]
|
|
186
|
+
},
|
|
187
|
+
"defaultLocale": {
|
|
188
|
+
"type": "string"
|
|
189
|
+
},
|
|
190
|
+
"defaultCurrency": {
|
|
191
|
+
"type": "string"
|
|
192
|
+
},
|
|
193
|
+
"locales": {
|
|
194
|
+
"type": "array",
|
|
195
|
+
"items": {
|
|
196
|
+
"type": "object",
|
|
197
|
+
"properties": {
|
|
198
|
+
"languageTag": {
|
|
199
|
+
"type": "string"
|
|
200
|
+
},
|
|
201
|
+
"isDefault": {
|
|
202
|
+
"type": "boolean"
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
"required": [
|
|
206
|
+
"languageTag",
|
|
207
|
+
"isDefault"
|
|
208
|
+
]
|
|
209
|
+
}
|
|
210
|
+
},
|
|
211
|
+
"currencies": {
|
|
212
|
+
"type": "array",
|
|
213
|
+
"items": {
|
|
214
|
+
"type": "object",
|
|
215
|
+
"properties": {
|
|
216
|
+
"currencyCode": {
|
|
217
|
+
"type": "string"
|
|
218
|
+
},
|
|
219
|
+
"isDefault": {
|
|
220
|
+
"type": "boolean"
|
|
221
|
+
}
|
|
222
|
+
},
|
|
223
|
+
"required": [
|
|
224
|
+
"currencyCode",
|
|
225
|
+
"isDefault"
|
|
226
|
+
]
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
},
|
|
230
|
+
"required": [
|
|
231
|
+
"id",
|
|
232
|
+
"code",
|
|
233
|
+
"name",
|
|
234
|
+
"regionCode",
|
|
235
|
+
"countryCode",
|
|
236
|
+
"defaultLocale",
|
|
237
|
+
"defaultCurrency",
|
|
238
|
+
"locales",
|
|
239
|
+
"currencies"
|
|
240
|
+
]
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
},
|
|
244
|
+
"required": [
|
|
245
|
+
"data"
|
|
246
|
+
]
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
},
|
|
255
|
+
"webhooks": {}
|
|
256
|
+
}
|
|
@@ -0,0 +1,309 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.1.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Voyant Framework API",
|
|
5
|
+
"version": "0.0.0",
|
|
6
|
+
"description": "Generated from the Voyant framework's standard module composition. Do not edit by hand."
|
|
7
|
+
},
|
|
8
|
+
"components": {
|
|
9
|
+
"schemas": {
|
|
10
|
+
"CatalogSearchFilter": {
|
|
11
|
+
"anyOf": [
|
|
12
|
+
{
|
|
13
|
+
"type": "object",
|
|
14
|
+
"properties": {
|
|
15
|
+
"kind": {
|
|
16
|
+
"type": "string",
|
|
17
|
+
"enum": [
|
|
18
|
+
"eq"
|
|
19
|
+
]
|
|
20
|
+
},
|
|
21
|
+
"field": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"minLength": 1
|
|
24
|
+
},
|
|
25
|
+
"value": {
|
|
26
|
+
"anyOf": [
|
|
27
|
+
{
|
|
28
|
+
"type": "string"
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"type": "number"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"type": "boolean"
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
}
|
|
38
|
+
},
|
|
39
|
+
"required": [
|
|
40
|
+
"kind",
|
|
41
|
+
"field",
|
|
42
|
+
"value"
|
|
43
|
+
]
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"type": "object",
|
|
47
|
+
"properties": {
|
|
48
|
+
"kind": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"enum": [
|
|
51
|
+
"in"
|
|
52
|
+
]
|
|
53
|
+
},
|
|
54
|
+
"field": {
|
|
55
|
+
"type": "string",
|
|
56
|
+
"minLength": 1
|
|
57
|
+
},
|
|
58
|
+
"values": {
|
|
59
|
+
"type": "array",
|
|
60
|
+
"items": {
|
|
61
|
+
"anyOf": [
|
|
62
|
+
{
|
|
63
|
+
"type": "string"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"type": "number"
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"required": [
|
|
73
|
+
"kind",
|
|
74
|
+
"field",
|
|
75
|
+
"values"
|
|
76
|
+
]
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"type": "object",
|
|
80
|
+
"properties": {
|
|
81
|
+
"kind": {
|
|
82
|
+
"type": "string",
|
|
83
|
+
"enum": [
|
|
84
|
+
"range"
|
|
85
|
+
]
|
|
86
|
+
},
|
|
87
|
+
"field": {
|
|
88
|
+
"type": "string",
|
|
89
|
+
"minLength": 1
|
|
90
|
+
},
|
|
91
|
+
"gte": {
|
|
92
|
+
"type": "number"
|
|
93
|
+
},
|
|
94
|
+
"lte": {
|
|
95
|
+
"type": "number"
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
"required": [
|
|
99
|
+
"kind",
|
|
100
|
+
"field"
|
|
101
|
+
]
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"type": "object",
|
|
105
|
+
"properties": {
|
|
106
|
+
"kind": {
|
|
107
|
+
"type": "string",
|
|
108
|
+
"enum": [
|
|
109
|
+
"and"
|
|
110
|
+
]
|
|
111
|
+
},
|
|
112
|
+
"clauses": {
|
|
113
|
+
"type": "array",
|
|
114
|
+
"items": {
|
|
115
|
+
"$ref": "#/components/schemas/CatalogSearchFilter"
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
"required": [
|
|
120
|
+
"kind",
|
|
121
|
+
"clauses"
|
|
122
|
+
]
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"type": "object",
|
|
126
|
+
"properties": {
|
|
127
|
+
"kind": {
|
|
128
|
+
"type": "string",
|
|
129
|
+
"enum": [
|
|
130
|
+
"or"
|
|
131
|
+
]
|
|
132
|
+
},
|
|
133
|
+
"clauses": {
|
|
134
|
+
"type": "array",
|
|
135
|
+
"items": {
|
|
136
|
+
"$ref": "#/components/schemas/CatalogSearchFilter"
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
"required": [
|
|
141
|
+
"kind",
|
|
142
|
+
"clauses"
|
|
143
|
+
]
|
|
144
|
+
}
|
|
145
|
+
]
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"parameters": {}
|
|
149
|
+
},
|
|
150
|
+
"paths": {
|
|
151
|
+
"/v1/public/operator-profile": {
|
|
152
|
+
"get": {
|
|
153
|
+
"responses": {
|
|
154
|
+
"200": {
|
|
155
|
+
"description": "The public operator profile (null when unset)",
|
|
156
|
+
"content": {
|
|
157
|
+
"application/json": {
|
|
158
|
+
"schema": {
|
|
159
|
+
"type": "object",
|
|
160
|
+
"properties": {
|
|
161
|
+
"data": {
|
|
162
|
+
"type": [
|
|
163
|
+
"object",
|
|
164
|
+
"null"
|
|
165
|
+
],
|
|
166
|
+
"properties": {
|
|
167
|
+
"name": {
|
|
168
|
+
"type": "string"
|
|
169
|
+
},
|
|
170
|
+
"legalName": {
|
|
171
|
+
"type": "string"
|
|
172
|
+
},
|
|
173
|
+
"address": {
|
|
174
|
+
"type": "string"
|
|
175
|
+
},
|
|
176
|
+
"phone": {
|
|
177
|
+
"type": "string"
|
|
178
|
+
},
|
|
179
|
+
"email": {
|
|
180
|
+
"type": "string"
|
|
181
|
+
},
|
|
182
|
+
"website": {
|
|
183
|
+
"type": "string"
|
|
184
|
+
},
|
|
185
|
+
"license": {
|
|
186
|
+
"type": "string"
|
|
187
|
+
},
|
|
188
|
+
"licenseAuthority": {
|
|
189
|
+
"type": "string"
|
|
190
|
+
},
|
|
191
|
+
"customerPaymentPolicy": {},
|
|
192
|
+
"bookingCheckoutUrlTemplate": {
|
|
193
|
+
"type": [
|
|
194
|
+
"string",
|
|
195
|
+
"null"
|
|
196
|
+
]
|
|
197
|
+
},
|
|
198
|
+
"invoicePayUrlTemplate": {
|
|
199
|
+
"type": [
|
|
200
|
+
"string",
|
|
201
|
+
"null"
|
|
202
|
+
]
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
"required": [
|
|
206
|
+
"name",
|
|
207
|
+
"legalName",
|
|
208
|
+
"address",
|
|
209
|
+
"phone",
|
|
210
|
+
"email",
|
|
211
|
+
"website",
|
|
212
|
+
"license",
|
|
213
|
+
"licenseAuthority",
|
|
214
|
+
"bookingCheckoutUrlTemplate",
|
|
215
|
+
"invoicePayUrlTemplate"
|
|
216
|
+
]
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
"required": [
|
|
220
|
+
"data"
|
|
221
|
+
]
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
},
|
|
229
|
+
"/v1/public/settings/operator": {
|
|
230
|
+
"get": {
|
|
231
|
+
"responses": {
|
|
232
|
+
"200": {
|
|
233
|
+
"description": "The public operator settings (null when unset)",
|
|
234
|
+
"content": {
|
|
235
|
+
"application/json": {
|
|
236
|
+
"schema": {
|
|
237
|
+
"type": "object",
|
|
238
|
+
"properties": {
|
|
239
|
+
"data": {
|
|
240
|
+
"type": [
|
|
241
|
+
"object",
|
|
242
|
+
"null"
|
|
243
|
+
],
|
|
244
|
+
"properties": {
|
|
245
|
+
"name": {
|
|
246
|
+
"type": "string"
|
|
247
|
+
},
|
|
248
|
+
"legalName": {
|
|
249
|
+
"type": "string"
|
|
250
|
+
},
|
|
251
|
+
"address": {
|
|
252
|
+
"type": "string"
|
|
253
|
+
},
|
|
254
|
+
"phone": {
|
|
255
|
+
"type": "string"
|
|
256
|
+
},
|
|
257
|
+
"email": {
|
|
258
|
+
"type": "string"
|
|
259
|
+
},
|
|
260
|
+
"website": {
|
|
261
|
+
"type": "string"
|
|
262
|
+
},
|
|
263
|
+
"license": {
|
|
264
|
+
"type": "string"
|
|
265
|
+
},
|
|
266
|
+
"licenseAuthority": {
|
|
267
|
+
"type": "string"
|
|
268
|
+
},
|
|
269
|
+
"customerPaymentPolicy": {},
|
|
270
|
+
"bookingCheckoutUrlTemplate": {
|
|
271
|
+
"type": [
|
|
272
|
+
"string",
|
|
273
|
+
"null"
|
|
274
|
+
]
|
|
275
|
+
},
|
|
276
|
+
"invoicePayUrlTemplate": {
|
|
277
|
+
"type": [
|
|
278
|
+
"string",
|
|
279
|
+
"null"
|
|
280
|
+
]
|
|
281
|
+
}
|
|
282
|
+
},
|
|
283
|
+
"required": [
|
|
284
|
+
"name",
|
|
285
|
+
"legalName",
|
|
286
|
+
"address",
|
|
287
|
+
"phone",
|
|
288
|
+
"email",
|
|
289
|
+
"website",
|
|
290
|
+
"license",
|
|
291
|
+
"licenseAuthority",
|
|
292
|
+
"bookingCheckoutUrlTemplate",
|
|
293
|
+
"invoicePayUrlTemplate"
|
|
294
|
+
]
|
|
295
|
+
}
|
|
296
|
+
},
|
|
297
|
+
"required": [
|
|
298
|
+
"data"
|
|
299
|
+
]
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
}
|
|
307
|
+
},
|
|
308
|
+
"webhooks": {}
|
|
309
|
+
}
|