-
Notifications
You must be signed in to change notification settings - Fork 1
/
CsmpComponents-1.0.yaml
351 lines (340 loc) · 12.4 KB
/
CsmpComponents-1.0.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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# OpenAPI version identifier - required for OpenAPI 3.0 domains
openapi: 3.0.0
info:
title: CSMP Components
description: Common components for CSMP APIs
version: '1.0'
components:
schemas:
TLVsGetAbleFromDevice:
description: |
TLVs which are GET-able from a <device-url>/c.
Metrics and settings. Note: full table access is permitted.
anyOf:
- $ref: '#/components/schemas/TlvIndex'
- $ref: '#/components/schemas/HardwareDesc'
- $ref: '#/components/schemas/InterfaceDesc'
- $ref: '#/components/schemas/ReportSubscribe'
- $ref: '#/components/schemas/IPAddress'
- $ref: '#/components/schemas/IPRoute'
- $ref: '#/components/schemas/CurrentTime'
- $ref: '#/components/schemas/RPLSettings'
- $ref: '#/components/schemas/Uptime'
- $ref: '#/components/schemas/InterfaceMetrics'
- $ref: '#/components/schemas/IPRouteRPLMetrics'
- $ref: '#/components/schemas/Ieee8021xStatus'
- $ref: '#/components/schemas/Ieee80211iStatus'
- $ref: '#/components/schemas/WPANStatus'
- $ref: '#/components/schemas/DHCP6ClientStatus'
- $ref: '#/components/schemas/NMSSettings'
- $ref: '#/components/schemas/NMSStatus'
- $ref: '#/components/schemas/Ieee8021xSettings'
- $ref: '#/components/schemas/Ieee802154BeaconStats'
- $ref: '#/components/schemas/RPLInstance'
- $ref: '#/components/schemas/FirmwareImageInfo'
- $ref: '#/components/schemas/SysResetStats'
- $ref: '#/components/schemas/MplStats'
- $ref: '#/components/schemas/RPLStats'
- $ref: '#/components/schemas/DHCP6Stats'
- $ref: '#/components/schemas/EventReport'
- $ref: '#/components/schemas/EventIndex'
- $ref: '#/components/schemas/EventSubscribe'
- $ref: '#/components/schemas/EventStats'
- $ref: '#/components/schemas/NetworkRole'
- $ref: '#/components/schemas/NetStat'
RegistrationRequestTLVs:
description: |
TLVs which may be contained in a registration POST request to the NMS.
anyOf:
- $ref: '#/components/schemas/DeviceID'
- $ref: '#/components/schemas/CurrentTime'
- $ref: '#/components/schemas/HardwareDesc'
- $ref: '#/components/schemas/InterfaceDesc'
- $ref: '#/components/schemas/IPAddress'
- $ref: '#/components/schemas/NMSStatus'
- $ref: '#/components/schemas/WPANStatus'
- $ref: '#/components/schemas/RPLSettings'
- $ref: '#/components/schemas/SessionID'
- $ref: '#/components/schemas/GroupInfo'
- $ref: '#/components/schemas/ReportSubscribe'
RegistrationResponseTLVs:
description: |
TLVs which may be contained in a registration response from the NMS.
anyOf:
- $ref: '#/components/schemas/SessionID'
- $ref: '#/components/schemas/GroupAssign'
- $ref: '#/components/schemas/ReportSubscribe'
- $ref: '#/components/schemas/DescriptionRequest'
- $ref: '#/components/schemas/NMSRedirectRequest'
TLVsPostAbleToNMS:
description: |
TLVs which may be POSTed to <nms-url>/c
There are several situations under which this can occur ...
1. Periodic metrics reports from a device.
2. Command responses from a device.
3. Asynchronous events reported by a device.
4. Asynchronous GET responses from a device.
anyOf:
- $ref: '#/components/schemas/TlvIndex'
- $ref: '#/components/schemas/DeviceID'
- $ref: '#/components/schemas/NMSRedirectRequest'
- $ref: '#/components/schemas/SessionID'
- $ref: '#/components/schemas/HardwareDesc'
- $ref: '#/components/schemas/InterfaceDesc'
- $ref: '#/components/schemas/ReportSubscribe'
- $ref: '#/components/schemas/IPAddress'
- $ref: '#/components/schemas/IPRoute'
- $ref: '#/components/schemas/CurrentTime'
- $ref: '#/components/schemas/RPLSettings'
- $ref: '#/components/schemas/Uptime'
- $ref: '#/components/schemas/InterfaceMetrics'
- $ref: '#/components/schemas/IPRouteRPLMetrics'
- $ref: '#/components/schemas/PingResponse'
- $ref: '#/components/schemas/Ieee8021xStatus'
- $ref: '#/components/schemas/Ieee80211iStatus'
- $ref: '#/components/schemas/WPANStatus'
- $ref: '#/components/schemas/DHCP6ClientStatus'
- $ref: '#/components/schemas/NMSSettings'
- $ref: '#/components/schemas/NMSStatus'
- $ref: '#/components/schemas/Ieee8021xSettings'
- $ref: '#/components/schemas/Ieee802154BeaconStats'
- $ref: '#/components/schemas/RPLInstance'
- $ref: '#/components/schemas/GroupInfo'
- $ref: '#/components/schemas/LowpanMacStats'
- $ref: '#/components/schemas/LowpanPhySettings'
- $ref: '#/components/schemas/TransferResponse'
- $ref: '#/components/schemas/LoadResponse'
- $ref: '#/components/schemas/CancelLoadResponse'
- $ref: '#/components/schemas/SetBackupResponse'
- $ref: '#/components/schemas/FirmwareImageInfo'
- $ref: '#/components/schemas/SysResetStats'
- $ref: '#/components/schemas/MplStats'
- $ref: '#/components/schemas/RPLStats'
- $ref: '#/components/schemas/DHCP6Stats'
- $ref: '#/components/schemas/EventReport'
- $ref: '#/components/schemas/EventIndex'
- $ref: '#/components/schemas/EventStats'
TLVsPostAbleToDevice:
description: |
TLVs which may be POSTed to <device-url>/c.
Commands and settings.
anyOf:
- $ref: '#/components/schemas/NMSRedirectRequest'
- $ref: '#/components/schemas/RPLSettings'
- $ref: '#/components/schemas/PingRequest'
- $ref: '#/components/schemas/RebootRequest'
- $ref: '#/components/schemas/NMSSettings'
- $ref: '#/components/schemas/Ieee8021xSettings'
- $ref: '#/components/schemas/GroupMatch'
- $ref: '#/components/schemas/LowpanPhySettings'
- $ref: '#/components/schemas/TransferRequest'
- $ref: '#/components/schemas/ImageBlock'
- $ref: '#/components/schemas/LoadRequest'
- $ref: '#/components/schemas/CancelLoadRequest'
- $ref: '#/components/schemas/SetBackupRequest'
- $ref: '#/components/schemas/SignatureValidity'
- $ref: '#/components/schemas/Signature'
- $ref: '#/components/schemas/SignatureSettings'
- $ref: '#/components/schemas/NetworkRole'
- $ref: '#/components/schemas/MplReset'
- $ref: '#/components/schemas/EventSubscribe'
TableTLVs:
description: |
Table TLVs. Note: whole table access AND individual index access is permitted.
anyOf:
- $ref: '#/components/schemas/HardwareDesc'
- $ref: '#/components/schemas/InterfaceDesc'
- $ref: '#/components/schemas/IPAddress'
- $ref: '#/components/schemas/IPRoute'
- $ref: '#/components/schemas/InterfaceMetrics'
- $ref: '#/components/schemas/IPRouteRPLMetrics'
- $ref: '#/components/schemas/Ieee802154BeaconStats'
- $ref: '#/components/schemas/RPLInstance'
- $ref: '#/components/schemas/FirmwareImageInfo'
- $ref: '#/components/schemas/NetStat'
- $ref: '#/components/schemas/CertBundle'
AllTLVs:
description: |
All CSMP defined TLVs.
This is used as an editorial starting point for the
other TLV collections defined within.
anyOf:
- $ref: '#/components/schemas/TlvIndex'
- $ref: '#/components/schemas/DeviceID'
- $ref: '#/components/schemas/NMSRedirectRequest'
- $ref: '#/components/schemas/SessionID'
- $ref: '#/components/schemas/DescriptionRequest'
- $ref: '#/components/schemas/HardwareDesc'
- $ref: '#/components/schemas/InterfaceDesc'
- $ref: '#/components/schemas/ReportSubscribe'
- $ref: '#/components/schemas/IPAddress'
- $ref: '#/components/schemas/IPRoute'
- $ref: '#/components/schemas/CurrentTime'
- $ref: '#/components/schemas/RPLSettings'
- $ref: '#/components/schemas/Uptime'
- $ref: '#/components/schemas/InterfaceMetrics'
- $ref: '#/components/schemas/IPRouteRPLMetrics'
- $ref: '#/components/schemas/PingRequest'
- $ref: '#/components/schemas/PingResponse'
- $ref: '#/components/schemas/RebootRequest'
- $ref: '#/components/schemas/Ieee8021xStatus'
- $ref: '#/components/schemas/Ieee80211iStatus'
- $ref: '#/components/schemas/WPANStatus'
- $ref: '#/components/schemas/DHCP6ClientStatus'
- $ref: '#/components/schemas/NMSSettings'
- $ref: '#/components/schemas/NMSStatus'
- $ref: '#/components/schemas/Ieee8021xSettings'
- $ref: '#/components/schemas/Ieee802154BeaconStats'
- $ref: '#/components/schemas/RPLInstance'
- $ref: '#/components/schemas/GroupAssign'
- $ref: '#/components/schemas/GroupEvict'
- $ref: '#/components/schemas/GroupMatch'
- $ref: '#/components/schemas/GroupInfo'
- $ref: '#/components/schemas/LowpanMacStats'
- $ref: '#/components/schemas/LowpanPhySettings'
- $ref: '#/components/schemas/TransferRequest'
- $ref: '#/components/schemas/ImageBlock'
- $ref: '#/components/schemas/LoadRequest'
- $ref: '#/components/schemas/CancelLoadRequest'
- $ref: '#/components/schemas/SetBackupRequest'
- $ref: '#/components/schemas/TransferResponse'
- $ref: '#/components/schemas/LoadResponse'
- $ref: '#/components/schemas/CancelLoadResponse'
- $ref: '#/components/schemas/SetBackupResponse'
- $ref: '#/components/schemas/FirmwareImageInfo'
- $ref: '#/components/schemas/SignatureValidity'
- $ref: '#/components/schemas/Signature'
- $ref: '#/components/schemas/SignatureSettings'
- $ref: '#/components/schemas/SysResetStats'
- $ref: '#/components/schemas/NetStat'
- $ref: '#/components/schemas/NetworkRole'
- $ref: '#/components/schemas/CertBundle'
- $ref: '#/components/schemas/MplStats'
- $ref: '#/components/schemas/MplReset'
- $ref: '#/components/schemas/RPLStats'
- $ref: '#/components/schemas/DHCP6Stats'
- $ref: '#/components/schemas/EventReport'
- $ref: '#/components/schemas/EventIndex'
- $ref: '#/components/schemas/EventSubscribe'
- $ref: '#/components/schemas/EventStats'
#
# Object placeholders to allow OpenAPI to compile.
# Each of these is authoritatively defined in
# the CSMP .proto file.
#
TlvIndex:
type: object
DeviceID:
type: object
NMSRedirectRequest:
type: object
SessionID:
type: object
DescriptionRequest:
type: object
HardwareDesc:
type: object
InterfaceDesc:
type: object
ReportSubscribe:
type: object
IPAddress:
type: object
IPRoute:
type: object
CurrentTime:
type: object
RPLSettings:
type: object
Uptime:
type: object
InterfaceMetrics:
type: object
IPRouteRPLMetrics:
type: object
PingRequest:
type: object
PingResponse:
type: object
RebootRequest:
type: object
Ieee8021xStatus:
type: object
Ieee80211iStatus:
type: object
WPANStatus:
type: object
DHCP6ClientStatus:
type: object
NMSSettings:
type: object
NMSStatus:
type: object
Ieee8021xSettings:
type: object
Ieee802154BeaconStats:
type: object
RPLInstance:
type: object
GroupAssign:
type: object
GroupEvict:
type: object
GroupMatch:
type: object
GroupInfo:
type: object
LowpanMacStats:
type: object
LowpanPhySettings:
type: object
TransferRequest:
type: object
ImageBlock:
type: object
LoadRequest:
type: object
CancelLoadRequest:
type: object
SetBackupRequest:
type: object
TransferResponse:
type: object
LoadResponse:
type: object
CancelLoadResponse:
type: object
SetBackupResponse:
type: object
FirmwareImageInfo:
type: object
SignatureValidity:
type: object
Signature:
type: object
SignatureSettings:
type: object
SysResetStats:
type: object
NetStat:
type: object
NetworkRole:
type: object
CertBundle:
type: object
MplStats:
type: object
MplReset:
type: object
RPLStats:
type: object
DHCP6Stats:
type: object
EventReport:
type: object
EventIndex:
type: object
EventSubscribe:
type: object
EventStats:
type: object