com.mytinygiraffe.wx.alert.v1
Schema Diff
+7 -5
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 0 non-breaking changes.
Breaking Changes (1)
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "com.mytinygiraffe.wx.alert.v1:body", src: "com.mytinygiraffe.wx.alert.v1:body", tgt: "com.mytinygiraffe.wx.alert.v1:body.parsed", kind: "prop", name: Some("parsed") }
Migration Guidance
Additional Notes
- Breaking: RequiredEdgeAdded { vertex_id: "com.mytinygiraffe.wx.alert.v1:body", src: "com.mytinygiraffe.wx.alert.v1:body", tgt: "com.mytinygiraffe.wx.alert.v1:body.parsed", kind: "prop", name: Some("parsed") }
1
1
{
2
2
"id": "com.mytinygiraffe.wx.alert.v1",
3
3
"defs": {
4
4
"main": {
5
5
"key": "any",
6
6
"type": "record",
7
7
"record": {
8
8
"type": "object",
9
9
"required": [
10
10
"geometry",
11
-
"properties"
11
+
"properties",
12
+
"parsed"
12
13
],
13
14
"properties": {
14
15
"parsed": {
15
16
"type": "object",
16
17
"properties": {
17
18
"area": {
18
19
"type": "array",
19
20
"items": {
20
21
"type": "string",
21
22
"description": "One place covered by this area"
22
23
},
23
24
"description": "The original alert area split into individual locations instead of a single long string"
24
25
},
25
26
"locations": {
26
27
"type": "object",
27
28
"properties": {
28
29
"cities": {
29
30
"type": "array",
30
31
"items": {
31
32
"type": "string"
32
33
},
33
34
"description": "A list of cities affected by the alert, extracted from the original alert description"
34
35
},
35
36
"regions": {
36
37
"type": "array",
37
38
"items": {
38
39
"type": "object",
39
40
"properties": {
40
41
"area": {
41
42
"type": "string",
42
43
"description": "A description of a geographical region, such as 'northeastern Iowa'"
43
44
},
44
45
"counties": {
45
46
"type": "array",
46
47
"items": {
47
48
"type": "string"
48
49
},
49
50
"description": "A list of counties or county-equivalents in the region"
50
51
}
51
52
}
52
53
}
53
54
}
54
55
},
55
56
"description": "The regions and counties affected by this alert, extracted from the original alert description"
56
57
},
57
58
"description": {
58
59
"type": "string",
59
60
"description": "The original alert description parsed into Markdown, with locations moved to the locations property"
60
61
},
61
62
"instruction": {
62
63
"type": "string",
63
64
"instruction": "The original alert instruction with extraneous whitespace removed"
64
65
}
65
66
},
66
67
"description": "Text fields from the original alert, parsed"
67
68
},
68
69
"geometry": {
69
70
"type": "object",
70
-
"title": "GeoJSON Polygon",
71
71
"required": [
72
72
"type",
73
73
"coordinates"
74
74
],
75
75
"properties": {
76
76
"type": {
77
77
"enum": [
78
78
"Polygon",
79
79
"MultiPolygon"
80
80
],
81
81
"type": "string"
82
82
},
83
83
"coordinates": {
84
84
"type": "unknown",
85
85
"description": "A GeoJSON polygon or multipolygon. Please refer to IETF RFC 7946 for information on the GeoJSON format. To comply with the AT Proto Lexicon schema, the coordinates are floating-point numbers encoded as decimal strings."
86
86
}
87
-
}
87
+
},
88
+
"description": "GeoJSON polygon or multipolygon"
88
89
},
89
90
"properties": {
90
91
"type": "object",
91
92
"properties": {
92
93
"id": {
93
94
"type": "string",
94
95
"description": "The identifier of the alert message."
95
96
},
96
97
"web": {
97
98
"type": "string",
98
99
"description": "The identifier of the hyperlink associating additional information within the alert message."
99
100
},
100
101
"code": {
101
102
"type": "string",
102
103
"description": "The code denoting the special handling of the alert message."
103
104
},
104
105
"ends": {
105
106
"type": "string",
106
107
"format": "datetime",
107
108
"description": "The expected end time of the subject event of the alert message."
108
109
},
109
110
"note": {
110
111
"type": "string",
111
112
"description": "The text note accompanying the alert message. Per CAP spec, this should accompany alerts with a status of \"Test\".\n"
112
113
},
113
114
"sent": {
114
115
"type": "string",
115
116
"format": "datetime",
116
117
"description": "The time of the origination of the alert message."
117
118
},
118
119
"event": {
119
120
"type": "string",
120
121
"description": "The text denoting the type of the subject event of the alert message."
121
122
},
122
123
"onset": {
123
124
"type": "string",
124
125
"format": "datetime",
125
126
"description": "The expected time of the beginning of the subject event of the alert message."
126
127
},
127
128
"scope": {
128
129
"enum": [
129
130
"Public",
130
131
"Restricted",
131
132
"Private"
132
133
],
133
134
"type": "string",
134
135
"description": "The code denoting the intended distribution of the alert message."
135
136
},
136
137
"sender": {
137
138
"type": "string",
138
139
"description": "Email address of the NWS webmaster."
139
140
},
140
141
"status": {
141
142
"enum": [
142
143
"Actual",
143
144
"Exercise",
144
145
"System",
145
146
"Test",
146
147
"Draft"
147
148
],
148
149
"type": "string"
149
150
},
150
151
"expires": {
151
152
"type": "string",
152
153
"format": "datetime",
153
154
"description": "The expiry time of the information of the alert message."
154
155
},
155
156
"geocode": {
156
157
"type": "object",
157
158
"properties": {
158
159
"UGC": {
159
160
"type": "array",
160
161
"items": {
161
162
"type": "string",
162
163
"pattern": "^(A[KLMNRSZ]|C[AOT]|D[CE]|F[LM]|G[AMU]|I[ADLN]|K[SY]|L[ACEHMOS]|M[ADEHINOPST]|N[CDEHJMVY]|O[HKR]|P[AHKMRSWZ]|S[CDL]|T[NX]|UT|V[AIT]|W[AIVY]|[HR]I)[CZ]\\d{3}$",
163
164
"description": "UGC identifier for a NWS forecast zone or county.\nThe first two letters will correspond to either a state code or marine area code (see #/components/schemas/StateTerritoryCode and #/components/schemas/MarineAreaCode for lists of valid letter combinations).\nThe third letter will be Z for public/fire zone or C for county."
164
165
},
165
166
"description": "A list of NWS public zone or county identifiers."
166
167
},
167
168
"SAME": {
168
169
"type": "array",
169
170
"items": {
170
171
"type": "string",
171
172
"pattern": "^\\d{6}$"
172
173
},
173
174
"description": "A list of SAME (Specific Area Message Encoding) codes for affected counties."
174
175
}
175
176
},
176
177
"description": "Lists of codes for NWS public zones and counties affected by the alert."
177
178
},
178
179
"urgency": {
179
180
"enum": [
180
181
"Immediate",
181
182
"Expected",
182
183
"Future",
183
184
"Past",
184
185
"Unknown"
185
186
],
186
187
"type": "string"
187
188
},
188
189
"areaDesc": {
189
190
"type": "string",
190
191
"description": "A textual description of the area affected by the alert."
191
192
},
192
193
"category": {
193
194
"enum": [
194
195
"Met",
195
196
"Geo",
196
197
"Safety",
197
198
"Security",
198
199
"Rescue",
199
200
"Fire",
200
201
"Health",
201
202
"Env",
202
203
"Transport",
203
204
"Infra",
204
205
"CBRNE",
205
206
"Other"
206
207
],
207
208
"type": "string",
208
209
"description": "The code denoting the category of the subject event of the alert message."
209
210
},
210
211
"headline": {
211
212
"type": "string",
212
213
"description": "The text headline of the alert message."
213
214
},
214
215
"language": {
215
216
"type": "string",
216
217
"description": "The code denoting the language of the info sub-element of the alert message."
217
218
},
218
219
"response": {
219
220
"enum": [
220
221
"Shelter",
221
222
"Evacuate",
222
223
"Prepare",
223
224
"Execute",
224
225
"Avoid",
225
226
"Monitor",
226
227
"Assess",
227
228
"AllClear",
228
229
"None"
229
230
],
230
231
"type": "string",
231
232
"description": "The code denoting the type of action recommended for the target audience.\nThis corresponds to responseType in the CAP specification.\n"
232
233
},
233
234
"severity": {
234
235
"enum": [
235
236
"Extreme",
236
237
"Severe",
237
238
"Moderate",
238
239
"Minor",
239
240
"Unknown"
240
241
],
241
242
"type": "string"
242
243
},
243
244
"certainty": {
244
245
"enum": [
245
246
"Observed",
246
247
"Likely",
247
248
"Possible",
248
249
"Unlikely",
249
250
"Unknown"
250
251
],
251
252
"type": "string"
252
253
},
253
254
"effective": {
254
255
"type": "string",
255
256
"format": "datetime",
256
257
"description": "The effective time of the information of the alert message."
257
258
},
258
259
"eventCode": {
259
260
"type": "object",
260
261
"description": "System-specific code identifiying the event type of the alert message The keys in this object correspond to eventCode definitions in the NWS CAP specification.\n",
261
262
"additionalProperties": {
262
263
"type": "array",
263
264
"items": {}
264
265
}
265
266
},
266
267
"parameters": {
267
268
"type": "object",
268
269
"description": "System-specific additional parameters associated with the alert message.\nThe keys in this object correspond to parameter definitions in the NWS CAP specification.\n",
269
270
"additionalProperties": {
270
271
"type": "array",
271
272
"items": {}
272
273
}
273
274
},
274
275
"references": {
275
276
"type": "array",
276
277
"items": {
277
278
"type": "object",
278
279
"properties": {
279
280
"id": {
280
281
"type": "string",
281
282
"format": "uri",
282
283
"description": "An API link to the prior alert."
283
284
},
284
285
"sent": {
285
286
"type": "string",
286
287
"format": "datetime",
287
288
"description": "The time the prior alert was sent."
288
289
},
289
290
"sender": {
290
291
"type": "string",
291
292
"description": "The sender of the prior alert."
292
293
},
293
294
"identifier": {
294
295
"type": "string",
295
296
"description": "The identifier of the alert message."
296
297
}
297
298
}
298
299
},
299
300
"description": "A list of prior alerts that this alert updates or replaces."
300
301
},
301
302
"senderName": {
302
303
"type": "string",
303
304
"description": "The text naming the originator of the alert message."
304
305
},
305
306
"description": {
306
307
"type": "string",
307
308
"description": "The text describing the subject event of the alert message."
308
309
},
309
310
"instruction": {
310
311
"type": "string",
311
312
"description": "The text describing the recommended action to be taken by recipients of the alert message.\n"
312
313
},
313
314
"messageType": {
314
315
"enum": [
315
316
"Alert",
316
317
"Update",
317
318
"Cancel",
318
319
"Ack",
319
320
"Error"
320
321
],
321
322
"type": "string"
322
323
},
323
324
"affectedZones": {
324
325
"type": "array",
325
326
"items": {
326
327
"type": "string",
327
328
"format": "uri"
328
329
},
329
330
"description": "An array of API links for zones affected by the alert. This is an API-specific extension field and is not part of the CAP specification.\n"
330
331
}
331
-
}
332
+
},
333
+
"description": "Alert properties, precisely as provided by api.weather.gov"
332
334
}
333
335
}
334
336
},
335
-
"description": "TODO: describe purpose of this schema"
337
+
"description": "A weather alert issued by the US National Weather Service"
336
338
}
337
339
},
338
340
"$type": "com.atproto.lexicon.schema",
339
341
"lexicon": 1
340
342
}