blob: 3bf93a1e54346b82de0987531f3abe29102d6022 (
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
|
openapi: 3.0.1
info:
title: NCMP Inventory API
description: NCMP Inventory API
version: "1.0"
servers:
- url: /ncmpInventory
security:
- basicAuth: []
paths:
/v1/ch:
post:
tags:
- network-cm-proxy-inventory
summary: DMI notifies NCMP of new CM Handles
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":
description: No Content
content: {}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400 BAD_REQUEST
message: Bad request error message
details: Bad request error details
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized error message
details: Unauthorized error details
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Forbidden error message
details: Forbidden error details
"500":
description: Partial or Complete failure. The error details are provided
in the response body and all supported error codes are documented in the
example.
content:
application/json:
schema:
$ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
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
/v1/ch/cmHandles:
get:
tags:
- network-cm-proxy-inventory
summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
\ data plugin, DMI model plugin)"
description: Get all cm handle IDs for a registered DMI plugin
operationId: getAllCmHandleIdsForRegisteredDmi
parameters:
- name: dmi-plugin-identifier
in: query
description: dmi-plugin-identifier
required: true
schema:
type: string
example: my-dmi-plugin
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: string
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized error message
details: Unauthorized error details
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Forbidden error message
details: Forbidden error details
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/v1/ch/searches:
post:
tags:
- network-cm-proxy-inventory
summary: Query for CM Handle IDs
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":
description: OK
content:
application/json:
schema:
type: array
items:
type: string
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized error message
details: Unauthorized error details
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Forbidden error message
details: Forbidden error details
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
components:
schemas:
RestDmiPluginRegistration:
type: object
properties:
dmiPlugin:
type: string
example: my-dmi-plugin
default: ""
dmiDataPlugin:
type: string
example: my-dmi-data-plugin
default: ""
dmiModelPlugin:
type: string
example: my-dmi-model-plugin
default: ""
createdCmHandles:
type: array
items:
$ref: '#/components/schemas/RestInputCmHandle'
updatedCmHandles:
type: array
items:
$ref: '#/components/schemas/RestInputCmHandle'
removedCmHandles:
type: array
example:
- my-cm-handle1
- my-cm-handle2
- my-cm-handle3
items:
type: string
RestInputCmHandle:
required:
- cmHandle
type: object
properties:
cmHandle:
type: string
example: my-cm-handle
cmHandleProperties:
$ref: '#/components/schemas/RestCmHandleProperties'
publicCmHandleProperties:
$ref: '#/components/schemas/RestCmHandleProperties'
RestCmHandleProperties:
type: object
additionalProperties:
type: string
example: my-property
ErrorMessage:
title: Error
type: object
properties:
status:
type: string
message:
type: string
details:
type: string
DmiPluginRegistrationErrorResponse:
type: object
properties:
failedCreatedCmHandles:
type: array
items:
$ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
failedUpdatedCmHandles:
type: array
items:
$ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
failedRemovedCmHandles:
type: array
items:
$ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
CmHandlerRegistrationErrorResponse:
type: object
properties:
cmHandle:
type: string
example: my-cm-handle
errorCode:
type: string
example: "00"
errorText:
type: string
example: Unknown error. <error-details>
CmHandleQueryParameters:
title: Cm Handle query parameters for executing cm handle search
type: object
properties:
cmHandleQueryParameters:
type: array
items:
$ref: '#/components/schemas/ConditionProperties'
conditions:
type: array
description: "not necessary, it is just for backward compatibility"
deprecated: true
items:
$ref: '#/components/schemas/OldConditionProperties'
ConditionProperties:
properties:
conditionName:
type: string
conditionParameters:
type: array
items:
type: object
additionalProperties:
type: string
OldConditionProperties:
properties:
name:
type: string
conditionParameters:
type: array
items:
$ref: '#/components/schemas/ModuleNameAsJsonObject'
deprecated: true
ModuleNameAsJsonObject:
properties:
moduleName:
type: string
example: my-module
securitySchemes:
basicAuth:
type: http
scheme: basic
|
