blob: af6b004b1ba93c63f816ba3fa84a5c21ca15cc71 (
plain)
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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
openapi: 3.0.3
info:
description: NCMP Inventory API
title: NCMP Inventory API
version: "1.0"
servers:
- url: /ncmpInventory
security:
- basicAuth: []
paths:
/v1/ch:
post:
description: "Register a DMI Plugin with any new, updated or removed CM Handles."
operationId: updateDmiPluginRegistration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestDmiPluginRegistration'
required: true
responses:
"200":
content: {}
description: No Content
"400":
content:
application/json:
example:
status: 400 BAD_REQUEST
message: Bad request error message
details: Bad request error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Bad Request
"401":
content:
application/json:
example:
status: 401
message: Unauthorized error message
details: Unauthorized error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Unauthorized
"403":
content:
application/json:
example:
status: 403
message: Forbidden error message
details: Forbidden error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Forbidden
"500":
content:
application/json:
example:
failedCreatedCmHandles:
- cmHandle: my-cm-handle-01
errorCode: "00"
errorText: Unknown error. <error-details>
- cmHandle: my-cm-handle-02
errorCode: "01"
errorText: cm-handle already exists
- cmHandle: my-cm-handle-03
errorCode: "03"
errorText: cm-handle has an invalid character(s) in id
failedUpdatedCmHandles:
- cmHandle: my-cm-handle-01
errorCode: "00"
errorText: Unknown error. <error-details>
- cmHandle: my-cm-handle-02
errorCode: "02"
errorText: cm-handle does not exist
- cmHandle: my-cm-handle-03
errorCode: "03"
errorText: cm-handle has an invalid character(s) in id
failedRemovedCmHandles:
- cmHandle: my-cm-handle-01
errorCode: "00"
errorText: Unknown error. <error-details>
- cmHandle: my-cm-handle-02
errorCode: "02"
errorText: cm-handle does not exists
- cmHandle: my-cm-handle-03
errorCode: "03"
errorText: cm-handle has an invalid character(s) in id
schema:
$ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
description: Partial or Complete failure. The error details are provided
in the response body and all supported error codes are documented in the
example.
summary: DMI notifies NCMP of new CM Handles
tags:
- network-cm-proxy-inventory
/v1/ch/cmHandles:
get:
description: Get all cm handle IDs for a registered DMI plugin
operationId: getAllCmHandleIdsForRegisteredDmi
parameters:
- description: dmi-plugin-identifier
in: query
name: dmi-plugin-identifier
required: true
schema:
example: my-dmi-plugin
type: string
responses:
"200":
content:
application/json:
schema:
items:
type: string
type: array
description: OK
"401":
content:
application/json:
example:
status: 401
message: Unauthorized error message
details: Unauthorized error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Unauthorized
"403":
content:
application/json:
example:
status: 403
message: Forbidden error message
details: Forbidden error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Forbidden
"500":
content:
application/json:
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Internal Server Error
summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
\ data plugin, DMI model plugin)"
tags:
- network-cm-proxy-inventory
/v1/ch/searches:
post:
description: "Query and get CMHandleIds for additional properties, public properties\
\ and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)."
operationId: searchCmHandleIds
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CmHandleQueryParameters'
required: true
responses:
"200":
content:
application/json:
schema:
items:
type: string
type: array
description: OK
"401":
content:
application/json:
example:
status: 401
message: Unauthorized error message
details: Unauthorized error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Unauthorized
"403":
content:
application/json:
example:
status: 403
message: Forbidden error message
details: Forbidden error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Forbidden
"500":
content:
application/json:
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Internal Server Error
summary: Query for CM Handle IDs
tags:
- network-cm-proxy-inventory
components:
parameters:
dmiPluginIdentifierInQuery:
description: dmi-plugin-identifier
in: query
name: dmi-plugin-identifier
required: true
schema:
example: my-dmi-plugin
type: string
responses:
NoContent:
content: {}
description: No Content
BadRequest:
content:
application/json:
example:
status: 400 BAD_REQUEST
message: Bad request error message
details: Bad request error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Bad Request
Unauthorized:
content:
application/json:
example:
status: 401
message: Unauthorized error message
details: Unauthorized error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Unauthorized
Forbidden:
content:
application/json:
example:
status: 403
message: Forbidden error message
details: Forbidden error details
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Forbidden
InternalServerError:
content:
application/json:
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Internal Server Error
schemas:
RestDmiPluginRegistration:
example:
updatedCmHandles:
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
moduleSetTag: my-module-set-tag
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
moduleSetTag: my-module-set-tag
createdCmHandles:
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
moduleSetTag: my-module-set-tag
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
moduleSetTag: my-module-set-tag
dmiPlugin: my-dmi-plugin
dmiModelPlugin: my-dmi-model-plugin
dmiDataPlugin: my-dmi-data-plugin
removedCmHandles:
- my-cm-handle1
- my-cm-handle2
- my-cm-handle3
properties:
dmiPlugin:
default: ""
example: my-dmi-plugin
type: string
dmiDataPlugin:
default: ""
example: my-dmi-data-plugin
type: string
dmiModelPlugin:
default: ""
example: my-dmi-model-plugin
type: string
createdCmHandles:
items:
$ref: '#/components/schemas/RestInputCmHandle'
type: array
updatedCmHandles:
items:
$ref: '#/components/schemas/RestInputCmHandle'
type: array
removedCmHandles:
example:
- my-cm-handle1
- my-cm-handle2
- my-cm-handle3
items:
type: string
type: array
type: object
RestInputCmHandle:
example:
cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
moduleSetTag: my-module-set-tag
properties:
cmHandle:
example: my-cm-handle
type: string
cmHandleProperties:
additionalProperties:
example: my-property
type: string
type: object
publicCmHandleProperties:
additionalProperties:
example: my-property
type: string
type: object
moduleSetTag:
example: my-module-set-tag
type: string
required:
- cmHandle
type: object
RestCmHandleProperties:
additionalProperties:
example: my-property
type: string
type: object
ErrorMessage:
properties:
status:
type: string
message:
type: string
details:
type: string
title: Error
type: object
DmiPluginRegistrationErrorResponse:
properties:
failedCreatedCmHandles:
items:
$ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
type: array
failedUpdatedCmHandles:
items:
$ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
type: array
failedRemovedCmHandles:
items:
$ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
type: array
type: object
CmHandlerRegistrationErrorResponse:
properties:
cmHandle:
example: my-cm-handle
type: string
errorCode:
example: "00"
type: string
errorText:
example: Unknown error. <error-details>
type: string
type: object
CmHandleQueryParameters:
example:
cmHandleQueryParameters:
- conditionParameters:
- key: conditionParameters
- key: conditionParameters
conditionName: conditionName
- conditionParameters:
- key: conditionParameters
- key: conditionParameters
conditionName: conditionName
conditions:
- name: name
conditionParameters:
- moduleName: my-module
- moduleName: my-module
- name: name
conditionParameters:
- moduleName: my-module
- moduleName: my-module
properties:
cmHandleQueryParameters:
items:
$ref: '#/components/schemas/ConditionProperties'
type: array
conditions:
deprecated: true
description: "not necessary, it is just for backward compatibility"
items:
$ref: '#/components/schemas/OldConditionProperties'
type: array
title: Cm Handle query parameters for executing cm handle search
type: object
ConditionProperties:
example:
conditionParameters:
- key: conditionParameters
- key: conditionParameters
conditionName: conditionName
properties:
conditionName:
type: string
conditionParameters:
items:
additionalProperties:
type: string
type: object
type: array
OldConditionProperties:
deprecated: true
example:
name: name
conditionParameters:
- moduleName: my-module
- moduleName: my-module
properties:
name:
type: string
conditionParameters:
items:
$ref: '#/components/schemas/ModuleNameAsJsonObject'
type: array
ModuleNameAsJsonObject:
example:
moduleName: my-module
properties:
moduleName:
example: my-module
type: string
securitySchemes:
basicAuth:
scheme: basic
type: http
|
