-
Notifications
You must be signed in to change notification settings - Fork 20
/
openapi.yaml
215 lines (209 loc) · 5.93 KB
/
openapi.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 Spec for the KongAir Flights service
openapi: 3.0.0
info:
description: KongAir Flights service provides the scheduled flights for KongAir
version: 0.1.0
title: Flights Service
servers:
- url: https://api.kong-air.com
description: KongAir API Server
paths:
/health:
get:
summary: Health check endpoint for Kubernetes
description: Endpoint that returns the service health status.
responses:
'200':
description: Service is healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: "OK"
headers:
hostname:
description: "The hostname of the machine fulfilling the request."
schema:
type: string
'500':
description: Service is unhealthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: "unhealthy"
"/flights":
get:
summary: Get KongAir planned flights
description: |
Returns all the scheduled flights for a given day
tags:
- flight-data
operationId: get-flights
parameters:
- name: date
in: query
description: Filter by date (defaults to current day)
required: false
style: form
schema:
type: string
format: date
responses:
'200':
description: Successful respone with scheduled flights
headers:
hostname:
description: "The hostname of the machine fulfilling the request."
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Flight'
examples:
Example Flights List:
value: |
[
{
"number": "KD924",
"route_id": "LHR-SFO",
"scheduled_departure": "2024-03-20T09:12:28Z",
"scheduled_arrival": "2024-03-20T19:12:28Z"
},
{
"number": "KD925",
"route_id": "SFO-LHR",
"scheduled_departure": "2024-03-21T09:12:28Z",
"scheduled_arrival": "2024-03-21T19:12:28Z"
}
]
"/flights/{flightNumber}":
get:
summary: Get a specific flight by flight number
description: |
Returns a specific flight given its flight number
tags:
- flight-data
operationId: get-flight-by-number
parameters:
- name: flightNumber
in: path
description: The flight number
required: true
style: simple
schema:
type: string
responses:
'200':
description: Successful response with the requested flight
headers:
hostname:
description: "The hostname of the machine fulfilling the request."
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Flight'
examples:
Example Flight KD924:
value: |
{
"number": "KD924",
"route_id": "LHR-SFO",
"scheduled_departure": "2024-03-20T09:12:28Z",
"scheduled_arrival": "2024-03-20T19:12:28Z"
}
'404':
description: Flight not found
content:
application/json:
schema:
type: object
properties:
message:
type: string
"/flights/{flightNumber}/details":
get:
summary: Fetch more details about a flight
description: Fetch more details about a flight
tags:
- flight-data
operationId: get-flight-details
parameters:
- name: flightNumber
in: path
description: The flight number
required: true
style: simple
schema:
type: string
responses:
'200':
description: Successful response with the requested flight details
headers:
hostname:
description: "The hostname of the machine fulfilling the request."
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FlightDetails'
'404':
description: Flight not found
content:
application/json:
schema:
type: object
properties:
message:
type: string
components:
schemas:
Flight:
type: object
properties:
number:
type: string
route_id:
type: string
scheduled_departure:
type: string
format: date-time
scheduled_arrival:
type: string
format: date-time
required:
- number
- route_id
- scheduled_departure
- scheduled_arrival
FlightDetails:
type: object
properties:
flight_number:
type: string
in_flight_entertainment:
type: boolean
meal_options:
type: array
items:
type: string
aircraft_type:
type: string
required:
- flight_number
- in_flight_entertainment
- mean_options
- aircraft_type