forked from koala73/worldmonitor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHealthService.openapi.yaml
More file actions
189 lines (189 loc) · 7.54 KB
/
HealthService.openapi.yaml
File metadata and controls
189 lines (189 loc) · 7.54 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
openapi: 3.1.0
info:
title: HealthService API
version: 1.0.0
paths:
/api/health/v1/list-disease-outbreaks:
get:
tags:
- HealthService
summary: ListDiseaseOutbreaks
description: ListDiseaseOutbreaks returns recent WHO/ProMED disease outbreak alerts.
operationId: ListDiseaseOutbreaks
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListDiseaseOutbreaksResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/health/v1/list-air-quality-alerts:
get:
tags:
- HealthService
summary: ListAirQualityAlerts
description: ListAirQualityAlerts returns recent PM2.5 stations with AQI-derived health risk.
operationId: ListAirQualityAlerts
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAirQualityAlertsResponse'
"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.
ListDiseaseOutbreaksRequest:
type: object
ListDiseaseOutbreaksResponse:
type: object
properties:
outbreaks:
type: array
items:
$ref: '#/components/schemas/DiseaseOutbreakItem'
fetchedAt:
type: integer
format: int64
description: 'Warning: Values > 2^53 may lose precision in JavaScript'
DiseaseOutbreakItem:
type: object
properties:
id:
type: string
description: Unique identifier (URL-derived).
disease:
type: string
description: Disease or outbreak name.
location:
type: string
description: Affected country or region.
countryCode:
type: string
description: ISO2 country code when known.
alertLevel:
type: string
description: 'Alert level: "watch" | "warning" | "alert".'
summary:
type: string
description: Short description from the source.
sourceUrl:
type: string
description: Source URL.
publishedAt:
type: integer
format: int64
description: 'Unix epoch milliseconds when published.. Warning: Values > 2^53 may lose precision in JavaScript'
sourceName:
type: string
description: Source name (e.g., "WHO", "ProMED", "HealthMap").
lat:
type: number
format: double
description: Precise latitude from source (overrides country centroid on map when non-zero).
lng:
type: number
format: double
description: Precise longitude from source (overrides country centroid on map when non-zero).
cases:
type: integer
format: int32
description: Case count if reported by source (0 = unknown).
description: DiseaseOutbreakItem represents a single disease outbreak event.
ListAirQualityAlertsRequest:
type: object
ListAirQualityAlertsResponse:
type: object
properties:
alerts:
type: array
items:
$ref: '#/components/schemas/AirQualityAlert'
fetchedAt:
type: integer
format: int64
description: 'Warning: Values > 2^53 may lose precision in JavaScript'
AirQualityAlert:
type: object
properties:
city:
type: string
countryCode:
type: string
lat:
type: number
format: double
lng:
type: number
format: double
pm25:
type: number
format: double
aqi:
type: integer
format: int32
riskLevel:
type: string
pollutant:
type: string
measuredAt:
type: integer
format: int64
description: 'Warning: Values > 2^53 may lose precision in JavaScript'
source:
type: string