rapp-manager-acm/src/main/resources/openapi/acm-spec.yaml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2022-2023 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=========================================================
  18 openapi: 3.0.1
  19 info:
  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"
  28 servers:
  29   - url: https://{server}
  30     variables:
  31       server:
  32         default: onap/policy/clamp/acm/v2
  33         description: This value is assigned by the service provider
  34 tags:
  35   - name: Participant Monitoring
  36     description: Pariticipant Monitoring Controller, for monitoring of and requesting information from participants
  37   - name: Automation Composition Definition
  38     description: Automation Composition Definition Controller, for definition and management of Automation Composition Types
  39   - name: Automation Composition Instance
  40     description: Automation Composition Instance Controller, for definition and management of Automation Composition Instances
  41
  42 paths:
  43   /participants:
  44     get:
  45       tags:
  46         - Participant Monitoring
  47       summary: Query Particicpants
  48       description: Query the participants that are registered on the ACM runtime
  49       operationId: queryParticipants
  50       parameters:
  51         - name: name
  52           in: query
  53           required: false
  54           description: Automation composition definition name. Regular expressions are supported for filtering. If
  55             this parameter is not specified, all automation composition definitions are returned.
  56           schema:
  57             type: string
  58         - name: version
  59           in: query
  60           required: false
  61           description: Automation composition definition version. Regular expressions are supported for filtering. If this
  62             parameter is not specified, all automation composition definitions that match the "name" filter are are returned.
  63           schema:
  64             type: string
  65         - name: X-onap-RequestId
  66           in: header
  67           description: RequestID for http transaction
  68           schema:
  69             type: string
  70             format: uuid
  71       responses:
  72         200:
  73           description: OK, serialised array of instances of
  74             [ParticipantInformation](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/ParticipantInformation.java)
  75             that contains information on participants with their information and status. Each participant entry contains
  76             a list of AC Element types on the participant. Each AC Element type entry contains a list of AC Element
  77             instances on the Participant.
  78           headers:
  79             X-LatestVersion:
  80               $ref: '#/components/headers/X-LatestVersion'
  81             X-PatchVersion:
  82               $ref: '#/components/headers/X-PatchVersion'
  83             X-MinorVersion:
  84               $ref: '#/components/headers/X-MinorVersion'
  85             X-onap-RequestId:
  86               $ref: '#/components/headers/X-onap-RequestId'
  87           content:
  88             application/json:
  89               schema:
  90                 type: array
  91                 items:
  92                   $ref: '#/components/schemas/ParticipantInformation'
  93               example:
  94                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.json'
  95             application/yaml:
  96               schema:
  97                 type: array
  98                 items:
  99                   $ref: '#/components/schemas/ParticipantInformation'
 100               example:
 101                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.yaml'
 102         401:
 103           description: Authentication Error, returns an instance of
 104             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 105           headers:
 106             X-LatestVersion:
 107               $ref: '#/components/headers/X-LatestVersion'
 108             X-PatchVersion:
 109               $ref: '#/components/headers/X-PatchVersion'
 110             X-MinorVersion:
 111               $ref: '#/components/headers/X-MinorVersion'
 112             X-onap-RequestId:
 113               $ref: '#/components/headers/X-onap-RequestId'
 114           content:
 115             application/json:
 116               schema:
 117                 $ref: '#/components/schemas/SimpleResponse'
 118       security:
 119         - basicAuth: []
 120       x-interface info:
 121         api-version: 1.0.0
 122         last-mod-release: London
 123     put:
 124       tags:
 125         - Participant Monitoring
 126       summary: Order an immendiate Participant Report from all participants
 127       description: Requests all participants to immediately generate a heartbeat report with their information and status
 128         and the information and status of all their AC Element Types and Instances. The results are published on subsequent
 129         GET REST requests on the "participants" endpoint.
 130       operationId: orderAllParticipantsReport
 131       parameters:
 132         - name: X-onap-RequestId
 133           in: header
 134           description: RequestID for http transaction
 135           schema:
 136             type: string
 137             format: uuid
 138       responses:
 139         202:
 140           description: Accepted, the request has been accepted and forwarded to participants
 141           headers:
 142             X-LatestVersion:
 143               $ref: '#/components/headers/X-LatestVersion'
 144             X-PatchVersion:
 145               $ref: '#/components/headers/X-PatchVersion'
 146             X-MinorVersion:
 147               $ref: '#/components/headers/X-MinorVersion'
 148             X-onap-RequestId:
 149               $ref: '#/components/headers/X-onap-RequestId'
 150         400:
 151           description: Bad Request, returns an instance of
 152             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 153           headers:
 154             X-LatestVersion:
 155               $ref: '#/components/headers/X-LatestVersion'
 156             X-PatchVersion:
 157               $ref: '#/components/headers/X-PatchVersion'
 158             X-MinorVersion:
 159               $ref: '#/components/headers/X-MinorVersion'
 160             X-onap-RequestId:
 161               $ref: '#/components/headers/X-onap-RequestId'
 162           content:
 163             application/json:
 164               schema:
 165                 $ref: '#/components/schemas/SimpleResponse'
 166         401:
 167           description: Authentication Error, returns an instance of
 168             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 169           headers:
 170             X-LatestVersion:
 171               $ref: '#/components/headers/X-LatestVersion'
 172             X-PatchVersion:
 173               $ref: '#/components/headers/X-PatchVersion'
 174             X-MinorVersion:
 175               $ref: '#/components/headers/X-MinorVersion'
 176             X-onap-RequestId:
 177               $ref: '#/components/headers/X-onap-RequestId'
 178           content:
 179             application/json:
 180               schema:
 181                 $ref: '#/components/schemas/SimpleResponse'
 182       security:
 183         - basicAuth: []
 184       x-interface info:
 185         api-version: 1.0.0
 186         last-mod-release: London
 187       x-codegen-request-body-name: body
 188   /participants/{participantId}:
 189     get:
 190       tags:
 191         - Participant Monitoring
 192       summary: Get details of the requested participant
 193         definitions
 194       description: Get details of the requested commissioned participant, returning all pariticipant details
 195       operationId: getParticipant
 196       parameters:
 197         - name : participantId
 198           in: path
 199           description: The UUID of the participant to get
 200           required: true
 201           schema:
 202             type: string
 203             format: uuid
 204         - name: X-onap-RequestId
 205           in: header
 206           description: RequestID for http transaction
 207           schema:
 208             type: string
 209             format: uuid
 210       responses:
 211         200:
 212           description: Serialised instance of
 213             [ParticipantInformation](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/ParticipantInformation.java)
 214             that information on the participant with its information and status. The participant entry contains
 215             a list of AC Element types on the participant. Each AC Element type entry contains a list of AC Element
 216             instances on the Participant.
 217           headers:
 218             X-LatestVersion:
 219               $ref: '#/components/headers/X-LatestVersion'
 220             X-PatchVersion:
 221               $ref: '#/components/headers/X-PatchVersion'
 222             X-MinorVersion:
 223               $ref: '#/components/headers/X-MinorVersion'
 224             X-onap-RequestId:
 225               $ref: '#/components/headers/X-onap-RequestId'
 226           content:
 227             application/json:
 228               schema:
 229                 $ref: '#/components/schemas/ParticipantInformation'
 230               example:
 231                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleParticipantResponse.json'
 232             application/yaml:
 233               schema:
 234                 $ref: '#/components/schemas/ToscaServiceTemplate'
 235               example:
 236                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getParticipantResponse.yaml'
 237         401:
 238           description: Authentication Error, returns an instance of
 239             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 240           headers:
 241             X-LatestVersion:
 242               $ref: '#/components/headers/X-LatestVersion'
 243             X-PatchVersion:
 244               $ref: '#/components/headers/X-PatchVersion'
 245             X-MinorVersion:
 246               $ref: '#/components/headers/X-MinorVersion'
 247             X-onap-RequestId:
 248               $ref: '#/components/headers/X-onap-RequestId'
 249           content:
 250             application/json:
 251               schema:
 252                 $ref: '#/components/schemas/SimpleResponse'
 253         404:
 254           description: Specified participant not found, returns an instance of
 255             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 256           headers:
 257             X-LatestVersion:
 258               $ref: '#/components/headers/X-LatestVersion'
 259             X-PatchVersion:
 260               $ref: '#/components/headers/X-PatchVersion'
 261             X-MinorVersion:
 262               $ref: '#/components/headers/X-MinorVersion'
 263             X-onap-RequestId:
 264               $ref: '#/components/headers/X-onap-RequestId'
 265           content:
 266             application/json:
 267               schema:
 268                 $ref: '#/components/schemas/SimpleResponse'
 269       security:
 270         - basicAuth: []
 271       x-interface info:
 272         api-version: 1.0.0
 273         last-mod-release: London
 274     put:
 275       tags:
 276         - Participant Monitoring
 277       summary: Order an immendiate Participant Report from a participant
 278       description: Requests the participants to immediately generate a heartbeat report with its information and status
 279         and the information and status of all its AC Element Types and Instances. The results are published on subsequent
 280         GET REST requests on the "participants" endpoint.
 281       operationId: orderParticipantReport
 282       parameters:
 283         - name : participantId
 284           in: path
 285           description: The UUID of the participant to get
 286           required: true
 287           schema:
 288             type: string
 289             format: uuid
 290         - name: X-onap-RequestId
 291           in: header
 292           description: RequestID for http transaction
 293           schema:
 294             type: string
 295             format: uuid
 296       responses:
 297         202:
 298           description: Accepted, the request has been accepted and forwarded to participants
 299           headers:
 300             X-LatestVersion:
 301               $ref: '#/components/headers/X-LatestVersion'
 302             X-PatchVersion:
 303               $ref: '#/components/headers/X-PatchVersion'
 304             X-MinorVersion:
 305               $ref: '#/components/headers/X-MinorVersion'
 306             X-onap-RequestId:
 307               $ref: '#/components/headers/X-onap-RequestId'
 308         400:
 309           description: Bad Request, returns an instance of
 310             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 311           headers:
 312             X-LatestVersion:
 313               $ref: '#/components/headers/X-LatestVersion'
 314             X-PatchVersion:
 315               $ref: '#/components/headers/X-PatchVersion'
 316             X-MinorVersion:
 317               $ref: '#/components/headers/X-MinorVersion'
 318             X-onap-RequestId:
 319               $ref: '#/components/headers/X-onap-RequestId'
 320           content:
 321             application/json:
 322               schema:
 323                 $ref: '#/components/schemas/SimpleResponse'
 324         401:
 325           description: Authentication Error, returns an instance of
 326             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 327           headers:
 328             X-LatestVersion:
 329               $ref: '#/components/headers/X-LatestVersion'
 330             X-PatchVersion:
 331               $ref: '#/components/headers/X-PatchVersion'
 332             X-MinorVersion:
 333               $ref: '#/components/headers/X-MinorVersion'
 334             X-onap-RequestId:
 335               $ref: '#/components/headers/X-onap-RequestId'
 336           content:
 337             application/json:
 338               schema:
 339                 $ref: '#/components/schemas/SimpleResponse'
 340         404:
 341           description: Specified participant not found, returns an instance of
 342             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 343           headers:
 344             X-LatestVersion:
 345               $ref: '#/components/headers/X-LatestVersion'
 346             X-PatchVersion:
 347               $ref: '#/components/headers/X-PatchVersion'
 348             X-MinorVersion:
 349               $ref: '#/components/headers/X-MinorVersion'
 350             X-onap-RequestId:
 351               $ref: '#/components/headers/X-onap-RequestId'
 352           content:
 353             application/json:
 354               schema:
 355                 $ref: '#/components/schemas/SimpleResponse'
 356       security:
 357         - basicAuth: []
 358       x-interface info:
 359         api-version: 1.0.0
 360         last-mod-release: London
 361       x-codegen-request-body-name: body
 362   /compositions:
 363     get:
 364       tags:
 365         - Automation Composition Definition
 366       summary: Query the commissioned automation composition definitions
 367         definitions
 368       description: Query the commissioned automation composition
 369         definitions, returning the automation composition details
 370       operationId: queryCompositionDefinitions
 371       parameters:
 372         - name: name
 373           in: query
 374           required: false
 375           description: Automation composition definition name. Regular expressions are supported for filtering. If
 376             this parameter is not specified, all automation composition definitions are returned.
 377           schema:
 378             type: string
 379         - name: version
 380           in: query
 381           required: false
 382           description: Automation composition definition version. Regular expressions are supported for filtering. If this
 383             parameter is not specified, all automation composition definitions that match the "name" filter are are returned.
 384           schema:
 385             type: string
 386         - name: X-onap-RequestId
 387           in: header
 388           description: RequestID for http transaction
 389           schema:
 390             type: string
 391             format: uuid
 392       responses:
 393         200:
 394           description: Serialised instance of
 395             [ToscaServiceTemplates](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplates.java)
 396             that contains the automation composition definitions that match the requested filters.
 397           headers:
 398             X-LatestVersion:
 399               $ref: '#/components/headers/X-LatestVersion'
 400             X-PatchVersion:
 401               $ref: '#/components/headers/X-PatchVersion'
 402             X-MinorVersion:
 403               $ref: '#/components/headers/X-MinorVersion'
 404             X-onap-RequestId:
 405               $ref: '#/components/headers/X-onap-RequestId'
 406           content:
 407             application/json:
 408               schema:
 409                 $ref: '#/components/schemas/ToscaServiceTemplates'
 410               example:
 411                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json'
 412             application/yaml:
 413               schema:
 414                 $ref: '#/components/schemas/ToscaServiceTemplates'
 415               example:
 416                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.yaml'
 417         401:
 418           description: Authentication Error, returns an instance of
 419             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 420           headers:
 421             X-LatestVersion:
 422               $ref: '#/components/headers/X-LatestVersion'
 423             X-PatchVersion:
 424               $ref: '#/components/headers/X-PatchVersion'
 425             X-MinorVersion:
 426               $ref: '#/components/headers/X-MinorVersion'
 427             X-onap-RequestId:
 428               $ref: '#/components/headers/X-onap-RequestId'
 429           content:
 430             application/json:
 431               schema:
 432                 $ref: '#/components/schemas/SimpleResponse'
 433       security:
 434         - basicAuth: []
 435       x-interface info:
 436         api-version: 1.0.0
 437         last-mod-release: London
 438     post:
 439       tags:
 440         - Automation Composition Definition
 441       summary: Commissions automation composition definitions
 442       description: Commissions automation composition definitions, returning the UUIDs of
 443         automation composition definitions commissioned by this request.
 444       operationId: createCompositionDefinitions
 445       parameters:
 446         - name: X-onap-RequestId
 447           in: header
 448           description: RequestID for http transaction
 449           schema:
 450             type: string
 451             format: uuid
 452       requestBody:
 453         description: Serialised instance of
 454           [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
 455           containing the automation composition definitions to be commissioned.
 456         content:
 457           application/json:
 458             schema:
 459               $ref: '#/components/schemas/ToscaServiceTemplate'
 460             example:
 461               externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.json'
 462           application/yaml:
 463             schema:
 464               $ref: '#/components/schemas/ToscaServiceTemplate'
 465             example:
 466               externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml'
 467         required: true
 468       responses:
 469         201:
 470           description: Serialised instance of
 471             [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
 472             containing the UUIDs of automation composition definitions created by this request
 473           headers:
 474             X-LatestVersion:
 475               $ref: '#/components/headers/X-LatestVersion'
 476             X-PatchVersion:
 477               $ref: '#/components/headers/X-PatchVersion'
 478             X-MinorVersion:
 479               $ref: '#/components/headers/X-MinorVersion'
 480             X-onap-RequestId:
 481               $ref: '#/components/headers/X-onap-RequestId'
 482           content:
 483             application/json:
 484               schema:
 485                 $ref: '#/components/schemas/CommissioningResponse'
 486               example:
 487                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.json'
 488             application/yaml:
 489               schema:
 490                 $ref: '#/components/schemas/CommissioningResponse'
 491               example:
 492                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml'
 493         401:
 494           description: Authentication Error, returns an instance of
 495             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 496           headers:
 497             X-LatestVersion:
 498               $ref: '#/components/headers/X-LatestVersion'
 499             X-PatchVersion:
 500               $ref: '#/components/headers/X-PatchVersion'
 501             X-MinorVersion:
 502               $ref: '#/components/headers/X-MinorVersion'
 503             X-onap-RequestId:
 504               $ref: '#/components/headers/X-onap-RequestId'
 505           content:
 506             application/json:
 507               schema:
 508                 $ref: '#/components/schemas/SimpleResponse'
 509         400:
 510           description: Bad Request, returns an instance of
 511             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 512           headers:
 513             X-LatestVersion:
 514               $ref: '#/components/headers/X-LatestVersion'
 515             X-PatchVersion:
 516               $ref: '#/components/headers/X-PatchVersion'
 517             X-MinorVersion:
 518               $ref: '#/components/headers/X-MinorVersion'
 519             X-onap-RequestId:
 520               $ref: '#/components/headers/X-onap-RequestId'
 521           content:
 522             application/json:
 523               schema:
 524                 $ref: '#/components/schemas/SimpleResponse'
 525       security:
 526         - basicAuth: []
 527       x-interface info:
 528         api-version: 1.0.0
 529         last-mod-release: London
 530       x-codegen-request-body-name: body
 531   /compositions/{compositionId}:
 532     get:
 533       tags:
 534         - Automation Composition Definition
 535       summary: Get details of the requested commissioned automation composition
 536         definitions
 537       description: Get details of the requested commissioned automation composition
 538         definitions, returning all automation composition details
 539       operationId: getCompositionDefinition
 540       parameters:
 541         - name : compositionId
 542           in: path
 543           description: The UUID of the automation composition definition to get
 544           required: true
 545           schema:
 546             type: string
 547             format: uuid
 548         - name: X-onap-RequestId
 549           in: header
 550           description: RequestID for http transaction
 551           schema:
 552             type: string
 553             format: uuid
 554       responses:
 555         200:
 556           description:
 557             Serialised instance of
 558             [AutomationCompositionDefinition](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositionDefinition.java)
 559             containing the requested automation composition definition.
 560           headers:
 561             X-LatestVersion:
 562               $ref: '#/components/headers/X-LatestVersion'
 563             X-PatchVersion:
 564               $ref: '#/components/headers/X-PatchVersion'
 565             X-MinorVersion:
 566               $ref: '#/components/headers/X-MinorVersion'
 567             X-onap-RequestId:
 568               $ref: '#/components/headers/X-onap-RequestId'
 569           content:
 570             application/json:
 571               schema:
 572                 $ref: '#/components/schemas/AutomationCompositionDefinition'
 573               example:
 574                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json'
 575             application/yaml:
 576               schema:
 577                 $ref: '#/components/schemas/AutomationCompositionDefinition'
 578               example:
 579                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml'
 580         401:
 581           description: Authentication Error, returns an instance of
 582             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 583           headers:
 584             X-LatestVersion:
 585               $ref: '#/components/headers/X-LatestVersion'
 586             X-PatchVersion:
 587               $ref: '#/components/headers/X-PatchVersion'
 588             X-MinorVersion:
 589               $ref: '#/components/headers/X-MinorVersion'
 590             X-onap-RequestId:
 591               $ref: '#/components/headers/X-onap-RequestId'
 592           content:
 593             application/json:
 594               schema:
 595                 $ref: '#/components/schemas/SimpleResponse'
 596         404:
 597           description: Specified automation composition definition not found, returns an instance of
 598             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 599           headers:
 600             X-LatestVersion:
 601               $ref: '#/components/headers/X-LatestVersion'
 602             X-PatchVersion:
 603               $ref: '#/components/headers/X-PatchVersion'
 604             X-MinorVersion:
 605               $ref: '#/components/headers/X-MinorVersion'
 606             X-onap-RequestId:
 607               $ref: '#/components/headers/X-onap-RequestId'
 608           content:
 609             application/json:
 610               schema:
 611                 $ref: '#/components/schemas/SimpleResponse'
 612       security:
 613         - basicAuth: []
 614       x-interface info:
 615         api-version: 1.0.0
 616         last-mod-release: London
 617     put:
 618       tags:
 619         - Automation Composition Definition
 620       summary: Primes or deprimes an automation composition definition
 621       description: Primes or deprimes an automation composition definition by sending the AC Element Types to participants and
 622         getting participants to take responsibility for AC Element Types in this AC Type.
 623       operationId: compositionDefinitionPriming
 624       parameters:
 625         - name : compositionId
 626           in: path
 627           description: The UUID of the automation composition definition to update
 628           required: true
 629           schema:
 630             type: string
 631             format: uuid
 632         - name: X-onap-RequestId
 633           in: header
 634           description: RequestID for http transaction
 635           schema:
 636             type: string
 637             format: uuid
 638       requestBody:
 639         description: Serialised instance of
 640           [AcTypeStateUpdate](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/AcTypeStateUpdate.java)
 641           which specifies the requested state change on the automation concept instance
 642         content:
 643           application/json:
 644             schema:
 645               $ref: '#/components/schemas/AcTypeStateUpdate'
 646             example:
 647               externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.json'
 648           application/yaml:
 649             schema:
 650               $ref: '#/components/schemas/AcTypeStateUpdate'
 651             example:
 652               externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.yaml'
 653       responses:
 654         202:
 655           description: Accepted, the request has been accepted and forwarded to participants
 656           headers:
 657             X-LatestVersion:
 658               $ref: '#/components/headers/X-LatestVersion'
 659             X-PatchVersion:
 660               $ref: '#/components/headers/X-PatchVersion'
 661             X-MinorVersion:
 662               $ref: '#/components/headers/X-MinorVersion'
 663             X-onap-RequestId:
 664               $ref: '#/components/headers/X-onap-RequestId'
 665         400:
 666           description: Bad Request, returns an instance of
 667             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 668           headers:
 669             X-LatestVersion:
 670               $ref: '#/components/headers/X-LatestVersion'
 671             X-PatchVersion:
 672               $ref: '#/components/headers/X-PatchVersion'
 673             X-MinorVersion:
 674               $ref: '#/components/headers/X-MinorVersion'
 675             X-onap-RequestId:
 676               $ref: '#/components/headers/X-onap-RequestId'
 677           content:
 678             application/json:
 679               schema:
 680                 $ref: '#/components/schemas/SimpleResponse'
 681         401:
 682           description: Authentication Error, returns an instance of
 683             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 684           headers:
 685             X-LatestVersion:
 686               $ref: '#/components/headers/X-LatestVersion'
 687             X-PatchVersion:
 688               $ref: '#/components/headers/X-PatchVersion'
 689             X-MinorVersion:
 690               $ref: '#/components/headers/X-MinorVersion'
 691             X-onap-RequestId:
 692               $ref: '#/components/headers/X-onap-RequestId'
 693           content:
 694             application/json:
 695               schema:
 696                 $ref: '#/components/schemas/SimpleResponse'
 697         404:
 698           description: Specified automation composition definition not found, returns an instance of
 699             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 700           headers:
 701             X-LatestVersion:
 702               $ref: '#/components/headers/X-LatestVersion'
 703             X-PatchVersion:
 704               $ref: '#/components/headers/X-PatchVersion'
 705             X-MinorVersion:
 706               $ref: '#/components/headers/X-MinorVersion'
 707             X-onap-RequestId:
 708               $ref: '#/components/headers/X-onap-RequestId'
 709           content:
 710             application/json:
 711               schema:
 712                 $ref: '#/components/schemas/SimpleResponse'
 713       security:
 714         - basicAuth: []
 715       x-interface info:
 716         api-version: 1.0.0
 717         last-mod-release: London
 718       x-codegen-request-body-name: body
 719     delete:
 720       tags:
 721         - Automation Composition Definition
 722       summary: Delete a commissioned automation composition definition
 723       description: Deletes a commissioned automation composition definition,returning the UUID of the automation composition definition deleted by this request
 724       operationId: deleteCompositionDefinition
 725       parameters:
 726         - name : compositionId
 727           in: path
 728           description: The UUID of the automation composition definition to delete
 729           required: true
 730           schema:
 731             type: string
 732             format: uuid
 733         - name: X-onap-RequestId
 734           in: header
 735           description: RequestID for http transaction
 736           schema:
 737             type: string
 738             format: uuid
 739       responses:
 740         200:
 741           description: Serialised instance of
 742             [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
 743             containing the UUID of the automation composition deleted by this request
 744           headers:
 745             X-LatestVersion:
 746               $ref: '#/components/headers/X-LatestVersion'
 747             X-PatchVersion:
 748               $ref: '#/components/headers/X-PatchVersion'
 749             X-MinorVersion:
 750               $ref: '#/components/headers/X-MinorVersion'
 751             X-onap-RequestId:
 752               $ref: '#/components/headers/X-onap-RequestId'
 753           content:
 754             application/json:
 755               schema:
 756                 $ref: '#/components/schemas/CommissioningResponse'
 757               example:
 758                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json'
 759             application/yaml:
 760               schema:
 761                 $ref: '#/components/schemas/CommissioningResponse'
 762               example:
 763                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml'
 764         401:
 765           description: Authentication Error, returns an instance of
 766             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 767           headers:
 768             X-LatestVersion:
 769               $ref: '#/components/headers/X-LatestVersion'
 770             X-PatchVersion:
 771               $ref: '#/components/headers/X-PatchVersion'
 772             X-MinorVersion:
 773               $ref: '#/components/headers/X-MinorVersion'
 774             X-onap-RequestId:
 775               $ref: '#/components/headers/X-onap-RequestId'
 776           content:
 777             application/json:
 778               schema:
 779                 $ref: '#/components/schemas/SimpleResponse'
 780         404:
 781           description: Specified automation composition definition not found, returns an instance of
 782             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 783           headers:
 784             X-LatestVersion:
 785               $ref: '#/components/headers/X-LatestVersion'
 786             X-PatchVersion:
 787               $ref: '#/components/headers/X-PatchVersion'
 788             X-MinorVersion:
 789               $ref: '#/components/headers/X-MinorVersion'
 790             X-onap-RequestId:
 791               $ref: '#/components/headers/X-onap-RequestId'
 792           content:
 793             application/json:
 794               schema:
 795                 $ref: '#/components/schemas/SimpleResponse'
 796         400:
 797           description: Bad Request, returns an instance of
 798             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 799           headers:
 800             X-LatestVersion:
 801               $ref: '#/components/headers/X-LatestVersion'
 802             X-PatchVersion:
 803               $ref: '#/components/headers/X-PatchVersion'
 804             X-MinorVersion:
 805               $ref: '#/components/headers/X-MinorVersion'
 806             X-onap-RequestId:
 807               $ref: '#/components/headers/X-onap-RequestId'
 808           content:
 809             application/json:
 810               schema:
 811                 $ref: '#/components/schemas/SimpleResponse'
 812       security:
 813         - basicAuth: []
 814       x-interface info:
 815         api-version: 1.0.0
 816         last-mod-release: London
 817   /compositions/{compositionId}/instances:
 818     get:
 819       tags:
 820         - Automation Composition Instance
 821       summary: Query details of the requested automation composition instances
 822       description: Query details of the requested automation composition instances for the given automation composition definition ID, returning
 823         details of all its automation composition instances
 824       operationId: queryCompositionInstances
 825       parameters:
 826         - name : compositionId
 827           in: path
 828           description: The UUID of the automation composition definition for which to return instances
 829           required: true
 830           schema:
 831             type: string
 832             format: uuid
 833         - name: name
 834           in: query
 835           description: Automation composition instance name. Regular expressions are supported for filtering. If
 836             this parameter is not specified, all automation composition instances for the specified definition are returned.
 837           schema:
 838             type: string
 839         - name: version
 840           in: query
 841           description: Automation composition instance version. Regular expressions are supported for filtering. If this
 842             parameter is not specified, all automation composition instances for the specified definition that match the "name" filter are are returned.
 843           schema:
 844             type: string
 845         - name: X-onap-RequestId
 846           in: header
 847           description: RequestID for http transaction
 848           schema:
 849             type: string
 850             format: uuid
 851       responses:
 852         200:
 853           description: Serialised instance of
 854             [AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
 855             containing a list of automation composition instances found
 856           headers:
 857             X-LatestVersion:
 858               $ref: '#/components/headers/X-LatestVersion'
 859             X-PatchVersion:
 860               $ref: '#/components/headers/X-PatchVersion'
 861             X-MinorVersion:
 862               $ref: '#/components/headers/X-MinorVersion'
 863             X-onap-RequestId:
 864               $ref: '#/components/headers/X-onap-RequestId'
 865           content:
 866             application/json:
 867               schema:
 868                 $ref: '#/components/schemas/AutomationCompositions'
 869               example:
 870                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json'
 871             application/yaml:
 872               schema:
 873                 $ref: '#/components/schemas/AutomationCompositions'
 874               example:
 875                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml'
 876         401:
 877           description: Authentication Error, returns an instance of
 878             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 879           headers:
 880             X-LatestVersion:
 881               $ref: '#/components/headers/X-LatestVersion'
 882             X-PatchVersion:
 883               $ref: '#/components/headers/X-PatchVersion'
 884             X-MinorVersion:
 885               $ref: '#/components/headers/X-MinorVersion'
 886             X-onap-RequestId:
 887               $ref: '#/components/headers/X-onap-RequestId'
 888           content:
 889             application/json:
 890               schema:
 891                 $ref: '#/components/schemas/SimpleResponse'
 892         404:
 893           description: The specified automation composition definition was not found, returns an instance of
 894             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 895           headers:
 896             X-LatestVersion:
 897               $ref: '#/components/headers/X-LatestVersion'
 898             X-PatchVersion:
 899               $ref: '#/components/headers/X-PatchVersion'
 900             X-MinorVersion:
 901               $ref: '#/components/headers/X-MinorVersion'
 902             X-onap-RequestId:
 903               $ref: '#/components/headers/X-onap-RequestId'
 904           content:
 905             application/json:
 906               schema:
 907                 $ref: '#/components/schemas/SimpleResponse'
 908       security:
 909         - basicAuth: []
 910       x-interface info:
 911         api-version: 1.0.0
 912         last-mod-release: London
 913     post:
 914       tags:
 915         - Automation Composition Instance
 916       summary: Create automation composition instance
 917       description: Creates automation composition instance that use the sepcified automation composition definition. The ID of the created
 918         automation composition instance is returned.
 919       operationId: createCompositionInstance
 920       parameters:
 921         - name : compositionId
 922           in: path
 923           description: The UUID of the automation composition definition on which to create instance
 924           required: true
 925           schema:
 926             type: string
 927             format: uuid
 928         - name: X-onap-RequestId
 929           in: header
 930           description: RequestID for http transaction
 931           schema:
 932             type: string
 933             format: uuid
 934       requestBody:
 935         description: Serialised instance of
 936           [AutomationComposition](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationComposition.java)
 937           containing a automation composition instance to create
 938         content:
 939           application/json:
 940             schema:
 941               $ref: '#/components/schemas/AutomationComposition'
 942             example:
 943               externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.json'
 944           application/yaml:
 945             schema:
 946               $ref: '#/components/schemas/AutomationComposition'
 947             example:
 948               externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.yaml'
 949         required: true
 950       responses:
 951         201:
 952           description: Serialised instance of
 953             [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
 954             containing the UUID of the created automation composition instance
 955           headers:
 956             X-LatestVersion:
 957               $ref: '#/components/headers/X-LatestVersion'
 958             X-PatchVersion:
 959               $ref: '#/components/headers/X-PatchVersion'
 960             X-MinorVersion:
 961               $ref: '#/components/headers/X-MinorVersion'
 962             X-onap-RequestId:
 963               $ref: '#/components/headers/X-onap-RequestId'
 964           content:
 965             application/json:
 966               schema:
 967                 $ref: '#/components/schemas/InstantiationResponse'
 968               example:
 969                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json'
 970             application/yaml:
 971               schema:
 972                 $ref: '#/components/schemas/InstantiationResponse'
 973               example:
 974                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml'
 975         401:
 976           description: Authentication Error, returns an instance of
 977             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 978           headers:
 979             X-LatestVersion:
 980               $ref: '#/components/headers/X-LatestVersion'
 981             X-PatchVersion:
 982               $ref: '#/components/headers/X-PatchVersion'
 983             X-MinorVersion:
 984               $ref: '#/components/headers/X-MinorVersion'
 985             X-onap-RequestId:
 986               $ref: '#/components/headers/X-onap-RequestId'
 987           content:
 988             application/json:
 989               schema:
 990                 $ref: '#/components/schemas/SimpleResponse'
 991         404:
 992           description: The specified automation composition definition was not found, returns an instance of
 993             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
 994           headers:
 995             X-LatestVersion:
 996               $ref: '#/components/headers/X-LatestVersion'
 997             X-PatchVersion:
 998               $ref: '#/components/headers/X-PatchVersion'
 999             X-MinorVersion:
1000               $ref: '#/components/headers/X-MinorVersion'
1001             X-onap-RequestId:
1002               $ref: '#/components/headers/X-onap-RequestId'
1003           content:
1004             application/json:
1005               schema:
1006                 $ref: '#/components/schemas/SimpleResponse'
1007         400:
1008           description: Bad Request, returns an instance of
1009             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1010           headers:
1011             X-LatestVersion:
1012               $ref: '#/components/headers/X-LatestVersion'
1013             X-PatchVersion:
1014               $ref: '#/components/headers/X-PatchVersion'
1015             X-MinorVersion:
1016               $ref: '#/components/headers/X-MinorVersion'
1017             X-onap-RequestId:
1018               $ref: '#/components/headers/X-onap-RequestId'
1019           content:
1020             application/json:
1021               schema:
1022                 $ref: '#/components/schemas/SimpleResponse'
1023       security:
1024         - basicAuth: []
1025       x-interface info:
1026         api-version: 1.0.0
1027         last-mod-release: London
1028       x-codegen-request-body-name: body
1029   /compositions/{compositionId}/instances/{instanceId}:
1030     get:
1031       tags:
1032         - Automation Composition Instance
1033       summary: Get automation composition instance details.
1034       description: Get details of the requested automation composition instance.
1035       operationId: getCompositionInstance
1036       parameters:
1037         - name : compositionId
1038           in: path
1039           description: The UUID of the automation composition definition on which to get an instance
1040           required: true
1041           schema:
1042             type: string
1043             format: uuid
1044         - name : instanceId
1045           in: path
1046           description: The UUID of the automation composition instance to get
1047           required: true
1048           schema:
1049             type: string
1050             format: uuid
1051         - name: X-onap-RequestId
1052           in: header
1053           description: RequestID for http transaction
1054           schema:
1055             type: string
1056             format: uuid
1057       responses:
1058         200:
1059           description: Serialised instance of
1060             [AutomationComposition](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationComposition.java)
1061             containing the automation composition instance
1062           headers:
1063             X-LatestVersion:
1064               $ref: '#/components/headers/X-LatestVersion'
1065             X-PatchVersion:
1066               $ref: '#/components/headers/X-PatchVersion'
1067             X-MinorVersion:
1068               $ref: '#/components/headers/X-MinorVersion'
1069             X-onap-RequestId:
1070               $ref: '#/components/headers/X-onap-RequestId'
1071           content:
1072             application/json:
1073               schema:
1074                 $ref: '#/components/schemas/AutomationComposition'
1075               example:
1076                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.json'
1077             application/yaml:
1078               schema:
1079                 $ref: '#/components/schemas/AutomationComposition'
1080               example:
1081                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.yaml'
1082         401:
1083           description: Authentication Error, returns an instance of
1084             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1085           headers:
1086             X-LatestVersion:
1087               $ref: '#/components/headers/X-LatestVersion'
1088             X-PatchVersion:
1089               $ref: '#/components/headers/X-PatchVersion'
1090             X-MinorVersion:
1091               $ref: '#/components/headers/X-MinorVersion'
1092             X-onap-RequestId:
1093               $ref: '#/components/headers/X-onap-RequestId'
1094           content:
1095             application/json:
1096               schema:
1097                 $ref: '#/components/schemas/SimpleResponse'
1098         404:
1099           description: The automation composition instance was not found, returns an instance of
1100             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1101           headers:
1102             X-LatestVersion:
1103               $ref: '#/components/headers/X-LatestVersion'
1104             X-PatchVersion:
1105               $ref: '#/components/headers/X-PatchVersion'
1106             X-MinorVersion:
1107               $ref: '#/components/headers/X-MinorVersion'
1108             X-onap-RequestId:
1109               $ref: '#/components/headers/X-onap-RequestId'
1110           content:
1111             application/json:
1112               schema:
1113                 $ref: '#/components/schemas/SimpleResponse'
1114       security:
1115         - basicAuth: []
1116       x-interface info:
1117         api-version: 1.0.0
1118         last-mod-release: London
1119     put:
1120       tags:
1121         - Automation Composition Instance
1122       summary: Manage deployment and locking of an automation composition instance
1123       description: This request manages deployment and locking of an automation composition instance. This endpoint can
1124         order deployment and undeployment of an AC Instance to participants and order unlocking and locking of AC instances
1125         on participants
1126       operationId: compositionInstanceState
1127       parameters:
1128         - name : compositionId
1129           in: path
1130           description: The UUID of the automation composition definition on which to update an instance
1131           required: true
1132           schema:
1133             type: string
1134             format: uuid
1135         - name : instanceId
1136           in: path
1137           description: The UUID of the automation composition instance to update
1138           required: true
1139           schema:
1140             type: string
1141             format: uuid
1142         - name: X-onap-RequestId
1143           in: header
1144           description: RequestID for http transaction
1145           schema:
1146             type: string
1147             format: uuid
1148       requestBody:
1149         description: Serialised instance of
1150           [AcInstanceStateUpdate](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/AcInstanceStateUpdate.java)
1151           which specifies the requested state change on the automation concept instance
1152         content:
1153           application/json:
1154             schema:
1155               $ref: '#/components/schemas/AcInstanceStateUpdate'
1156             example:
1157               externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putAcInstanceStateUpdate.json'
1158           application/yaml:
1159             schema:
1160               $ref: '#/components/schemas/AcInstanceStateUpdate'
1161             example:
1162               externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putAcInstanceStateUpdate.yaml'
1163         required: true
1164       responses:
1165         202:
1166           description: Accepted, the request has been accepted and forwarded to participants
1167           headers:
1168             X-LatestVersion:
1169               $ref: '#/components/headers/X-LatestVersion'
1170             X-PatchVersion:
1171               $ref: '#/components/headers/X-PatchVersion'
1172             X-MinorVersion:
1173               $ref: '#/components/headers/X-MinorVersion'
1174             X-onap-RequestId:
1175               $ref: '#/components/headers/X-onap-RequestId'
1176         400:
1177           description: Bad Request, returns an instance of
1178             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1179           headers:
1180             X-LatestVersion:
1181               $ref: '#/components/headers/X-LatestVersion'
1182             X-PatchVersion:
1183               $ref: '#/components/headers/X-PatchVersion'
1184             X-MinorVersion:
1185               $ref: '#/components/headers/X-MinorVersion'
1186             X-onap-RequestId:
1187               $ref: '#/components/headers/X-onap-RequestId'
1188           content:
1189             application/json:
1190               schema:
1191                 $ref: '#/components/schemas/SimpleResponse'
1192         401:
1193           description: Authentication Error, returns an instance of
1194             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1195           headers:
1196             X-LatestVersion:
1197               $ref: '#/components/headers/X-LatestVersion'
1198             X-PatchVersion:
1199               $ref: '#/components/headers/X-PatchVersion'
1200             X-MinorVersion:
1201               $ref: '#/components/headers/X-MinorVersion'
1202             X-onap-RequestId:
1203               $ref: '#/components/headers/X-onap-RequestId'
1204           content:
1205             application/json:
1206               schema:
1207                 $ref: '#/components/schemas/SimpleResponse'
1208         404:
1209           description: The specified automation composition instance was not found, returns an instance of
1210             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1211           headers:
1212             X-LatestVersion:
1213               $ref: '#/components/headers/X-LatestVersion'
1214             X-PatchVersion:
1215               $ref: '#/components/headers/X-PatchVersion'
1216             X-MinorVersion:
1217               $ref: '#/components/headers/X-MinorVersion'
1218             X-onap-RequestId:
1219               $ref: '#/components/headers/X-onap-RequestId'
1220           content:
1221             application/json:
1222               schema:
1223                 $ref: '#/components/schemas/SimpleResponse'
1224       security:
1225         - basicAuth: []
1226       x-interface info:
1227         api-version: 1.0.0
1228         last-mod-release: London
1229       x-codegen-request-body-name: body
1230     delete:
1231       tags:
1232         - Automation Composition Instance
1233       summary: Delete an automation composition instance
1234       description: Deletes a automation composition instance, returning the UUID of the deleted automation composition instance
1235       operationId: deleteCompositionInstance
1236       parameters:
1237         - name : compositionId
1238           in: path
1239           description: The UUID of the automation composition definition on which to delete an instance
1240           required: true
1241           schema:
1242             type: string
1243             format: uuid
1244         - name : instanceId
1245           in: path
1246           description: The UUID of the automation composition instance to delete
1247           required: true
1248           schema:
1249             type: string
1250             format: uuid
1251         - name: X-onap-RequestId
1252           in: header
1253           description: RequestID for http transaction
1254           schema:
1255             type: string
1256             format: uuid
1257       responses:
1258         200:
1259           description: Serialised instance of
1260             [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
1261             containing the UUID of the deleted automation composition instance
1262           headers:
1263             X-LatestVersion:
1264               $ref: '#/components/headers/X-LatestVersion'
1265             X-PatchVersion:
1266               $ref: '#/components/headers/X-PatchVersion'
1267             X-MinorVersion:
1268               $ref: '#/components/headers/X-MinorVersion'
1269             X-onap-RequestId:
1270               $ref: '#/components/headers/X-onap-RequestId'
1271           content:
1272             application/json:
1273               schema:
1274                 $ref: '#/components/schemas/InstantiationResponse'
1275               example:
1276                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.json'
1277             application/yaml:
1278               schema:
1279                 $ref: '#/components/schemas/InstantiationResponse'
1280               example:
1281                 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml'
1282         401:
1283           description: Authentication Error, returns an instance of
1284             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1285           headers:
1286             X-LatestVersion:
1287               $ref: '#/components/headers/X-LatestVersion'
1288             X-PatchVersion:
1289               $ref: '#/components/headers/X-PatchVersion'
1290             X-MinorVersion:
1291               $ref: '#/components/headers/X-MinorVersion'
1292             X-onap-RequestId:
1293               $ref: '#/components/headers/X-onap-RequestId'
1294           content:
1295             application/json:
1296               schema:
1297                 $ref: '#/components/schemas/SimpleResponse'
1298         404:
1299           description: The specified automation composition instance was not found, returns an instance of
1300             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1301           headers:
1302             X-LatestVersion:
1303               $ref: '#/components/headers/X-LatestVersion'
1304             X-PatchVersion:
1305               $ref: '#/components/headers/X-PatchVersion'
1306             X-MinorVersion:
1307               $ref: '#/components/headers/X-MinorVersion'
1308             X-onap-RequestId:
1309               $ref: '#/components/headers/X-onap-RequestId'
1310           content:
1311             application/json:
1312               schema:
1313                 $ref: '#/components/schemas/SimpleResponse'
1314         400:
1315           description: Bad Request, returns an instance of
1316             [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1317           headers:
1318             X-LatestVersion:
1319               $ref: '#/components/headers/X-LatestVersion'
1320             X-PatchVersion:
1321               $ref: '#/components/headers/X-PatchVersion'
1322             X-MinorVersion:
1323               $ref: '#/components/headers/X-MinorVersion'
1324             X-onap-RequestId:
1325               $ref: '#/components/headers/X-onap-RequestId'
1326           content:
1327             application/json:
1328               schema:
1329                 $ref: '#/components/schemas/SimpleResponse'
1330       security:
1331         - basicAuth: []
1332       x-interface info:
1333         api-version: 1.0.0
1334         last-mod-release: London
1335
1336 components:
1337   securitySchemes:
1338     basicAuth:
1339       type: http
1340       scheme: basic
1341   schemas:
1342     ParticipantInformation:
1343       title: ParticipantInformation
1344       type: object
1345     ToscaServiceTemplates:
1346       title: ToscaServiceTemplates
1347       type: object
1348     ToscaServiceTemplate:
1349       title: ToscaServiceTemplate
1350       type: object
1351     AutomationCompositionDefinition:
1352       title: AutomationCompositionDefinition
1353       type: object
1354     AutomationComposition:
1355       title: AutomationComposition
1356       type: object
1357     AutomationCompositions:
1358       title: AutomationCompositions
1359       type: object
1360     SimpleResponse:
1361       title: SimpleResponse
1362       type: object
1363     CommissioningResponse:
1364       title: CommissioningResponse
1365       type: object
1366     AcTypeStateUpdate:
1367       title: AcTypeStateUpdate
1368       type: object
1369     AcInstanceStateUpdate:
1370       title: AcInstanceStateUpdate
1371       type: object
1372     InstantiationResponse:
1373       title: InstantiationResponse
1374       type: object
1375   headers:
1376     X-LatestVersion:
1377       schema:
1378         type: string
1379     X-PatchVersion:
1380       schema:
1381         type: string
1382     X-MinorVersion:
1383       schema:
1384         type: string
1385     X-onap-RequestId:
1386       schema:
1387         type: string
1388         format: uuid