-
Notifications
You must be signed in to change notification settings - Fork 0
/
eonet-v3.yaml
267 lines (259 loc) · 8.81 KB
/
eonet-v3.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
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
openapi: 3.0.0
info:
title: The Earth Observatory Natural Event Tracker ([EONET](https://eonet.sci.gsfc.nasa.gov/what-is-eonet))
version: 3.0.0
servers:
- url: https://eonet.sci.gsfc.nasa.gov/api/v3
- url: http://eonet.sci.gsfc.nasa.gov/api/v3
paths:
/categories/{categoryId}: # ../categories
get:
summary: Returns a json object of categories.
description: ""
parameters:
- name: categoryId
in: path
required: true
description: Filter the events by the Category.
schema:
type: string
- name: source
in: query
required: false
description: Filter the topically-constrained events by the Source. Multiple sources can be included in the parameter, comma separated, operates as a boolean OR.
schema:
type : string
- name: status
in: query
required: false
description: Events that have ended are assigned a closed date and the existence of that date will allow you to filter for only-open or only-closed events. Omitting the status parameter will return only the currently open events.
schema:
type: string
default: open
enum:
- open
- closed
- name: limit
in: query
required: false
description: Limits the number of events returned.
schema:
type: integer
format: int64
- name: days
in: query
required: false
description: Limit the number of prior days (including today) from which events will be returned.
schema:
type: integer
format: int64
- name: start
in: query
required: false
description: Select a starting date for the events. To be used together with end parameter.
schema:
type: string
- name: end
in: query
required: false
description: Select an ending date for the events. To be used together with start parameter for defining a range.
schema:
type: string
responses:
200: #status code
description: A JSON object upon successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryResponse'
/events:
get:
summary: Return a json object of events.
description: ""
parameters:
- name: source
in: query
required: false
description: Filter the returned events by the Source. Multiple sources can be included in the parameter, comma separated, operates as a boolean OR.
schema:
type: string
- name: category
in: query
required: false
description: Filter the returned events by the category. Multiple sources can be included in the parameter, comma separated, operates as a boolean OR.
schema:
type: string
- name: status
in: query
required: false
description: Events that have ended are assigned a closed date and the existence of that date will allow you to filter for only-open or only-closed events. Omitting the status parameter will return only the currently open events (default). Using “all“ will list open and closed values.
schema:
type: string
default: open
enum:
- open
- closed
- all
- name: limit
in: query
required: false
description: Limits the number of events returned.
schema:
type: integer
format: int64
- name: days
in: query
required: false
description: Limit the number of prior days (including today) from which events will be returned.
schema:
type: integer
format: int64
- name: start
in: query
required: false
description: Select a starting dates for the events in a YYYY-MM-DD format.
schema:
type: string
- name: end
in: query
required: false
description: Select an ending date for the events in YYYY-MM-DD format.
schema:
type: string
- name: magID
in: query
required: false
description: ""
schema:
type: string
enum:
- mag_kts
- mms
- sq_NM
- name: magMin
in: query
required: false
description: ""
schema:
type: number
- name: magMax
in: query
required: false
description: ""
schema:
type: number
- name: bbox
in: query
required: false
description: Query using a bounding box for all events with datapoints that fall within. This uses two pairs of coordinates, the upper left hand corner (lon,lat) followed by the lower right hand corner (lon,lat).
schema:
type: string
responses:
200: # status code
description: A JSON object upon successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryResponse'
components:
schemas:
Category:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
link:
type: string
Source:
type: object
properties:
id:
type: string
description: unique id of source type
title:
type: string
description: title of this source
source:
type: string
description: homepage URL for this source
link:
type: string
description: The full link to the API endpoint for this specific source, which is the same as the Events API endpoint only filtered to return only events from this source.
Geometry:
type: object
description: One or more event geometries are the pairing of a specific date/time with a location.
properties:
magnitudeValue:
type: string
description: Information regarding the event magnitude is displayed if available.
magnitudeUnit:
type: string
description: Information regarding the event magnitude unit is displayed if available.
date:
type: string
description: The date/time will most likely be 00:00Z unless the source provided a particular time.
type:
type: string
enum:
- Point
- Polygon
coordinates:
type: array
minItems: 2
items:
type: number
Event:
type: object
properties:
id:
type: string
description: Unique id for this event.
title:
type: string
description: The title of the event.
description:
type: string
description: Optional longer description of the event. Most likely only a sentence or two.
link:
type: string
description: The full link to the API endpoint for this specific event.
closed:
type: string
description: An event is deemed “closed” when it has ended. The closed field will include a date/time when the event has ended. Depending upon the nature of the event, the closed value may or may not accurately represent the absolute ending of the event. If the event is open, this will show “null”.
categories:
type: array
description: One or more categories assigned to the event.
items:
oneOf:
- $ref: '#/components/schemas/Category'
sources:
type: array
description: One or more sources that refer to more information about the event.
items:
oneOf:
- $ref: '#/components/schemas/Source'
geometry:
type: array
description: One or more event geometries are the pairing of a specific date/time with a location. Information regarding the event magnitude, if available, is displayed here.
items:
oneOf:
- $ref: '#/components/schemas/Geometry'
CategoryResponse:
type: object
properties:
title:
type: string
description:
type: string
link:
type: string
events:
type: array
description: An array of events.
items:
oneOf:
- $ref: '#/components/schemas/Event'