mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 1 | openapi: 3.0.3 |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 2 | info: |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 3 | description: NCMP Inventory API |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 4 | title: NCMP Inventory API |
mpriyank | 205bd9f | 2024-12-03 16:14:53 +0000 | [diff] [blame^] | 5 | version: 3.5.5 |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 6 | servers: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 7 | - url: /ncmpInventory |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 8 | security: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 9 | - basicAuth: [] |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 10 | paths: |
11 | /v1/ch: | ||||
12 | post: | ||||
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 13 | 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: | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 22 | "200": |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 23 | content: {} |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 24 | description: No Content |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 25 | "400": |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 26 | content: |
27 | application/json: | ||||
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 28 | example: |
danielhanrahan | ad46c25 | 2024-05-01 11:25:36 +0100 | [diff] [blame] | 29 | status: 400 |
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 30 | message: Bad request error message |
31 | details: Bad request error details | ||||
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 32 | schema: |
33 | $ref: '#/components/schemas/ErrorMessage' | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 34 | description: Bad Request |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 35 | "403": |
36 | content: | ||||
37 | application/json: | ||||
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 38 | example: |
39 | status: 403 | ||||
40 | message: Forbidden error message | ||||
41 | details: Forbidden error details | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 42 | schema: |
43 | $ref: '#/components/schemas/ErrorMessage' | ||||
44 | description: Forbidden | ||||
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 45 | "500": |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 46 | content: |
47 | application/json: | ||||
48 | example: | ||||
49 | failedCreatedCmHandles: | ||||
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 50 | - 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 | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 59 | failedUpdatedCmHandles: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 60 | - 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 | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 69 | failedRemovedCmHandles: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 70 | - 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 | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 79 | schema: |
80 | $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse' | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 81 | 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. | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 84 | summary: DMI notifies NCMP of new CM Handles |
85 | tags: | ||||
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 86 | - network-cm-proxy-inventory |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 87 | /v1/ch/cmHandles: |
88 | get: | ||||
seanbeirne | c37dee4 | 2024-11-05 10:21:30 +0000 | [diff] [blame] | 89 | description: Get all cm handle references for a registered DMI plugin |
90 | operationId: getAllCmHandleReferencesForRegisteredDmi | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 91 | parameters: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 92 | - 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 | ||||
seanbeirne | c37dee4 | 2024-11-05 10:21:30 +0000 | [diff] [blame] | 99 | - description: Boolean parameter to determine if returned value(s) will be cm |
seanbeirne | 9060818 | 2024-11-20 11:00:49 +0000 | [diff] [blame] | 100 | handle ids or alternate ids for a given query |
seanbeirne | c37dee4 | 2024-11-05 10:21:30 +0000 | [diff] [blame] | 101 | in: query |
102 | name: outputAlternateId | ||||
103 | required: false | ||||
104 | schema: | ||||
105 | default: false | ||||
106 | type: boolean | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 107 | responses: |
108 | "200": | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 109 | content: |
110 | application/json: | ||||
111 | schema: | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 112 | items: |
113 | type: string | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 114 | type: array |
115 | description: OK | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 116 | "403": |
117 | content: | ||||
118 | application/json: | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 119 | example: |
120 | status: 403 | ||||
121 | message: Forbidden error message | ||||
122 | details: Forbidden error details | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 123 | schema: |
124 | $ref: '#/components/schemas/ErrorMessage' | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 125 | description: Forbidden |
126 | "500": | ||||
127 | content: | ||||
128 | application/json: | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 129 | example: |
130 | status: 500 | ||||
131 | message: Internal Server Error | ||||
132 | details: Internal Server Error occurred | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 133 | schema: |
134 | $ref: '#/components/schemas/ErrorMessage' | ||||
135 | description: Internal Server Error | ||||
seanbeirne | c37dee4 | 2024-11-05 10:21:30 +0000 | [diff] [blame] | 136 | summary: "Get all cm handle references for a registered DMI plugin (DMI plugin,\ |
137 | \ DMI data plugin, DMI model plugin)" | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 138 | tags: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 139 | - network-cm-proxy-inventory |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 140 | /v1/ch/searches: |
141 | post: | ||||
seanbeirne | c37dee4 | 2024-11-05 10:21:30 +0000 | [diff] [blame] | 142 | 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)." | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 145 | operationId: searchCmHandleIds |
danielhanrahan | 8271b87 | 2024-10-25 16:28:17 +0100 | [diff] [blame] | 146 | parameters: |
seanbeirne | a1a71f7 | 2024-10-21 16:18:27 +0100 | [diff] [blame] | 147 | - description: Boolean parameter to determine if returned value(s) will be cm |
seanbeirne | 9060818 | 2024-11-20 11:00:49 +0000 | [diff] [blame] | 148 | handle ids or alternate ids for a given query |
danielhanrahan | 8271b87 | 2024-10-25 16:28:17 +0100 | [diff] [blame] | 149 | in: query |
150 | name: outputAlternateId | ||||
151 | required: false | ||||
152 | schema: | ||||
153 | default: false | ||||
154 | type: boolean | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 155 | requestBody: |
156 | content: | ||||
157 | application/json: | ||||
158 | schema: | ||||
159 | $ref: '#/components/schemas/CmHandleQueryParameters' | ||||
bmiklos | 96d54ef | 2022-09-07 16:11:57 +0200 | [diff] [blame] | 160 | required: true |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 161 | responses: |
162 | "200": | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 163 | content: |
164 | application/json: | ||||
165 | schema: | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 166 | items: |
167 | type: string | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 168 | type: array |
169 | description: OK | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 170 | "403": |
171 | content: | ||||
172 | application/json: | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 173 | example: |
174 | status: 403 | ||||
175 | message: Forbidden error message | ||||
176 | details: Forbidden error details | ||||
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 177 | schema: |
178 | $ref: '#/components/schemas/ErrorMessage' | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 179 | description: Forbidden |
180 | "500": | ||||
181 | content: | ||||
182 | application/json: | ||||
DylanB95EST | e557338 | 2022-01-27 17:12:52 +0000 | [diff] [blame] | 183 | example: |
184 | status: 500 | ||||
185 | message: Internal Server Error | ||||
186 | details: Internal Server Error occurred | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 187 | schema: |
188 | $ref: '#/components/schemas/ErrorMessage' | ||||
189 | description: Internal Server Error | ||||
190 | summary: Query for CM Handle IDs | ||||
191 | tags: | ||||
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 192 | - network-cm-proxy-inventory |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 193 | components: |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 194 | 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 | ||||
danielhanrahan | 8271b87 | 2024-10-25 16:28:17 +0100 | [diff] [blame] | 203 | outputAlternateIdOptionInQuery: |
seanbeirne | c37dee4 | 2024-11-05 10:21:30 +0000 | [diff] [blame] | 204 | description: Boolean parameter to determine if returned value(s) will be cm |
seanbeirne | 9060818 | 2024-11-20 11:00:49 +0000 | [diff] [blame] | 205 | handle ids or alternate ids for a given query |
danielhanrahan | 8271b87 | 2024-10-25 16:28:17 +0100 | [diff] [blame] | 206 | in: query |
207 | name: outputAlternateId | ||||
208 | required: false | ||||
209 | schema: | ||||
210 | default: false | ||||
211 | type: boolean | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 212 | responses: |
213 | NoContent: | ||||
214 | content: {} | ||||
215 | description: No Content | ||||
216 | BadRequest: | ||||
217 | content: | ||||
218 | application/json: | ||||
219 | example: | ||||
danielhanrahan | ad46c25 | 2024-05-01 11:25:36 +0100 | [diff] [blame] | 220 | status: 400 |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 221 | message: Bad request error message |
222 | details: Bad request error details | ||||
223 | schema: | ||||
224 | $ref: '#/components/schemas/ErrorMessage' | ||||
225 | description: Bad Request | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 226 | 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 | ||||
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 246 | schemas: |
247 | RestDmiPluginRegistration: | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 248 | example: |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 249 | updatedCmHandles: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 250 | - cmHandle: my-cm-handle |
danielhanrahan | 3e14d39 | 2023-12-20 13:31:07 +0000 | [diff] [blame] | 251 | alternateId: my-alternate-id |
JvD_Ericsson | e14fe9a | 2024-02-26 13:45:47 +0000 | [diff] [blame] | 252 | dataProducerIdentifier: my-data-producer-identifier |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 253 | publicCmHandleProperties: |
254 | key: my-property | ||||
255 | cmHandleProperties: | ||||
256 | key: my-property | ||||
danielhanrahan | c3e7b0e | 2023-09-20 15:01:59 +0100 | [diff] [blame] | 257 | moduleSetTag: my-module-set-tag |
mpriyank | d74c2d2 | 2023-11-06 13:25:38 +0000 | [diff] [blame] | 258 | trustLevel: COMPLETE |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 259 | - cmHandle: my-cm-handle |
danielhanrahan | 3e14d39 | 2023-12-20 13:31:07 +0000 | [diff] [blame] | 260 | alternateId: my-alternate-id |
JvD_Ericsson | e14fe9a | 2024-02-26 13:45:47 +0000 | [diff] [blame] | 261 | dataProducerIdentifier: my-data-producer-identifier |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 262 | publicCmHandleProperties: |
263 | key: my-property | ||||
264 | cmHandleProperties: | ||||
265 | key: my-property | ||||
danielhanrahan | c3e7b0e | 2023-09-20 15:01:59 +0100 | [diff] [blame] | 266 | moduleSetTag: my-module-set-tag |
mpriyank | d74c2d2 | 2023-11-06 13:25:38 +0000 | [diff] [blame] | 267 | trustLevel: COMPLETE |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 268 | createdCmHandles: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 269 | - cmHandle: my-cm-handle |
danielhanrahan | 3e14d39 | 2023-12-20 13:31:07 +0000 | [diff] [blame] | 270 | alternateId: my-alternate-id |
JvD_Ericsson | e14fe9a | 2024-02-26 13:45:47 +0000 | [diff] [blame] | 271 | dataProducerIdentifier: my-data-producer-identifier |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 272 | publicCmHandleProperties: |
273 | key: my-property | ||||
274 | cmHandleProperties: | ||||
275 | key: my-property | ||||
danielhanrahan | c3e7b0e | 2023-09-20 15:01:59 +0100 | [diff] [blame] | 276 | moduleSetTag: my-module-set-tag |
mpriyank | d74c2d2 | 2023-11-06 13:25:38 +0000 | [diff] [blame] | 277 | trustLevel: COMPLETE |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 278 | - cmHandle: my-cm-handle |
danielhanrahan | 3e14d39 | 2023-12-20 13:31:07 +0000 | [diff] [blame] | 279 | alternateId: my-alternate-id |
JvD_Ericsson | e14fe9a | 2024-02-26 13:45:47 +0000 | [diff] [blame] | 280 | dataProducerIdentifier: my-data-producer-identifier |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 281 | publicCmHandleProperties: |
282 | key: my-property | ||||
283 | cmHandleProperties: | ||||
284 | key: my-property | ||||
danielhanrahan | c3e7b0e | 2023-09-20 15:01:59 +0100 | [diff] [blame] | 285 | moduleSetTag: my-module-set-tag |
mpriyank | d74c2d2 | 2023-11-06 13:25:38 +0000 | [diff] [blame] | 286 | trustLevel: COMPLETE |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 287 | dmiPlugin: my-dmi-plugin |
288 | dmiModelPlugin: my-dmi-model-plugin | ||||
egernug | fb09b7c | 2023-10-12 13:33:08 +0100 | [diff] [blame] | 289 | upgradedCmHandles: |
290 | cmHandles: | ||||
291 | - my-cm-handle1 | ||||
292 | - my-cm-handle2 | ||||
293 | - my-cm-handle3 | ||||
294 | moduleSetTag: my-module-set-tag | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 295 | dmiDataPlugin: my-dmi-data-plugin |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 296 | removedCmHandles: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 297 | - my-cm-handle1 |
298 | - my-cm-handle2 | ||||
299 | - my-cm-handle3 | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 300 | 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: | ||||
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 323 | - my-cm-handle1 |
324 | - my-cm-handle2 | ||||
325 | - my-cm-handle3 | ||||
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 326 | items: |
327 | type: string | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 328 | type: array |
egernug | fb09b7c | 2023-10-12 13:33:08 +0100 | [diff] [blame] | 329 | upgradedCmHandles: |
330 | $ref: '#/components/schemas/UpgradedCmHandles' | ||||
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 331 | type: object |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 332 | RestInputCmHandle: |
333 | example: | ||||
334 | cmHandle: my-cm-handle | ||||
danielhanrahan | 3e14d39 | 2023-12-20 13:31:07 +0000 | [diff] [blame] | 335 | alternateId: my-alternate-id |
JvD_Ericsson | e14fe9a | 2024-02-26 13:45:47 +0000 | [diff] [blame] | 336 | dataProducerIdentifier: my-data-producer-identifier |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 337 | publicCmHandleProperties: |
338 | key: my-property | ||||
339 | cmHandleProperties: | ||||
340 | key: my-property | ||||
danielhanrahan | c3e7b0e | 2023-09-20 15:01:59 +0100 | [diff] [blame] | 341 | moduleSetTag: my-module-set-tag |
mpriyank | d74c2d2 | 2023-11-06 13:25:38 +0000 | [diff] [blame] | 342 | trustLevel: COMPLETE |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 343 | properties: |
344 | cmHandle: | ||||
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 345 | example: my-cm-handle |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 346 | type: string |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 347 | cmHandleProperties: |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 348 | additionalProperties: |
349 | example: my-property | ||||
350 | type: string | ||||
351 | type: object | ||||
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 352 | publicCmHandleProperties: |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 353 | additionalProperties: |
354 | example: my-property | ||||
355 | type: string | ||||
356 | type: object | ||||
danielhanrahan | c3e7b0e | 2023-09-20 15:01:59 +0100 | [diff] [blame] | 357 | moduleSetTag: |
358 | example: my-module-set-tag | ||||
359 | type: string | ||||
mpriyank | d74c2d2 | 2023-11-06 13:25:38 +0000 | [diff] [blame] | 360 | trustLevel: |
361 | enum: | ||||
362 | - COMPLETE | ||||
363 | - NONE | ||||
364 | example: COMPLETE | ||||
365 | type: string | ||||
danielhanrahan | 3e14d39 | 2023-12-20 13:31:07 +0000 | [diff] [blame] | 366 | alternateId: |
367 | example: my-alternate-id | ||||
368 | type: string | ||||
JvD_Ericsson | e14fe9a | 2024-02-26 13:45:47 +0000 | [diff] [blame] | 369 | dataProducerIdentifier: |
370 | example: my-data-producer-identifier | ||||
371 | type: string | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 372 | required: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 373 | - cmHandle |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 374 | type: object |
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 375 | RestCmHandleProperties: |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 376 | additionalProperties: |
DylanB95EST | 63132ce | 2021-12-14 16:34:38 +0000 | [diff] [blame] | 377 | example: my-property |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 378 | type: string |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 379 | type: object |
egernug | fb09b7c | 2023-10-12 13:33:08 +0100 | [diff] [blame] | 380 | 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: | ||||
danielhanrahan | 3e14d39 | 2023-12-20 13:31:07 +0000 | [diff] [blame] | 397 | default: "" |
egernug | fb09b7c | 2023-10-12 13:33:08 +0100 | [diff] [blame] | 398 | example: my-module-set-tag |
399 | type: string | ||||
400 | required: | ||||
401 | - cmHandles | ||||
402 | type: object | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 403 | ErrorMessage: |
niamhcore | c1904c1 | 2021-10-11 16:38:53 +0100 | [diff] [blame] | 404 | properties: |
405 | status: | ||||
406 | type: string | ||||
407 | message: | ||||
408 | type: string | ||||
409 | details: | ||||
410 | type: string | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 411 | title: Error |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 412 | type: object |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 413 | DmiPluginRegistrationErrorResponse: |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 414 | properties: |
415 | failedCreatedCmHandles: | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 416 | items: |
417 | $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 418 | type: array |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 419 | failedUpdatedCmHandles: |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 420 | items: |
421 | $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 422 | type: array |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 423 | failedRemovedCmHandles: |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 424 | items: |
425 | $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 426 | type: array |
egernug | fb09b7c | 2023-10-12 13:33:08 +0100 | [diff] [blame] | 427 | failedUpgradeCmHandles: |
428 | items: | ||||
429 | $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' | ||||
430 | type: array | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 431 | type: object |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 432 | CmHandlerRegistrationErrorResponse: |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 433 | properties: |
434 | cmHandle: | ||||
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 435 | example: my-cm-handle |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 436 | type: string |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 437 | errorCode: |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 438 | example: "00" |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 439 | type: string |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 440 | errorText: |
emaclee | afb1736 | 2022-09-02 14:40:17 +0100 | [diff] [blame] | 441 | example: Unknown error. <error-details> |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 442 | type: string |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 443 | type: object |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 444 | CmHandleQueryParameters: |
445 | example: | ||||
446 | cmHandleQueryParameters: | ||||
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 447 | - conditionParameters: |
448 | - key: conditionParameters | ||||
449 | - key: conditionParameters | ||||
450 | conditionName: conditionName | ||||
451 | - conditionParameters: | ||||
452 | - key: conditionParameters | ||||
453 | - key: conditionParameters | ||||
454 | conditionName: conditionName | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 455 | conditions: |
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 456 | - 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 | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 464 | properties: |
465 | cmHandleQueryParameters: | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 466 | items: |
467 | $ref: '#/components/schemas/ConditionProperties' | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 468 | type: array |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 469 | conditions: |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 470 | deprecated: true |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 471 | description: "not necessary, it is just for backward compatibility" |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 472 | items: |
473 | $ref: '#/components/schemas/OldConditionProperties' | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 474 | type: array |
475 | title: Cm Handle query parameters for executing cm handle search | ||||
476 | type: object | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 477 | ConditionProperties: |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 478 | example: |
479 | conditionParameters: | ||||
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 480 | - key: conditionParameters |
481 | - key: conditionParameters | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 482 | conditionName: conditionName |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 483 | properties: |
484 | conditionName: | ||||
485 | type: string | ||||
486 | conditionParameters: | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 487 | items: |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 488 | additionalProperties: |
489 | type: string | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 490 | type: object |
491 | type: array | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 492 | OldConditionProperties: |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 493 | deprecated: true |
494 | example: | ||||
495 | name: name | ||||
496 | conditionParameters: | ||||
mpriyank | 41c7d00 | 2023-08-22 13:17:46 +0100 | [diff] [blame] | 497 | - moduleName: my-module |
498 | - moduleName: my-module | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 499 | properties: |
500 | name: | ||||
501 | type: string | ||||
502 | conditionParameters: | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 503 | items: |
504 | $ref: '#/components/schemas/ModuleNameAsJsonObject' | ||||
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 505 | type: array |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 506 | ModuleNameAsJsonObject: |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 507 | example: |
508 | moduleName: my-module | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 509 | properties: |
510 | moduleName: | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 511 | example: my-module |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 512 | type: string |
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 513 | securitySchemes: |
514 | basicAuth: | ||||
seanbeirne | 16e2358 | 2023-01-26 09:21:44 +0000 | [diff] [blame] | 515 | scheme: basic |
mpriyank | 6da9541 | 2023-06-29 16:56:11 +0100 | [diff] [blame] | 516 | type: http |