Gitiles
Code Review Sign In
gerrit.nordix.org / onap / policy / clamp / 7af90cd8fdabdd1c3ae79d3551980016d6b24f7e / . / runtime-acm / src / main / resources / openapi / openapi.yaml
blob: 6e07e037d93e2be71aa9b3c22614afdeb9102911 [file] [log] [blame]
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1# ============LICENSE_START=======================================================
2# Copyright (C) 2022 Nordix Foundation
3# ================================================================================
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16# SPDX-License-Identifier: Apache-2.0
17# ============LICENSE_END=========================================================
18openapi: 3.0.1
19info:
20 title: Api Documentation
21 description: Api Documentation
22 termsOfService: urn:tos
23 contact: {}
24 license:
25 name: Apache 2.0
26 url: http://www.apache.org/licenses/LICENSE-2.0
27 version: "1.0"
28servers:
29 - url: https://{server}
30 variables:
31 server:
32 default: onap/acm/v3
33 description: This value is assigned by the service provider
34tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]35- name: Automation Composition Definition
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]36 description: Automation Composition Controller
37
38paths:
39 /compositions:
40 get:
41 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]42 - Automation Composition Definition
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]43 summary: Query the commissioned automation composition definitions
44 definitions
45 description: Query the commissioned automation composition
46 definitions, returning the automation composition details
47 operationId: queryCompositionDefinitions
48 parameters:
49 - name: name
50 in: query
51 description: Automation composition definition name. Regular expressions are supported for filtering. If
52 this parameter is not specified, all automation composition definitions are returned.
53 schema:
54 type: string
55 - name: version
56 in: query
57 description: Automation composition definition version. Regular expressions are supported for filtering. If this
58 parameter is not specified, all automation composition definitions that match the "name" filter are are returned.
59 schema:
60 type: string
61 - name: X-onap-RequestId
62 in: header
63 description: RequestID for http transaction
64 schema:
65 type: string
66 format: uuid
67 responses:
68 200:
69 description: Serialised instance of
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]70 [ToscaServiceTemplates](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplates.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]71 that contains the automation composition definitions that match the requested filters.
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]72 headers:
73 X-LatestVersion:
74 schema:
75 type: string
76 X-PatchVersion:
77 schema:
78 type: string
79 X-MinorVersion:
80 schema:
81 type: string
82 X-onap-RequestId:
83 schema:
84 type: string
85 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]86 content:
87 application/json:
88 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]89 $ref: '#/components/schemas/ToscaServiceTemplates'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]90 example:
91 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json'
92 application/yaml:
93 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]94 $ref: '#/components/schemas/ToscaServiceTemplates'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]95 example:
96 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.yaml'
97 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]98 description: Authentication Error, returns an instance of
99 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]100 headers:
101 X-LatestVersion:
102 schema:
103 type: string
104 X-PatchVersion:
105 schema:
106 type: string
107 X-MinorVersion:
108 schema:
109 type: string
110 X-onap-RequestId:
111 schema:
112 type: string
113 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]114 content:
115 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]116 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]117 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]118 security:
119 - basicAuth: []
120 x-interface info:
121 api-version: 1.0.0
122 last-mod-release: London
123 post:
124 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]125 - Automation Composition Definition
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]126 summary: Commissions automation composition definitions
127 description: Commissions automation composition definitions, returning the UUIDs of
128 automation composition definitions commissioned by this request.
129 operationId: createCompositionDefinitions
130 parameters:
131 - name: X-onap-RequestId
132 in: header
133 description: RequestID for http transaction
134 schema:
135 type: string
136 format: uuid
137 requestBody:
138 description: Serialised instance of
139 [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
140 containing the automation composition definitions to be commissioned.
141 content:
142 application/json:
143 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]144 $ref: '#/components/schemas/ToscaServiceTemplate'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]145 example:
146 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.json'
147 application/yaml:
148 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]149 $ref: '#/components/schemas/ToscaServiceTemplate'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]150 example:
151 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml'
152 required: true
153 responses:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]154 201:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]155 description: Serialised instance of
156 [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
157 containing the UUIDs of automation composition definitions created by this request
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]158 headers:
159 X-LatestVersion:
160 schema:
161 type: string
162 X-PatchVersion:
163 schema:
164 type: string
165 X-MinorVersion:
166 schema:
167 type: string
168 X-onap-RequestId:
169 schema:
170 type: string
171 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]172 content:
173 application/json:
174 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]175 $ref: '#/components/schemas/CommissioningResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]176 example:
177 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.json'
178 application/yaml:
179 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]180 $ref: '#/components/schemas/CommissioningResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]181 example:
182 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]183 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]184 description: Authentication Error, returns an instance of
185 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]186 headers:
187 X-LatestVersion:
188 schema:
189 type: string
190 X-PatchVersion:
191 schema:
192 type: string
193 X-MinorVersion:
194 schema:
195 type: string
196 X-onap-RequestId:
197 schema:
198 type: string
199 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]200 content:
201 application/json:
202 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]203 $ref: '#/components/schemas/SimpleResponse'
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]204 400:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]205 description: Bad Request, returns an instance of
206 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]207 headers:
208 X-LatestVersion:
209 schema:
210 type: string
211 X-PatchVersion:
212 schema:
213 type: string
214 X-MinorVersion:
215 schema:
216 type: string
217 X-onap-RequestId:
218 schema:
219 type: string
220 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]221 content:
222 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]223 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]224 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]225 security:
226 - basicAuth: []
227 x-interface info:
228 api-version: 1.0.0
229 last-mod-release: London
230 x-codegen-request-body-name: body
231 /compositions/{compositionId}:
232 get:
233 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]234 - Automation Composition Definition
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]235 summary: Get details of the requested commissioned automation composition
236 definitions
237 description: Get details of the requested commissioned automation composition
238 definitions, returning all automation composition details
239 operationId: getCompositionDefinition
240 parameters:
241 - name : compositionId
242 in: path
243 description: The UUID of the automation composition definition to get
244 required: true
245 schema:
246 type: string
247 format: uuid
248 - name: X-onap-RequestId
249 in: header
250 description: RequestID for http transaction
251 schema:
252 type: string
253 format: uuid
254 responses:
255 200:
256 description:
257 Serialised instance of
258 [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
259 containing the requested automation composition definition.
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]260 headers:
261 X-LatestVersion:
262 schema:
263 type: string
264 X-PatchVersion:
265 schema:
266 type: string
267 X-MinorVersion:
268 schema:
269 type: string
270 X-onap-RequestId:
271 schema:
272 type: string
273 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]274 content:
275 application/json:
276 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]277 $ref: '#/components/schemas/ToscaServiceTemplate'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]278 example:
279 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json'
280 application/yaml:
281 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]282 $ref: '#/components/schemas/ToscaServiceTemplate'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]283 example:
284 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml'
285 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]286 description: Authentication Error, returns an instance of
287 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]288 headers:
289 X-LatestVersion:
290 schema:
291 type: string
292 X-PatchVersion:
293 schema:
294 type: string
295 X-MinorVersion:
296 schema:
297 type: string
298 X-onap-RequestId:
299 schema:
300 type: string
301 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]302 content:
303 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]304 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]305 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]306 404:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]307 description: Specified automation composition definition not found, returns an instance of
308 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]309 headers:
310 X-LatestVersion:
311 schema:
312 type: string
313 X-PatchVersion:
314 schema:
315 type: string
316 X-MinorVersion:
317 schema:
318 type: string
319 X-onap-RequestId:
320 schema:
321 type: string
322 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]323 content:
324 application/json:
325 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]326 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]327 security:
328 - basicAuth: []
329 x-interface info:
330 api-version: 1.0.0
331 last-mod-release: London
332 put:
333 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]334 - Automation Composition Definition
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]335 summary: Update an automation composition definition
336 description: Updates an automation composition definition as described in the supplied automation composition defintion, returning the UUID of the automation composition definition updated by this request
337 operationId: updateCompositionDefinition
338 parameters:
339 - name : compositionId
340 in: path
341 description: The UUID of the automation composition definition to update
342 required: true
343 schema:
344 type: string
345 format: uuid
346 - name: X-onap-RequestId
347 in: header
348 description: RequestID for http transaction
349 schema:
350 type: string
351 format: uuid
352 requestBody:
353 description: Serialised instance of
354 [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
355 containing the changes to be made to the automation composition definition.
356 content:
357 application/json:
358 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]359 $ref: '#/components/schemas/ToscaServiceTemplate'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]360 example:
361 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.json'
362 application/yaml:
363 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]364 $ref: '#/components/schemas/ToscaServiceTemplate'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]365 example:
366 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.yaml'
367 required: true
368 responses:
369 200:
370 description: Serialised instance of
371 [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
372 containing the UUID of the automation composition updated by this request
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]373 headers:
374 X-LatestVersion:
375 schema:
376 type: string
377 X-PatchVersion:
378 schema:
379 type: string
380 X-MinorVersion:
381 schema:
382 type: string
383 X-onap-RequestId:
384 schema:
385 type: string
386 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]387 content:
388 application/json:
389 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]390 $ref: '#/components/schemas/CommissioningResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]391 example:
392 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.json'
393 application/yaml:
394 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]395 $ref: '#/components/schemas/CommissioningResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]396 example:
397 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.yaml'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]398 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]399 description: Authentication Error, returns an instance of
400 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]401 headers:
402 X-LatestVersion:
403 schema:
404 type: string
405 X-PatchVersion:
406 schema:
407 type: string
408 X-MinorVersion:
409 schema:
410 type: string
411 X-onap-RequestId:
412 schema:
413 type: string
414 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]415 content:
416 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]417 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]418 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]419 404:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]420 description: Specified automation composition definition not found, returns an instance of
421 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]422 headers:
423 X-LatestVersion:
424 schema:
425 type: string
426 X-PatchVersion:
427 schema:
428 type: string
429 X-MinorVersion:
430 schema:
431 type: string
432 X-onap-RequestId:
433 schema:
434 type: string
435 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]436 content:
437 application/json:
438 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]439 $ref: '#/components/schemas/SimpleResponse'
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]440 400:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]441 description: Bad Request, returns an instance of
442 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]443 headers:
444 X-LatestVersion:
445 schema:
446 type: string
447 X-PatchVersion:
448 schema:
449 type: string
450 X-MinorVersion:
451 schema:
452 type: string
453 X-onap-RequestId:
454 schema:
455 type: string
456 format: uuid
457 content:
458 application/json:
459 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]460 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]461 security:
462 - basicAuth: []
463 x-interface info:
464 api-version: 1.0.0
465 last-mod-release: London
466 x-codegen-request-body-name: body
467 delete:
468 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]469 - Automation Composition Definition
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]470 summary: Delete a commissioned automation composition definition
471 description: Deletes a commissioned automation composition definition,returning the UUID of the automation composition definition deleted by this request
472 operationId: deleteCompositionDefinition
473 parameters:
474 - name : compositionId
475 in: path
476 description: The UUID of the automation composition definition to delete
477 required: true
478 schema:
479 type: string
480 format: uuid
481 - name: X-onap-RequestId
482 in: header
483 description: RequestID for http transaction
484 schema:
485 type: string
486 format: uuid
487 responses:
488 200:
489 description: Serialised instance of
490 [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
491 containing the UUID of the automation composition deleted by this request
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]492 headers:
493 X-LatestVersion:
494 schema:
495 type: string
496 X-PatchVersion:
497 schema:
498 type: string
499 X-MinorVersion:
500 schema:
501 type: string
502 X-onap-RequestId:
503 schema:
504 type: string
505 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]506 content:
507 application/json:
508 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]509 $ref: '#/components/schemas/CommissioningResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]510 example:
511 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json'
512 application/yaml:
513 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]514 $ref: '#/components/schemas/CommissioningResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]515 example:
516 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml'
517 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]518 description: Authentication Error, returns an instance of
519 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]520 headers:
521 X-LatestVersion:
522 schema:
523 type: string
524 X-PatchVersion:
525 schema:
526 type: string
527 X-MinorVersion:
528 schema:
529 type: string
530 X-onap-RequestId:
531 schema:
532 type: string
533 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]534 content:
535 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]536 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]537 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]538 404:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]539 description: Specified automation composition definition not found, returns an instance of
540 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]541 headers:
542 X-LatestVersion:
543 schema:
544 type: string
545 X-PatchVersion:
546 schema:
547 type: string
548 X-MinorVersion:
549 schema:
550 type: string
551 X-onap-RequestId:
552 schema:
553 type: string
554 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]555 content:
556 application/json:
557 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]558 $ref: '#/components/schemas/SimpleResponse'
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]559 400:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]560 description: Bad Request, returns an instance of
561 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]562 headers:
563 X-LatestVersion:
564 schema:
565 type: string
566 X-PatchVersion:
567 schema:
568 type: string
569 X-MinorVersion:
570 schema:
571 type: string
572 X-onap-RequestId:
573 schema:
574 type: string
575 format: uuid
576 content:
577 application/json:
578 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]579 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]580 security:
581 - basicAuth: []
582 x-interface info:
583 api-version: 1.0.0
584 last-mod-release: London
585 /compositions/{compositionId}/instances:
586 get:
587 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]588 - Automation Composition Instance
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]589 summary: Query details of the requested automation composition instances
590 description: Query details of the requested automation composition instances for the given automation composition definition ID, returning
591 details of all its automation composition instances
592 operationId: queryCompositionInstances
593 parameters:
594 - name : compositionId
595 in: path
596 description: The UUID of the automation composition definition for which to return instances
597 required: true
598 schema:
599 type: string
600 format: uuid
601 - name: name
602 in: query
603 description: Automation composition instance name. Regular expressions are supported for filtering. If
604 this parameter is not specified, all automation composition instances for the specified definition are returned.
605 schema:
606 type: string
607 - name: version
608 in: query
609 description: Automation composition instance version. Regular expressions are supported for filtering. If this
610 parameter is not specified, all automation composition instances for the specified definition that match the "name" filter are are returned.
611 schema:
612 type: string
613 - name: X-onap-RequestId
614 in: header
615 description: RequestID for http transaction
616 schema:
617 type: string
618 format: uuid
619 responses:
620 200:
621 description: Serialised instance of
622 [AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
623 containing a list of automation composition instances found
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]624 headers:
625 X-LatestVersion:
626 schema:
627 type: string
628 X-PatchVersion:
629 schema:
630 type: string
631 X-MinorVersion:
632 schema:
633 type: string
634 X-onap-RequestId:
635 schema:
636 type: string
637 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]638 content:
639 application/json:
640 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]641 $ref: '#/components/schemas/AutomationCompositions'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]642 example:
643 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json'
644 application/yaml:
645 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]646 $ref: '#/components/schemas/AutomationCompositions'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]647 example:
648 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml'
649 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]650 description: Authentication Error, returns an instance of
651 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]652 headers:
653 X-LatestVersion:
654 schema:
655 type: string
656 X-PatchVersion:
657 schema:
658 type: string
659 X-MinorVersion:
660 schema:
661 type: string
662 X-onap-RequestId:
663 schema:
664 type: string
665 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]666 content:
667 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]668 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]669 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]670 404:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]671 description: The specified automation composition definition was not found, returns an instance of
672 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]673 headers:
674 X-LatestVersion:
675 schema:
676 type: string
677 X-PatchVersion:
678 schema:
679 type: string
680 X-MinorVersion:
681 schema:
682 type: string
683 X-onap-RequestId:
684 schema:
685 type: string
686 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]687 content:
688 application/json:
689 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]690 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]691 security:
692 - basicAuth: []
693 x-interface info:
694 api-version: 1.0.0
695 last-mod-release: London
696 post:
697 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]698 - Automation Composition Instance
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]699 summary: Create automation composition instances
700 description: Creates automation composition instances that use the sepcified automation composition definition. The IDs of the created
701 automation composition instances are returned.
702 operationId: createCompositionInstances
703 parameters:
704 - name : compositionId
705 in: path
706 description: The UUID of the automation composition definition on which to create instances
707 required: true
708 schema:
709 type: string
710 format: uuid
711 - name: X-onap-RequestId
712 in: header
713 description: RequestID for http transaction
714 schema:
715 type: string
716 format: uuid
717 requestBody:
718 description: Serialised instance of
719 [AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
720 containing a list of automation composition instances to create
721 content:
722 application/json:
723 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]724 $ref: '#/components/schemas/AutomationCompositions'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]725 example:
726 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.json'
727 application/yaml:
728 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]729 $ref: '#/components/schemas/AutomationCompositions'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]730 example:
731 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.yaml'
732 required: true
733 responses:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]734 201:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]735 description: Serialised instance of
736 [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
737 containing the UUIDs of the created automation composition instances
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]738 headers:
739 X-LatestVersion:
740 schema:
741 type: string
742 X-PatchVersion:
743 schema:
744 type: string
745 X-MinorVersion:
746 schema:
747 type: string
748 X-onap-RequestId:
749 schema:
750 type: string
751 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]752 content:
753 application/json:
754 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]755 $ref: '#/components/schemas/InstantiationResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]756 example:
757 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json'
758 application/yaml:
759 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]760 $ref: '#/components/schemas/InstantiationResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]761 example:
762 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]763 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]764 description: Authentication Error, returns an instance of
765 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]766 headers:
767 X-LatestVersion:
768 schema:
769 type: string
770 X-PatchVersion:
771 schema:
772 type: string
773 X-MinorVersion:
774 schema:
775 type: string
776 X-onap-RequestId:
777 schema:
778 type: string
779 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]780 content:
781 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]782 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]783 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]784 404:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]785 description: The specified automation composition definition was not found, returns an instance of
786 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]787 headers:
788 X-LatestVersion:
789 schema:
790 type: string
791 X-PatchVersion:
792 schema:
793 type: string
794 X-MinorVersion:
795 schema:
796 type: string
797 X-onap-RequestId:
798 schema:
799 type: string
800 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]801 content:
802 application/json:
803 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]804 $ref: '#/components/schemas/SimpleResponse'
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]805 400:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]806 description: Bad Request, returns an instance of
807 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]808 headers:
809 X-LatestVersion:
810 schema:
811 type: string
812 X-PatchVersion:
813 schema:
814 type: string
815 X-MinorVersion:
816 schema:
817 type: string
818 X-onap-RequestId:
819 schema:
820 type: string
821 format: uuid
822 content:
823 application/json:
824 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]825 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]826 security:
827 - basicAuth: []
828 x-interface info:
829 api-version: 1.0.0
830 last-mod-release: London
831 x-codegen-request-body-name: body
832 /compositions/{compositionId}/instances/{instanceId}:
833 get:
834 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]835 - Automation Composition Instance
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]836 summary: Get automation composition instance details.
837 description: Get details of the requested automation composition instance.
838 operationId: getCompositionInstance
839 parameters:
840 - name : compositionId
841 in: path
842 description: The UUID of the automation composition definition on which to get an instance
843 required: true
844 schema:
845 type: string
846 format: uuid
847 - name : instanceId
848 in: path
849 description: The UUID of the automation composition instance to get
850 required: true
851 schema:
852 type: string
853 format: uuid
854 - name: X-onap-RequestId
855 in: header
856 description: RequestID for http transaction
857 schema:
858 type: string
859 format: uuid
860 responses:
861 200:
862 description: Serialised instance of
863 [AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
864 containing a list of automation composition instances with one entry
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]865 headers:
866 X-LatestVersion:
867 schema:
868 type: string
869 X-PatchVersion:
870 schema:
871 type: string
872 X-MinorVersion:
873 schema:
874 type: string
875 X-onap-RequestId:
876 schema:
877 type: string
878 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]879 content:
880 application/json:
881 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]882 $ref: '#/components/schemas/AutomationCompositions'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]883 example:
884 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.json'
885 application/yaml:
886 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]887 $ref: '#/components/schemas/AutomationCompositions'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]888 example:
889 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.yaml'
890 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]891 description: Authentication Error, returns an instance of
892 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]893 headers:
894 X-LatestVersion:
895 schema:
896 type: string
897 X-PatchVersion:
898 schema:
899 type: string
900 X-MinorVersion:
901 schema:
902 type: string
903 X-onap-RequestId:
904 schema:
905 type: string
906 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]907 content:
908 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]909 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]910 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]911 404:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]912 description: The automation composition instance was not found, returns an instance of
913 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]914 headers:
915 X-LatestVersion:
916 schema:
917 type: string
918 X-PatchVersion:
919 schema:
920 type: string
921 X-MinorVersion:
922 schema:
923 type: string
924 X-onap-RequestId:
925 schema:
926 type: string
927 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]928 content:
929 application/json:
930 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]931 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]932 security:
933 - basicAuth: []
934 x-interface info:
935 api-version: 1.0.0
936 last-mod-release: London
937 put:
938 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]939 - Automation Composition Instance
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]940 summary: Update an automation composition instance
lapentafd41fcf352022-11-09 11:05:52 +0000[diff] [blame]941 description: This request updates an automation composition instance. It may update instance properties or change the state of the automation composition instance
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]942 operationId: updateCompositionInstance
943 parameters:
944 - name : compositionId
945 in: path
946 description: The UUID of the automation composition definition on which to update an instance
947 required: true
948 schema:
949 type: string
950 format: uuid
951 - name : instanceId
952 in: path
953 description: The UUID of the automation composition instance to update
954 required: true
955 schema:
956 type: string
957 format: uuid
958 - name: X-onap-RequestId
959 in: header
960 description: RequestID for http transaction
961 schema:
962 type: string
963 format: uuid
964 requestBody:
965 description: Serialised instance of
966 [InstantiationUpdate](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationUpdate.java)
967 which specifies the update operation to be carried out on the automation concept instance
968 content:
969 application/json:
970 schema:
971 title: InstantiationUpdate
972 type: object
973 example:
974 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.json'
975 application/yaml:
976 schema:
977 title: InstantiationUpdate
978 type: object
979 example:
980 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.yaml'
981 required: true
982 responses:
983 200:
984 description: Serialised instance of
985 [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
986 containing the UUID of the updated automation composition instance
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]987 headers:
988 X-LatestVersion:
989 schema:
990 type: string
991 X-PatchVersion:
992 schema:
993 type: string
994 X-MinorVersion:
995 schema:
996 type: string
997 X-onap-RequestId:
998 schema:
999 type: string
1000 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1001 content:
1002 application/json:
1003 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1004 $ref: '#/components/schemas/InstantiationResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1005 example:
1006 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.json'
1007 application/yaml:
1008 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1009 $ref: '#/components/schemas/InstantiationResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1010 example:
1011 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.yaml'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1012 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1013 description: Authentication Error, returns an instance of
1014 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1015 headers:
1016 X-LatestVersion:
1017 schema:
1018 type: string
1019 X-PatchVersion:
1020 schema:
1021 type: string
1022 X-MinorVersion:
1023 schema:
1024 type: string
1025 X-onap-RequestId:
1026 schema:
1027 type: string
1028 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1029 content:
1030 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1031 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1032 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1033 404:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1034 description: The specified automation composition instance was not found, returns an instance of
1035 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1036 headers:
1037 X-LatestVersion:
1038 schema:
1039 type: string
1040 X-PatchVersion:
1041 schema:
1042 type: string
1043 X-MinorVersion:
1044 schema:
1045 type: string
1046 X-onap-RequestId:
1047 schema:
1048 type: string
1049 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1050 content:
1051 application/json:
1052 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1053 $ref: '#/components/schemas/SimpleResponse'
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1054 400:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1055 description: Bad Request, returns an instance of
1056 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1057 headers:
1058 X-LatestVersion:
1059 schema:
1060 type: string
1061 X-PatchVersion:
1062 schema:
1063 type: string
1064 X-MinorVersion:
1065 schema:
1066 type: string
1067 X-onap-RequestId:
1068 schema:
1069 type: string
1070 format: uuid
1071 content:
1072 application/json:
1073 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1074 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1075 security:
1076 - basicAuth: []
1077 x-interface info:
1078 api-version: 1.0.0
1079 last-mod-release: London
1080 x-codegen-request-body-name: body
1081 delete:
1082 tags:
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1083 - Automation Composition Instance
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1084 summary: Delete an automation composition instance
1085 description: Deletes a automation composition instance, returning the UUID of the deleted automation composition instance
1086 operationId: deleteCompositionInstance
1087 parameters:
1088 - name : compositionId
1089 in: path
1090 description: The UUID of the automation composition definition on which to delete an instance
1091 required: true
1092 schema:
1093 type: string
1094 format: uuid
1095 - name : instanceId
1096 in: path
1097 description: The UUID of the automation composition instance to delete
1098 required: true
1099 schema:
1100 type: string
1101 format: uuid
1102 - name: X-onap-RequestId
1103 in: header
1104 description: RequestID for http transaction
1105 schema:
1106 type: string
1107 format: uuid
1108 responses:
1109 200:
1110 description: Serialised instance of
1111 [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
1112 containing the UUID of the deleted automation composition instance
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1113 headers:
1114 X-LatestVersion:
1115 schema:
1116 type: string
1117 X-PatchVersion:
1118 schema:
1119 type: string
1120 X-MinorVersion:
1121 schema:
1122 type: string
1123 X-onap-RequestId:
1124 schema:
1125 type: string
1126 format: uuid
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1127 content:
1128 application/json:
1129 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1130 $ref: '#/components/schemas/InstantiationResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1131 example:
1132 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.json'
1133 application/yaml:
1134 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1135 $ref: '#/components/schemas/InstantiationResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1136 example:
1137 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml'
1138 401:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1139 description: Authentication Error, returns an instance of
1140 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1141 headers:
1142 X-LatestVersion:
1143 schema:
1144 type: string
1145 X-PatchVersion:
1146 schema:
1147 type: string
1148 X-MinorVersion:
1149 schema:
1150 type: string
1151 X-onap-RequestId:
1152 schema:
1153 type: string
1154 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1155 content:
1156 application/json:
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1157 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1158 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1159 404:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1160 description: The specified automation composition instance was not found, returns an instance of
1161 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1162 headers:
1163 X-LatestVersion:
1164 schema:
1165 type: string
1166 X-PatchVersion:
1167 schema:
1168 type: string
1169 X-MinorVersion:
1170 schema:
1171 type: string
1172 X-onap-RequestId:
1173 schema:
1174 type: string
1175 format: uuid
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1176 content:
1177 application/json:
1178 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1179 $ref: '#/components/schemas/SimpleResponse'
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1180 400:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1181 description: Bad Request, returns an instance of
1182 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
FrancescoFioraEstcfa51e62022-11-10 11:52:31 +0000[diff] [blame]1183 headers:
1184 X-LatestVersion:
1185 schema:
1186 type: string
1187 X-PatchVersion:
1188 schema:
1189 type: string
1190 X-MinorVersion:
1191 schema:
1192 type: string
1193 X-onap-RequestId:
1194 schema:
1195 type: string
1196 format: uuid
1197 content:
1198 application/json:
1199 schema:
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1200 $ref: '#/components/schemas/SimpleResponse'
lapentafd16e6e7e2022-11-02 10:08:16 +0000[diff] [blame]1201 security:
1202 - basicAuth: []
1203 x-interface info:
1204 api-version: 1.0.0
1205 last-mod-release: London
1206
1207components:
1208 securitySchemes:
1209 basicAuth:
1210 type: http
1211 scheme: basic
liamfallonc998a3a2022-11-11 13:43:16 +0000[diff] [blame]1212 schemas:
1213 ToscaServiceTemplates:
1214 title: ToscaServiceTemplates
1215 type: object
1216 ToscaServiceTemplate:
1217 title: ToscaServiceTemplate
1218 type: object
1219 AutomationCompositions:
1220 title: AutomationCompositions
1221 type: object
1222 SimpleResponse:
1223 title: SimpleResponse
1224 type: object
1225 CommissioningResponse:
1226 title: CommissioningResponse
1227 type: object
1228 InstantiationResponse:
1229 title: InstantiationResponse
1230 type: object