blob: 6727b2b947150603e384a9bd304746fa1f60409a [file] [log] [blame]
mpriyank6da95412023-06-29 16:56:11 +01001openapi: 3.0.3
niamhcorec1904c12021-10-11 16:38:53 +01002info:
niamhcorec1904c12021-10-11 16:38:53 +01003 description: NCMP Inventory API
mpriyank6da95412023-06-29 16:56:11 +01004 title: NCMP Inventory API
mpriyank205bd9f2024-12-03 16:14:53 +00005 version: 3.5.5
niamhcorec1904c12021-10-11 16:38:53 +01006servers:
mpriyank41c7d002023-08-22 13:17:46 +01007- url: /ncmpInventory
seanbeirne16e23582023-01-26 09:21:44 +00008security:
mpriyank41c7d002023-08-22 13:17:46 +01009- basicAuth: []
niamhcorec1904c12021-10-11 16:38:53 +010010paths:
11 /v1/ch:
12 post:
niamhcorec1904c12021-10-11 16:38:53 +010013 description: "Register a DMI Plugin with any new, updated or removed CM Handles."
14 operationId: updateDmiPluginRegistration
15 requestBody:
16 content:
17 application/json:
18 schema:
19 $ref: '#/components/schemas/RestDmiPluginRegistration'
20 required: true
21 responses:
emacleeafb17362022-09-02 14:40:17 +010022 "200":
niamhcorec1904c12021-10-11 16:38:53 +010023 content: {}
mpriyank6da95412023-06-29 16:56:11 +010024 description: No Content
niamhcorec1904c12021-10-11 16:38:53 +010025 "400":
niamhcorec1904c12021-10-11 16:38:53 +010026 content:
27 application/json:
DylanB95EST63132ce2021-12-14 16:34:38 +000028 example:
danielhanrahanad46c252024-05-01 11:25:36 +010029 status: 400
DylanB95EST63132ce2021-12-14 16:34:38 +000030 message: Bad request error message
31 details: Bad request error details
niamhcorec1904c12021-10-11 16:38:53 +010032 schema:
33 $ref: '#/components/schemas/ErrorMessage'
mpriyank6da95412023-06-29 16:56:11 +010034 description: Bad Request
mpriyank6da95412023-06-29 16:56:11 +010035 "403":
36 content:
37 application/json:
DylanB95EST63132ce2021-12-14 16:34:38 +000038 example:
39 status: 403
40 message: Forbidden error message
41 details: Forbidden error details
mpriyank6da95412023-06-29 16:56:11 +010042 schema:
43 $ref: '#/components/schemas/ErrorMessage'
44 description: Forbidden
DylanB95ESTe5573382022-01-27 17:12:52 +000045 "500":
mpriyank6da95412023-06-29 16:56:11 +010046 content:
47 application/json:
48 example:
49 failedCreatedCmHandles:
mpriyank41c7d002023-08-22 13:17:46 +010050 - cmHandle: my-cm-handle-01
51 errorCode: "00"
52 errorText: Unknown error. <error-details>
53 - cmHandle: my-cm-handle-02
54 errorCode: "01"
55 errorText: cm-handle already exists
56 - cmHandle: my-cm-handle-03
57 errorCode: "03"
58 errorText: cm-handle has an invalid character(s) in id
mpriyank6da95412023-06-29 16:56:11 +010059 failedUpdatedCmHandles:
mpriyank41c7d002023-08-22 13:17:46 +010060 - cmHandle: my-cm-handle-01
61 errorCode: "00"
62 errorText: Unknown error. <error-details>
63 - cmHandle: my-cm-handle-02
64 errorCode: "02"
65 errorText: cm-handle does not exist
66 - cmHandle: my-cm-handle-03
67 errorCode: "03"
68 errorText: cm-handle has an invalid character(s) in id
mpriyank6da95412023-06-29 16:56:11 +010069 failedRemovedCmHandles:
mpriyank41c7d002023-08-22 13:17:46 +010070 - cmHandle: my-cm-handle-01
71 errorCode: "00"
72 errorText: Unknown error. <error-details>
73 - cmHandle: my-cm-handle-02
74 errorCode: "02"
75 errorText: cm-handle does not exists
76 - cmHandle: my-cm-handle-03
77 errorCode: "03"
78 errorText: cm-handle has an invalid character(s) in id
mpriyank6da95412023-06-29 16:56:11 +010079 schema:
80 $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
emacleeafb17362022-09-02 14:40:17 +010081 description: Partial or Complete failure. The error details are provided
82 in the response body and all supported error codes are documented in the
83 example.
mpriyank6da95412023-06-29 16:56:11 +010084 summary: DMI notifies NCMP of new CM Handles
85 tags:
mpriyank41c7d002023-08-22 13:17:46 +010086 - network-cm-proxy-inventory
emacleeafb17362022-09-02 14:40:17 +010087 /v1/ch/cmHandles:
88 get:
seanbeirnec37dee42024-11-05 10:21:30 +000089 description: Get all cm handle references for a registered DMI plugin
90 operationId: getAllCmHandleReferencesForRegisteredDmi
emacleeafb17362022-09-02 14:40:17 +010091 parameters:
mpriyank41c7d002023-08-22 13:17:46 +010092 - description: dmi-plugin-identifier
93 in: query
94 name: dmi-plugin-identifier
95 required: true
96 schema:
97 example: my-dmi-plugin
98 type: string
seanbeirnec37dee42024-11-05 10:21:30 +000099 - description: Boolean parameter to determine if returned value(s) will be cm
seanbeirne90608182024-11-20 11:00:49 +0000100 handle ids or alternate ids for a given query
seanbeirnec37dee42024-11-05 10:21:30 +0000101 in: query
102 name: outputAlternateId
103 required: false
104 schema:
105 default: false
106 type: boolean
seanbeirne16e23582023-01-26 09:21:44 +0000107 responses:
108 "200":
seanbeirne16e23582023-01-26 09:21:44 +0000109 content:
110 application/json:
111 schema:
seanbeirne16e23582023-01-26 09:21:44 +0000112 items:
113 type: string
mpriyank6da95412023-06-29 16:56:11 +0100114 type: array
115 description: OK
mpriyank6da95412023-06-29 16:56:11 +0100116 "403":
117 content:
118 application/json:
seanbeirne16e23582023-01-26 09:21:44 +0000119 example:
120 status: 403
121 message: Forbidden error message
122 details: Forbidden error details
seanbeirne16e23582023-01-26 09:21:44 +0000123 schema:
124 $ref: '#/components/schemas/ErrorMessage'
mpriyank6da95412023-06-29 16:56:11 +0100125 description: Forbidden
126 "500":
127 content:
128 application/json:
seanbeirne16e23582023-01-26 09:21:44 +0000129 example:
130 status: 500
131 message: Internal Server Error
132 details: Internal Server Error occurred
mpriyank6da95412023-06-29 16:56:11 +0100133 schema:
134 $ref: '#/components/schemas/ErrorMessage'
135 description: Internal Server Error
seanbeirnec37dee42024-11-05 10:21:30 +0000136 summary: "Get all cm handle references for a registered DMI plugin (DMI plugin,\
137 \ DMI data plugin, DMI model plugin)"
mpriyank6da95412023-06-29 16:56:11 +0100138 tags:
mpriyank41c7d002023-08-22 13:17:46 +0100139 - network-cm-proxy-inventory
seanbeirne16e23582023-01-26 09:21:44 +0000140 /v1/ch/searches:
141 post:
seanbeirnec37dee42024-11-05 10:21:30 +0000142 description: "Query and get cm handle references for additional properties,\
143 \ public properties and registered DMI plugin (DMI plugin, DMI data plugin,\
144 \ DMI model plugin)."
seanbeirne16e23582023-01-26 09:21:44 +0000145 operationId: searchCmHandleIds
danielhanrahan8271b872024-10-25 16:28:17 +0100146 parameters:
seanbeirnea1a71f72024-10-21 16:18:27 +0100147 - description: Boolean parameter to determine if returned value(s) will be cm
seanbeirne90608182024-11-20 11:00:49 +0000148 handle ids or alternate ids for a given query
danielhanrahan8271b872024-10-25 16:28:17 +0100149 in: query
150 name: outputAlternateId
151 required: false
152 schema:
153 default: false
154 type: boolean
seanbeirne16e23582023-01-26 09:21:44 +0000155 requestBody:
156 content:
157 application/json:
158 schema:
159 $ref: '#/components/schemas/CmHandleQueryParameters'
bmiklos96d54ef2022-09-07 16:11:57 +0200160 required: true
emacleeafb17362022-09-02 14:40:17 +0100161 responses:
162 "200":
emacleeafb17362022-09-02 14:40:17 +0100163 content:
164 application/json:
165 schema:
emacleeafb17362022-09-02 14:40:17 +0100166 items:
167 type: string
mpriyank6da95412023-06-29 16:56:11 +0100168 type: array
169 description: OK
mpriyank6da95412023-06-29 16:56:11 +0100170 "403":
171 content:
172 application/json:
emacleeafb17362022-09-02 14:40:17 +0100173 example:
174 status: 403
175 message: Forbidden error message
176 details: Forbidden error details
DylanB95ESTe5573382022-01-27 17:12:52 +0000177 schema:
178 $ref: '#/components/schemas/ErrorMessage'
mpriyank6da95412023-06-29 16:56:11 +0100179 description: Forbidden
180 "500":
181 content:
182 application/json:
DylanB95ESTe5573382022-01-27 17:12:52 +0000183 example:
184 status: 500
185 message: Internal Server Error
186 details: Internal Server Error occurred
mpriyank6da95412023-06-29 16:56:11 +0100187 schema:
188 $ref: '#/components/schemas/ErrorMessage'
189 description: Internal Server Error
190 summary: Query for CM Handle IDs
191 tags:
mpriyank41c7d002023-08-22 13:17:46 +0100192 - network-cm-proxy-inventory
niamhcorec1904c12021-10-11 16:38:53 +0100193components:
mpriyank6da95412023-06-29 16:56:11 +0100194 parameters:
195 dmiPluginIdentifierInQuery:
196 description: dmi-plugin-identifier
197 in: query
198 name: dmi-plugin-identifier
199 required: true
200 schema:
201 example: my-dmi-plugin
202 type: string
danielhanrahan8271b872024-10-25 16:28:17 +0100203 outputAlternateIdOptionInQuery:
seanbeirnec37dee42024-11-05 10:21:30 +0000204 description: Boolean parameter to determine if returned value(s) will be cm
seanbeirne90608182024-11-20 11:00:49 +0000205 handle ids or alternate ids for a given query
danielhanrahan8271b872024-10-25 16:28:17 +0100206 in: query
207 name: outputAlternateId
208 required: false
209 schema:
210 default: false
211 type: boolean
mpriyank6da95412023-06-29 16:56:11 +0100212 responses:
213 NoContent:
214 content: {}
215 description: No Content
216 BadRequest:
217 content:
218 application/json:
219 example:
danielhanrahanad46c252024-05-01 11:25:36 +0100220 status: 400
mpriyank6da95412023-06-29 16:56:11 +0100221 message: Bad request error message
222 details: Bad request error details
223 schema:
224 $ref: '#/components/schemas/ErrorMessage'
225 description: Bad Request
mpriyank6da95412023-06-29 16:56:11 +0100226 Forbidden:
227 content:
228 application/json:
229 example:
230 status: 403
231 message: Forbidden error message
232 details: Forbidden error details
233 schema:
234 $ref: '#/components/schemas/ErrorMessage'
235 description: Forbidden
236 InternalServerError:
237 content:
238 application/json:
239 example:
240 status: 500
241 message: Internal Server Error
242 details: Internal Server Error occurred
243 schema:
244 $ref: '#/components/schemas/ErrorMessage'
245 description: Internal Server Error
niamhcorec1904c12021-10-11 16:38:53 +0100246 schemas:
247 RestDmiPluginRegistration:
mpriyank6da95412023-06-29 16:56:11 +0100248 example:
niamhcorec1904c12021-10-11 16:38:53 +0100249 updatedCmHandles:
mpriyank41c7d002023-08-22 13:17:46 +0100250 - cmHandle: my-cm-handle
danielhanrahan3e14d392023-12-20 13:31:07 +0000251 alternateId: my-alternate-id
JvD_Ericssone14fe9a2024-02-26 13:45:47 +0000252 dataProducerIdentifier: my-data-producer-identifier
mpriyank41c7d002023-08-22 13:17:46 +0100253 publicCmHandleProperties:
254 key: my-property
255 cmHandleProperties:
256 key: my-property
danielhanrahanc3e7b0e2023-09-20 15:01:59 +0100257 moduleSetTag: my-module-set-tag
mpriyankd74c2d22023-11-06 13:25:38 +0000258 trustLevel: COMPLETE
mpriyank41c7d002023-08-22 13:17:46 +0100259 - cmHandle: my-cm-handle
danielhanrahan3e14d392023-12-20 13:31:07 +0000260 alternateId: my-alternate-id
JvD_Ericssone14fe9a2024-02-26 13:45:47 +0000261 dataProducerIdentifier: my-data-producer-identifier
mpriyank41c7d002023-08-22 13:17:46 +0100262 publicCmHandleProperties:
263 key: my-property
264 cmHandleProperties:
265 key: my-property
danielhanrahanc3e7b0e2023-09-20 15:01:59 +0100266 moduleSetTag: my-module-set-tag
mpriyankd74c2d22023-11-06 13:25:38 +0000267 trustLevel: COMPLETE
mpriyank6da95412023-06-29 16:56:11 +0100268 createdCmHandles:
mpriyank41c7d002023-08-22 13:17:46 +0100269 - cmHandle: my-cm-handle
danielhanrahan3e14d392023-12-20 13:31:07 +0000270 alternateId: my-alternate-id
JvD_Ericssone14fe9a2024-02-26 13:45:47 +0000271 dataProducerIdentifier: my-data-producer-identifier
mpriyank41c7d002023-08-22 13:17:46 +0100272 publicCmHandleProperties:
273 key: my-property
274 cmHandleProperties:
275 key: my-property
danielhanrahanc3e7b0e2023-09-20 15:01:59 +0100276 moduleSetTag: my-module-set-tag
mpriyankd74c2d22023-11-06 13:25:38 +0000277 trustLevel: COMPLETE
mpriyank41c7d002023-08-22 13:17:46 +0100278 - cmHandle: my-cm-handle
danielhanrahan3e14d392023-12-20 13:31:07 +0000279 alternateId: my-alternate-id
JvD_Ericssone14fe9a2024-02-26 13:45:47 +0000280 dataProducerIdentifier: my-data-producer-identifier
mpriyank41c7d002023-08-22 13:17:46 +0100281 publicCmHandleProperties:
282 key: my-property
283 cmHandleProperties:
284 key: my-property
danielhanrahanc3e7b0e2023-09-20 15:01:59 +0100285 moduleSetTag: my-module-set-tag
mpriyankd74c2d22023-11-06 13:25:38 +0000286 trustLevel: COMPLETE
mpriyank6da95412023-06-29 16:56:11 +0100287 dmiPlugin: my-dmi-plugin
288 dmiModelPlugin: my-dmi-model-plugin
egernugfb09b7c2023-10-12 13:33:08 +0100289 upgradedCmHandles:
290 cmHandles:
291 - my-cm-handle1
292 - my-cm-handle2
293 - my-cm-handle3
294 moduleSetTag: my-module-set-tag
mpriyank6da95412023-06-29 16:56:11 +0100295 dmiDataPlugin: my-dmi-data-plugin
niamhcorec1904c12021-10-11 16:38:53 +0100296 removedCmHandles:
mpriyank41c7d002023-08-22 13:17:46 +0100297 - my-cm-handle1
298 - my-cm-handle2
299 - my-cm-handle3
mpriyank6da95412023-06-29 16:56:11 +0100300 properties:
301 dmiPlugin:
302 default: ""
303 example: my-dmi-plugin
304 type: string
305 dmiDataPlugin:
306 default: ""
307 example: my-dmi-data-plugin
308 type: string
309 dmiModelPlugin:
310 default: ""
311 example: my-dmi-model-plugin
312 type: string
313 createdCmHandles:
314 items:
315 $ref: '#/components/schemas/RestInputCmHandle'
316 type: array
317 updatedCmHandles:
318 items:
319 $ref: '#/components/schemas/RestInputCmHandle'
320 type: array
321 removedCmHandles:
322 example:
mpriyank41c7d002023-08-22 13:17:46 +0100323 - my-cm-handle1
324 - my-cm-handle2
325 - my-cm-handle3
niamhcorec1904c12021-10-11 16:38:53 +0100326 items:
327 type: string
mpriyank6da95412023-06-29 16:56:11 +0100328 type: array
egernugfb09b7c2023-10-12 13:33:08 +0100329 upgradedCmHandles:
330 $ref: '#/components/schemas/UpgradedCmHandles'
niamhcorec1904c12021-10-11 16:38:53 +0100331 type: object
mpriyank6da95412023-06-29 16:56:11 +0100332 RestInputCmHandle:
333 example:
334 cmHandle: my-cm-handle
danielhanrahan3e14d392023-12-20 13:31:07 +0000335 alternateId: my-alternate-id
JvD_Ericssone14fe9a2024-02-26 13:45:47 +0000336 dataProducerIdentifier: my-data-producer-identifier
mpriyank6da95412023-06-29 16:56:11 +0100337 publicCmHandleProperties:
338 key: my-property
339 cmHandleProperties:
340 key: my-property
danielhanrahanc3e7b0e2023-09-20 15:01:59 +0100341 moduleSetTag: my-module-set-tag
mpriyankd74c2d22023-11-06 13:25:38 +0000342 trustLevel: COMPLETE
niamhcorec1904c12021-10-11 16:38:53 +0100343 properties:
344 cmHandle:
DylanB95EST63132ce2021-12-14 16:34:38 +0000345 example: my-cm-handle
mpriyank6da95412023-06-29 16:56:11 +0100346 type: string
niamhcorec1904c12021-10-11 16:38:53 +0100347 cmHandleProperties:
mpriyank6da95412023-06-29 16:56:11 +0100348 additionalProperties:
349 example: my-property
350 type: string
351 type: object
DylanB95EST63132ce2021-12-14 16:34:38 +0000352 publicCmHandleProperties:
mpriyank6da95412023-06-29 16:56:11 +0100353 additionalProperties:
354 example: my-property
355 type: string
356 type: object
danielhanrahanc3e7b0e2023-09-20 15:01:59 +0100357 moduleSetTag:
358 example: my-module-set-tag
359 type: string
mpriyankd74c2d22023-11-06 13:25:38 +0000360 trustLevel:
361 enum:
362 - COMPLETE
363 - NONE
364 example: COMPLETE
365 type: string
danielhanrahan3e14d392023-12-20 13:31:07 +0000366 alternateId:
367 example: my-alternate-id
368 type: string
JvD_Ericssone14fe9a2024-02-26 13:45:47 +0000369 dataProducerIdentifier:
370 example: my-data-producer-identifier
371 type: string
mpriyank6da95412023-06-29 16:56:11 +0100372 required:
mpriyank41c7d002023-08-22 13:17:46 +0100373 - cmHandle
mpriyank6da95412023-06-29 16:56:11 +0100374 type: object
DylanB95EST63132ce2021-12-14 16:34:38 +0000375 RestCmHandleProperties:
niamhcorec1904c12021-10-11 16:38:53 +0100376 additionalProperties:
DylanB95EST63132ce2021-12-14 16:34:38 +0000377 example: my-property
mpriyank6da95412023-06-29 16:56:11 +0100378 type: string
niamhcorec1904c12021-10-11 16:38:53 +0100379 type: object
egernugfb09b7c2023-10-12 13:33:08 +0100380 UpgradedCmHandles:
381 example:
382 cmHandles:
383 - my-cm-handle1
384 - my-cm-handle2
385 - my-cm-handle3
386 moduleSetTag: my-module-set-tag
387 properties:
388 cmHandles:
389 example:
390 - my-cm-handle1
391 - my-cm-handle2
392 - my-cm-handle3
393 items:
394 type: string
395 type: array
396 moduleSetTag:
danielhanrahan3e14d392023-12-20 13:31:07 +0000397 default: ""
egernugfb09b7c2023-10-12 13:33:08 +0100398 example: my-module-set-tag
399 type: string
400 required:
401 - cmHandles
402 type: object
mpriyank6da95412023-06-29 16:56:11 +0100403 ErrorMessage:
niamhcorec1904c12021-10-11 16:38:53 +0100404 properties:
405 status:
406 type: string
407 message:
408 type: string
409 details:
410 type: string
mpriyank6da95412023-06-29 16:56:11 +0100411 title: Error
emacleeafb17362022-09-02 14:40:17 +0100412 type: object
mpriyank6da95412023-06-29 16:56:11 +0100413 DmiPluginRegistrationErrorResponse:
emacleeafb17362022-09-02 14:40:17 +0100414 properties:
415 failedCreatedCmHandles:
emacleeafb17362022-09-02 14:40:17 +0100416 items:
417 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
mpriyank6da95412023-06-29 16:56:11 +0100418 type: array
emacleeafb17362022-09-02 14:40:17 +0100419 failedUpdatedCmHandles:
emacleeafb17362022-09-02 14:40:17 +0100420 items:
421 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
mpriyank6da95412023-06-29 16:56:11 +0100422 type: array
emacleeafb17362022-09-02 14:40:17 +0100423 failedRemovedCmHandles:
emacleeafb17362022-09-02 14:40:17 +0100424 items:
425 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
mpriyank6da95412023-06-29 16:56:11 +0100426 type: array
egernugfb09b7c2023-10-12 13:33:08 +0100427 failedUpgradeCmHandles:
428 items:
429 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
430 type: array
emacleeafb17362022-09-02 14:40:17 +0100431 type: object
mpriyank6da95412023-06-29 16:56:11 +0100432 CmHandlerRegistrationErrorResponse:
emacleeafb17362022-09-02 14:40:17 +0100433 properties:
434 cmHandle:
emacleeafb17362022-09-02 14:40:17 +0100435 example: my-cm-handle
mpriyank6da95412023-06-29 16:56:11 +0100436 type: string
emacleeafb17362022-09-02 14:40:17 +0100437 errorCode:
emacleeafb17362022-09-02 14:40:17 +0100438 example: "00"
emacleeafb17362022-09-02 14:40:17 +0100439 type: string
mpriyank6da95412023-06-29 16:56:11 +0100440 errorText:
emacleeafb17362022-09-02 14:40:17 +0100441 example: Unknown error. <error-details>
mpriyank6da95412023-06-29 16:56:11 +0100442 type: string
seanbeirne16e23582023-01-26 09:21:44 +0000443 type: object
mpriyank6da95412023-06-29 16:56:11 +0100444 CmHandleQueryParameters:
445 example:
446 cmHandleQueryParameters:
mpriyank41c7d002023-08-22 13:17:46 +0100447 - conditionParameters:
448 - key: conditionParameters
449 - key: conditionParameters
450 conditionName: conditionName
451 - conditionParameters:
452 - key: conditionParameters
453 - key: conditionParameters
454 conditionName: conditionName
mpriyank6da95412023-06-29 16:56:11 +0100455 conditions:
mpriyank41c7d002023-08-22 13:17:46 +0100456 - name: name
457 conditionParameters:
458 - moduleName: my-module
459 - moduleName: my-module
460 - name: name
461 conditionParameters:
462 - moduleName: my-module
463 - moduleName: my-module
seanbeirne16e23582023-01-26 09:21:44 +0000464 properties:
465 cmHandleQueryParameters:
seanbeirne16e23582023-01-26 09:21:44 +0000466 items:
467 $ref: '#/components/schemas/ConditionProperties'
seanbeirne16e23582023-01-26 09:21:44 +0000468 type: array
mpriyank6da95412023-06-29 16:56:11 +0100469 conditions:
seanbeirne16e23582023-01-26 09:21:44 +0000470 deprecated: true
mpriyank6da95412023-06-29 16:56:11 +0100471 description: "not necessary, it is just for backward compatibility"
seanbeirne16e23582023-01-26 09:21:44 +0000472 items:
473 $ref: '#/components/schemas/OldConditionProperties'
mpriyank6da95412023-06-29 16:56:11 +0100474 type: array
475 title: Cm Handle query parameters for executing cm handle search
476 type: object
seanbeirne16e23582023-01-26 09:21:44 +0000477 ConditionProperties:
mpriyank6da95412023-06-29 16:56:11 +0100478 example:
479 conditionParameters:
mpriyank41c7d002023-08-22 13:17:46 +0100480 - key: conditionParameters
481 - key: conditionParameters
mpriyank6da95412023-06-29 16:56:11 +0100482 conditionName: conditionName
seanbeirne16e23582023-01-26 09:21:44 +0000483 properties:
484 conditionName:
485 type: string
486 conditionParameters:
seanbeirne16e23582023-01-26 09:21:44 +0000487 items:
seanbeirne16e23582023-01-26 09:21:44 +0000488 additionalProperties:
489 type: string
mpriyank6da95412023-06-29 16:56:11 +0100490 type: object
491 type: array
seanbeirne16e23582023-01-26 09:21:44 +0000492 OldConditionProperties:
mpriyank6da95412023-06-29 16:56:11 +0100493 deprecated: true
494 example:
495 name: name
496 conditionParameters:
mpriyank41c7d002023-08-22 13:17:46 +0100497 - moduleName: my-module
498 - moduleName: my-module
seanbeirne16e23582023-01-26 09:21:44 +0000499 properties:
500 name:
501 type: string
502 conditionParameters:
seanbeirne16e23582023-01-26 09:21:44 +0000503 items:
504 $ref: '#/components/schemas/ModuleNameAsJsonObject'
mpriyank6da95412023-06-29 16:56:11 +0100505 type: array
seanbeirne16e23582023-01-26 09:21:44 +0000506 ModuleNameAsJsonObject:
mpriyank6da95412023-06-29 16:56:11 +0100507 example:
508 moduleName: my-module
seanbeirne16e23582023-01-26 09:21:44 +0000509 properties:
510 moduleName:
seanbeirne16e23582023-01-26 09:21:44 +0000511 example: my-module
mpriyank6da95412023-06-29 16:56:11 +0100512 type: string
seanbeirne16e23582023-01-26 09:21:44 +0000513 securitySchemes:
514 basicAuth:
seanbeirne16e23582023-01-26 09:21:44 +0000515 scheme: basic
mpriyank6da95412023-06-29 16:56:11 +0100516 type: http