-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
286 lines (285 loc) · 9.71 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
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/apps/protoc-gen-openapi
openapi: 3.0.3
info:
title: WarningDetect
description: 预警检测服务，主要包括设备信息查询与推送相关的服务
version: 0.0.1
paths:
/configs/0:
get:
summary: 查询单个设备的配置信息
operationId: Config_GetDeviceConfig0
parameters:
- name: device_id
in: query
description: 设备id
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceConfig0'
/configs/1:
get:
summary: 查询单个设备的配置信息
operationId: Config_GetDeviceConfig1
parameters:
- name: device_id
in: query
description: 设备id
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceConfig1'
/states/{device_class_id}:
get:
summary: 分页查询设备信息
operationId: WarningDetect_BatchGetDeviceStateInfo
parameters:
- name: device_class_id
in: query
description: 设备类别号
schema:
type: string
- name: start
in: query
description: 时间范围 开始时间
schema:
type: string
- name: end
in: query
description: 结束时间
schema:
type: string
- name: past
in: query
description: 相对时间范围查询，用于查询过去若干时间内的记录
schema:
type: string
- name: filter
in: query
description: 查询过滤的条件，可以针对_measurement、_field或tag进行过滤
schema:
type: string
- name: limit
in: query
description: 分页查询参数
schema:
type: string
- name: offset
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetDeviceStateReply'
delete:
summary: 删除设备状态信息
operationId: WarningDetect_DeleteDeviceStateInfo
parameters:
- name: device_class_id
in: query
description: 设备类别号
schema:
type: string
- name: device_id
in: query
description: 设备id
schema:
type: string
- name: time
in: query
description: 时间
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDeviceStateReply'
/warnings:
get:
summary: 分页查询用户的警告消息
operationId: WarningDetect_BatchGetWarning
parameters:
- name: start
in: query
description: 时间范围 开始时间
schema:
type: string
- name: end
in: query
description: 结束时间
schema:
type: string
- name: past
in: query
description: 相对时间范围查询，用于查询过去若干时间内的记录
schema:
type: string
- name: filter
in: query
description: 查询过滤的条件，可以针对_measurement、_field或tag进行过滤
schema:
type: string
- name: limit
in: query
description: 分页查询参数
schema:
type: string
- name: offset
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetWarningReply'
put:
summary: 更新用户的警告消息的处理状态
operationId: WarningDetect_UpdateWarning
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWarningRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWarningReply'
delete:
summary: 删除用户的警告消息
operationId: WarningDetect_DeleteWarning
parameters:
- name: device_class_id
in: query
description: 设备类别号
schema:
type: string
- name: device_id
in: query
description: 设备id
schema:
type: string
- name: device_field_name
in: query
description: 设备字段名称
schema:
type: string
- name: time
in: query
description: 时间
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWarningReply'
components:
schemas:
BatchGetDeviceStateReply:
properties:
states:
type: array
items:
$ref: '#/components/schemas/DeviceState'
total:
type: integer
format: int32
description: 设备状态信息批量查询响应
BatchGetWarningReply:
properties:
warnings:
type: array
items:
$ref: '#/components/schemas/Warning'
total:
type: integer
format: int32
description: 警告消息批量查询响应
DeleteDeviceStateReply:
properties:
success:
type: boolean
description: 删除设备状态信息响应
DeleteWarningReply:
properties:
success:
type: boolean
description: 警告信息删除响应
DeviceConfig0:
properties:
id:
type: string
status:
type: boolean
DeviceConfig1:
properties:
id:
type: string
status:
type: boolean
DeviceState:
properties:
device_class_id:
type: integer
format: int32
device_id:
type: string
time:
type: string
format: RFC3339
fields:
$ref: '#/components/schemas/FieldsEntry'
tags:
type: object
UpdateWarningReply:
properties:
success:
type: boolean
description: 更新警告信息处理状态响应
UpdateWarningRequest:
properties:
device_class_id:
type: integer
description: 设备类别号
format: int32
device_id:
type: string
description: 设备id
device_field_name:
type: string
description: 设备字段名称
time:
type: string
description: 时间
format: RFC3339
processed:
type: boolean
description: 处理状态
description: 更新警告信息处理状态请求