-
Notifications
You must be signed in to change notification settings - Fork 38
/
Copy pathswagger.json
579 lines (579 loc) · 16.4 KB
/
swagger.json
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
{
"components": {
"schemas": {
"Context": {
"items": {
"type": "string"
},
"type": "array"
},
"Error": {
"properties": {
"message": {
"example": "An error message",
"type": "string"
}
},
"type": "object"
},
"ResultList": {
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"data": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ResultSingleton": {
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"data": {
"type": "object"
}
},
"type": "object"
}
},
"securitySchemes": {
"bearer": {
"bearerFormat": "JWT",
"description": "JWT Authorization header using the Bearer scheme.",
"scheme": "bearer",
"type": "http"
}
}
},
"definitions": {},
"info": {
"description": "A sample API for getting started with Couchbase Server and the SDK.",
"termsOfService": "",
"title": "Travel Sample API",
"version": "1.0"
},
"openapi": "3.0.3",
"paths": {
"/": {
"get": {
"responses": {
"200": {
"content": {
"text/html": {
"example": "<h1> Travel Sample API </h1>"
}
},
"description": "Returns the API index page"
}
},
"summary": "Returns the index page"
}
},
"/api/airports": {
"get": {
"parameters": [
{
"description": "The airport name/code to search for",
"example": "SFO",
"in": "query",
"name": "search",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"context": [
"A description of a N1QL operation"
],
"data": [
{
"airportname": "San Francisco Intl"
}
]
},
"schema": {
"$ref": "#/components/schemas/ResultList"
}
}
},
"description": "Returns airport data and query context information"
}
},
"summary": "Returns list of matching airports and the source query",
"tags": [
"airports"
]
}
},
"/api/flightPaths/{fromloc}/{toloc}": {
"get": {
"parameters": [
{
"description": "Airport name for beginning route",
"example": "San Francisco Intl",
"in": "path",
"name": "fromloc",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Airport name for end route",
"example": "Los Angeles Intl",
"in": "path",
"name": "toloc",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Date of flight departure in `mm/dd/yyyy` format",
"example": "05/24/2021",
"in": "query",
"name": "leave",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"context": [
"N1QL query - scoped to inventory: SELECT faa as fromAirport FROM `travel-sample`.inventory.airport WHERE airportname = $1 UNION SELECT faa as toAirport FROM `travel-sample`.inventory.airport WHERE airportname = $2"
],
"data": [
{
"destinationairport": "LAX",
"equipment": "738",
"flight": "AA331",
"flighttime": 1220,
"name": "American Airlines",
"price": 152.5,
"sourceairport": "SFO",
"utc": "16:37:00"
}
]
},
"schema": {
"$ref": "#/components/schemas/ResultList"
}
}
},
"description": "Returns flight data and query context information"
}
},
"summary": "Return flights information, cost and more for a given flight time and date",
"tags": [
"flightPaths"
]
}
},
"/api/hotels/{description}/{location}/": {
"get": {
"parameters": [
{
"description": "Hotel description keywords",
"example": "pool",
"in": "path",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Hotel location",
"example": "San Francisco",
"in": "path",
"name": "location",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"context": [
"FTS search - scoped to: inventory.hotel within fields address,city,state,country,name,description"
],
"data": [
{
"address": "250 Beach St, San Francisco, California, United States",
"description": "Nice hotel, centrally located (only two blocks from Pier 39). Heated outdoor swimming pool.",
"name": "Radisson Hotel Fisherman's Wharf"
},
{
"address": "121 7th St, San Francisco, California, United States",
"description": "Chain motel with a few more amenities than the typical Best Western; outdoor swimming pool, internet access, cafe on-site, pet friendly.",
"name": "Best Western Americania"
}
]
},
"schema": {
"$ref": "#/components/schemas/ResultList"
}
}
},
"description": "Returns hotel data and query context information"
}
},
"summary": "Find hotels using full text search",
"tags": [
"hotels"
]
}
},
"/api/tenants/{tenant}/user/login": {
"post": {
"parameters": [
{
"description": "Tenant agent name",
"example": "tenant_agent_00",
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"password": {
"example": "password1",
"type": "string"
},
"user": {
"example": "user1",
"type": "string"
}
},
"required": [
"user",
"password"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"context": [
"KV get - scoped to tenant_agent_00.users: for password field in document user1"
],
"data": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoibXNfdXNlciJ9.GPs8two_vPVBpdqD7cz_yJ4X6J9yDTi6g7r9eWyAwEM"
}
},
"schema": {
"$ref": "#/components/schemas/ResultSingleton"
}
}
},
"description": "Returns login data and query context information"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Returns an authentication error"
}
},
"summary": "Login an existing user for a given tenant agent",
"tags": [
"tenants"
]
}
},
"/api/tenants/{tenant}/user/signup": {
"post": {
"parameters": [
{
"description": "Tenant agent name",
"example": "tenant_agent_00",
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"password": {
"example": "password1",
"type": "string"
},
"user": {
"example": "user1",
"type": "string"
}
},
"required": [
"user",
"password"
],
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"context": [
"KV insert - scoped to tenant_agent_00.users: document user1"
],
"data": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoibXNfdXNlciJ9.GPs8two_vPVBpdqD7cz_yJ4X6J9yDTi6g7r9eWyAwEM"
}
},
"schema": {
"$ref": "#/components/schemas/ResultSingleton"
}
}
},
"description": "Returns login data and query context information"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Returns a conflict error"
}
},
"summary": "Signup a new user",
"tags": [
"tenants"
]
}
},
"/api/tenants/{tenant}/user/{username}/flights": {
"get": {
"parameters": [
{
"description": "Tenant agent name",
"example": "tenant_agent_00",
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Username",
"example": "user1",
"in": "path",
"name": "username",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"context": [
"KV get - scoped to tenant_agent_00.user: for 2 bookings in document user1"
],
"data": [
{
"date": "05/24/2021",
"destinationairport": "LAX",
"equipment": "738",
"flight": "AA655",
"flighttime": 5383,
"name": "American Airlines",
"price": 672.88,
"sourceairport": "SFO",
"utc": "11:42:00"
},
{
"date": "05/28/2021",
"destinationairport": "SFO",
"equipment": "738",
"flight": "AA344",
"flighttime": 6081,
"name": "American Airlines",
"price": 760.13,
"sourceairport": "LAX",
"utc": "20:47:00"
}
]
},
"schema": {
"$ref": "#/components/schemas/ResultList"
}
}
},
"description": "Returns flight data and query context information"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Returns an authentication error"
}
},
"security": [
{
"bearer": []
}
],
"summary": "List the flights that have been reserved by a user",
"tags": [
"tenants"
]
},
"put": {
"parameters": [
{
"description": "Tenant agent name",
"example": "tenant_agent_00",
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Username",
"example": "user1",
"in": "path",
"name": "username",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"flights": {
"example": [
{
"date": "12/12/2020",
"destinationairport": "Leonardo Da Vinci International Airport",
"flight": "12RF",
"name": "boeing",
"price": 50.0,
"sourceairport": "London (Gatwick)"
}
],
"format": "string",
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"context": [
"KV update - scoped to tenant_agent_00.user: for bookings field in document user1"
],
"data": {
"added": [
{
"date": "12/12/2020",
"destinationairport": "Leonardo Da Vinci International Airport",
"flight": "12RF",
"name": "boeing",
"price": 50.0,
"sourceairport": "London (Gatwick)"
}
]
}
},
"schema": {
"$ref": "#/components/schemas/ResultSingleton"
}
}
},
"description": "Returns flight data and query context information"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Returns an authentication error"
}
},
"security": [
{
"bearer": []
}
],
"summary": "Book a new flight for a user",
"tags": [
"tenants"
]
}
}
}
}