forked from koala73/worldmonitor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWildfireService.openapi.yaml
More file actions
239 lines (239 loc) · 9.97 KB
/
WildfireService.openapi.yaml
File metadata and controls
239 lines (239 loc) · 9.97 KB
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
openapi: 3.1.0
info:
title: WildfireService API
version: 1.0.0
paths:
/api/wildfire/v1/list-fire-detections:
get:
tags:
- WildfireService
summary: ListFireDetections
description: ListFireDetections retrieves satellite-detected active fires from NASA FIRMS.
operationId: ListFireDetections
parameters:
- name: start
in: query
description: Start of time range (inclusive), Unix epoch milliseconds.
required: false
schema:
type: string
format: int64
- name: end
in: query
description: End of time range (inclusive), Unix epoch milliseconds.
required: false
schema:
type: string
format: int64
- name: page_size
in: query
description: Maximum items per page (1-100).
required: false
schema:
type: integer
format: int32
- name: cursor
in: query
description: Cursor for next page.
required: false
schema:
type: string
- name: ne_lat
in: query
description: North-east latitude of bounding box.
required: false
schema:
type: number
format: double
- name: ne_lon
in: query
description: North-east longitude of bounding box.
required: false
schema:
type: number
format: double
- name: sw_lat
in: query
description: South-west latitude of bounding box.
required: false
schema:
type: number
format: double
- name: sw_lon
in: query
description: South-west longitude of bounding box.
required: false
schema:
type: number
format: double
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListFireDetectionsResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
message:
type: string
description: Error message (e.g., 'user not found', 'database connection failed')
description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
FieldViolation:
type: object
properties:
field:
type: string
description: The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')
description:
type: string
description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
required:
- field
- description
description: FieldViolation describes a single validation error for a specific field.
ValidationError:
type: object
properties:
violations:
type: array
items:
$ref: '#/components/schemas/FieldViolation'
description: List of validation violations
required:
- violations
description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
ListFireDetectionsRequest:
type: object
properties:
start:
type: integer
format: int64
description: 'Start of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
end:
type: integer
format: int64
description: 'End of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
pageSize:
type: integer
format: int32
description: Maximum items per page (1-100).
cursor:
type: string
description: Cursor for next page.
neLat:
type: number
format: double
description: North-east latitude of bounding box.
neLon:
type: number
format: double
description: North-east longitude of bounding box.
swLat:
type: number
format: double
description: South-west latitude of bounding box.
swLon:
type: number
format: double
description: South-west longitude of bounding box.
description: ListFireDetectionsRequest specifies filters for retrieving fire detections from NASA FIRMS.
ListFireDetectionsResponse:
type: object
properties:
fireDetections:
type: array
items:
$ref: '#/components/schemas/FireDetection'
pagination:
$ref: '#/components/schemas/PaginationResponse'
description: ListFireDetectionsResponse contains the list of fire detections matching the request filters.
FireDetection:
type: object
properties:
id:
type: string
maxLength: 100
minLength: 1
description: Unique detection identifier.
location:
$ref: '#/components/schemas/GeoCoordinates'
brightness:
type: number
format: double
description: Brightness temperature in Kelvin.
frp:
type: number
format: double
description: Fire radiative power in MW.
confidence:
type: string
enum:
- FIRE_CONFIDENCE_UNSPECIFIED
- FIRE_CONFIDENCE_LOW
- FIRE_CONFIDENCE_NOMINAL
- FIRE_CONFIDENCE_HIGH
description: FireConfidence represents the confidence level of a fire detection.
satellite:
type: string
description: Satellite that detected the fire (e.g., "MODIS", "VIIRS", "LANDSAT").
detectedAt:
type: integer
format: int64
description: 'Time the fire was detected, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
region:
type: string
description: Monitored region name (e.g., "Ukraine", "Russia", "Iran").
dayNight:
type: string
description: Day or night detection ("D" or "N").
possibleExplosion:
type: boolean
description: |-
Whether the thermal signature suggests a possible explosion rather than a fire
(FRP > 80 MW and brightness > 380 K).
required:
- id
description: FireDetection represents a satellite-detected active fire from NASA FIRMS.
GeoCoordinates:
type: object
properties:
latitude:
type: number
maximum: 90
minimum: -90
format: double
description: Latitude in decimal degrees (-90 to 90).
longitude:
type: number
maximum: 180
minimum: -180
format: double
description: Longitude in decimal degrees (-180 to 180).
description: GeoCoordinates represents a geographic location using WGS84 coordinates.
PaginationResponse:
type: object
properties:
nextCursor:
type: string
description: Cursor for fetching the next page. Empty string indicates no more pages.
totalCount:
type: integer
format: int32
description: Total count of items matching the query, if known. Zero if the total is unknown.
description: PaginationResponse contains pagination metadata returned alongside list results.