Merge "Add ACM OpenApi Specifications"

1 files changed, 1167 insertions, 0 deletions

diff --git a/runtime-acm/src/main/resources/openapi/openapi.yaml b/runtime-acm/src/main/resources/openapi/openapi.yaml
new file mode 100644
index 000000000..5075ee5e6
--- /dev/null
+++ b/runtime-acm/src/main/resources/openapi/openapi.yaml
@@ -0,0 +1,1167 @@
+#  ============LICENSE_START=======================================================
+#  Copyright (C) 2022 Nordix Foundation
+#  ================================================================================
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+#  SPDX-License-Identifier: Apache-2.0
+#  ============LICENSE_END=========================================================
+openapi: 3.0.1
+info:
+  title: Api Documentation
+  description: Api Documentation
+  termsOfService: urn:tos
+  contact: {}
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0
+  version: "1.0"
+servers:
+  - url: https://{server}
+    variables:
+      server:
+        default: onap/acm/v3
+        description: This value is assigned by the service provider
+tags:
+- name: Automation Composition Controller
+  description: Automation Composition Controller
+
+paths:
+  /compositions:
+    get:
+      tags:
+      - Automation Composition Controller
+      summary: Query the commissioned automation composition definitions
+        definitions
+      description: Query the commissioned automation composition
+        definitions, returning the automation composition details
+      operationId: queryCompositionDefinitions
+      parameters:
+      - name: name
+        in: query
+        description: Automation composition definition name. Regular expressions are supported for filtering. If
+          this parameter is not specified, all automation composition definitions are returned.
+        schema:
+          type: string
+      - name: version
+        in: query
+        description: Automation composition definition version. Regular expressions are supported for filtering. If this
+          parameter is not specified, all automation composition definitions that match the "name" filter are are returned.
+        schema:
+          type: string
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      responses:
+        200:
+          description: Serialised instance of
+            [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
+            that contains the automation composition definitions that match the requested filters.
+          content:
+            application/json:
+              schema:
+                title: ToscaServiceTemplate
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json'
+            application/yaml:
+              schema:
+                title: ToscaServiceTemplate
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.yaml'
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: Not Found
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+    post:
+      tags:
+      - Automation Composition Controller
+      summary: Commissions automation composition definitions
+      description: Commissions automation composition definitions, returning the UUIDs of
+        automation composition definitions commissioned by this request.
+      operationId: createCompositionDefinitions
+      parameters:
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      requestBody:
+        description: Serialised instance of
+            [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
+            containing the automation composition definitions to be commissioned.
+        content:
+          application/json:
+            schema:
+              title: ToscaServiceTemplate
+              type: object
+            example:
+              externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.json'
+          application/yaml:
+            schema:
+              title: ToscaServiceTemplate
+              type: object
+            example:
+              externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml'
+        required: true
+      responses:
+        200:
+          description: Serialised instance of
+            [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
+            containing the UUIDs of automation composition definitions created by this request
+          content:
+            application/json:
+              schema:
+                title: CommissioningResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.json'
+            application/yaml:
+              schema:
+                title: CommissioningResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml'
+        201:
+          description: Created
+          content: {}
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: Not Found
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+      x-codegen-request-body-name: body
+  /compositions/{compositionId}:
+    get:
+      tags:
+      - Automation Composition Controller
+      summary: Get details of the requested commissioned automation composition
+        definitions
+      description: Get details of the requested commissioned automation composition
+        definitions, returning all automation composition details
+      operationId: getCompositionDefinition
+      parameters:
+      - name : compositionId
+        in: path
+        description: The UUID of the automation composition definition to get
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      responses:
+        200:
+          description:
+            Serialised instance of
+            [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
+            containing the requested automation composition definition.
+          content:
+            application/json:
+              schema:
+                title: ToscaServiceTemplate
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json'
+            application/yaml:
+              schema:
+                title: ToscaServiceTemplate
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml'
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: Specified automation composition definition not found
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+    put:
+      tags:
+      - Automation Composition Controller
+      summary: Update an automation composition definition
+      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
+      operationId: updateCompositionDefinition
+      parameters:
+      - name : compositionId
+        in: path
+        description: The UUID of the automation composition definition to update
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      requestBody:
+        description: Serialised instance of
+            [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
+          containing the changes to be made to the automation composition definition.
+        content:
+          application/json:
+            schema:
+              title: ToscaServiceTemplate
+              type: object
+            example:
+              externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.json'
+          application/yaml:
+            schema:
+              title: ToscaServiceTemplate
+              type: object
+            example:
+              externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.yaml'
+        required: true
+      responses:
+        200:
+          description: Serialised instance of
+            [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
+            containing the UUID of the automation composition updated by this request
+          content:
+            application/json:
+              schema:
+                title: CommissioningResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.json'
+            application/yaml:
+              schema:
+                title: CommissioningResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.yaml'
+        201:
+          description: Created
+          content: {}
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: Specified automation composition definition not found
+          content: {}
+        406:
+          description: Specified updates to the automation composition definition are not acceptable. See the content for error messages.
+          content: {}
+        409:
+          description: Specified updates to the automation composition definition would cause a conflict and are not allowed
+            because there are automation composition instances using this automation composition definition. See the content for error messages.
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+      x-codegen-request-body-name: body
+    delete:
+      tags:
+      - Automation Composition Controller
+      summary: Delete a commissioned automation composition definition
+      description: Deletes a commissioned automation composition definition,returning the UUID of the automation composition definition deleted by this request
+      operationId: deleteCompositionDefinition
+      parameters:
+      - name : compositionId
+        in: path
+        description: The UUID of the automation composition definition to delete
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      responses:
+        200:
+          description: Serialised instance of
+            [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
+            containing the UUID of the automation composition deleted by this request
+          content:
+            application/json:
+              schema:
+                title: CommissioningResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json'
+            application/yaml:
+              schema:
+                title: CommissioningResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml'
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: Specified automation composition definition not found
+          content: {}
+        409:
+          description: Deletion of the automation composition definition would cause a conflict and is not allowed
+            because there are automation composition instances using this automation composition definition.
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+  /compositions/{compositionId}/instances:
+    get:
+      tags:
+      - Automation Composition Controller
+      summary: Query details of the requested automation composition instances
+      description: Query details of the requested automation composition instances for the given automation composition definition ID, returning
+        details of all its automation composition instances
+      operationId: queryCompositionInstances
+      parameters:
+      - name : compositionId
+        in: path
+        description: The UUID of the automation composition definition for which to return instances
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name: name
+        in: query
+        description: Automation composition instance name. Regular expressions are supported for filtering. If
+          this parameter is not specified, all automation composition instances for the specified definition are returned.
+        schema:
+          type: string
+      - name: version
+        in: query
+        description: Automation composition instance version. Regular expressions are supported for filtering. If this
+          parameter is not specified, all automation composition instances for the specified definition that match the "name" filter are are returned.
+        schema:
+          type: string
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      responses:
+        200:
+          description: Serialised instance of
+            [AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
+            containing a list of automation composition instances found
+          content:
+            application/json:
+              schema:
+                title: AutomationCompositions
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json'
+            application/yaml:
+              schema:
+                title: AutomationCompositions
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml'
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: The specified automation composition definition was not found
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+    post:
+      tags:
+      - Automation Composition Controller
+      summary: Create automation composition instances
+      description: Creates automation composition instances that use the sepcified automation composition definition. The IDs of the created
+        automation composition instances are returned.
+      operationId: createCompositionInstances
+      parameters:
+      - name : compositionId
+        in: path
+        description: The UUID of the automation composition definition on which to create instances
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      requestBody:
+        description: Serialised instance of
+          [AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
+          containing a list of automation composition instances to create
+        content:
+          application/json:
+            schema:
+              title: AutomationCompositions
+              type: object
+            example:
+              externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.json'
+          application/yaml:
+            schema:
+              title: AutomationCompositions
+              type: object
+            example:
+              externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.yaml'
+        required: true
+      responses:
+        200:
+          description: Serialised instance of
+            [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
+            containing the UUIDs of the created automation composition instances
+          content:
+            application/json:
+              schema:
+                title: InstantiationResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json'
+            application/yaml:
+              schema:
+                title: InstantiationResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml'
+        201:
+          description: Created
+          content: {}
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: The specified automation composition definition was not found
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+      x-codegen-request-body-name: body
+  /compositions/{compositionId}/instances/{instanceId}:
+    get:
+      tags:
+      - Automation Composition Controller
+      summary: Get automation composition instance details.
+      description: Get details of the requested automation composition instance.
+      operationId: getCompositionInstance
+      parameters:
+      - name : compositionId
+        in: path
+        description: The UUID of the automation composition definition on which to get an instance
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name : instanceId
+        in: path
+        description: The UUID of the automation composition instance to get
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      responses:
+        200:
+          description: Serialised instance of
+            [AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
+            containing a list of automation composition instances with one entry
+          content:
+            application/json:
+              schema:
+                title: AutomationCompositions
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.json'
+            application/yaml:
+              schema:
+                title: AutomationCompositions
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.yaml'
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: The automation composition instance was not found
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+    put:
+      tags:
+      - Automation Composition Controller
+      summary: Update an automation composition instance
+      description: THis request updates an automation composition instance. It may update instance properties or change the state of the automation composition instance
+      operationId: updateCompositionInstance
+      parameters:
+      - name : compositionId
+        in: path
+        description: The UUID of the automation composition definition on which to update an instance
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name : instanceId
+        in: path
+        description: The UUID of the automation composition instance to update
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      requestBody:
+        description: Serialised instance of
+            [InstantiationUpdate](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationUpdate.java)
+            which specifies the update operation to be carried out on the automation concept instance
+        content:
+          application/json:
+            schema:
+              title: InstantiationUpdate
+              type: object
+            example:
+              externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.json'
+          application/yaml:
+            schema:
+              title: InstantiationUpdate
+              type: object
+            example:
+              externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.yaml'
+        required: true
+      responses:
+        200:
+          description: Serialised instance of
+            [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
+            containing the UUID of the updated automation composition instance
+          content:
+            application/json:
+              schema:
+                title: InstantiationResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.json'
+            application/yaml:
+              schema:
+                title: InstantiationResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.yaml'
+        201:
+          description: Created
+          content: {}
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: The specified automation composition instance was not found
+          content: {}
+        406:
+          description: Specified updates to the automation composition instance are not acceptable. See the content for error messages.
+          content: {}
+        409:
+          description: Update of this automation composition instance would cause a conflict because the automation composition instance is deployed.
+            Update is not allowed. See the content for error messages.
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+      x-codegen-request-body-name: body
+    delete:
+      tags:
+      - Automation Composition Controller
+      summary: Delete an automation composition instance
+      description: Deletes a automation composition instance, returning the UUID of the deleted automation composition instance
+      operationId: deleteCompositionInstance
+      parameters:
+      - name : compositionId
+        in: path
+        description: The UUID of the automation composition definition on which to delete an instance
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name : instanceId
+        in: path
+        description: The UUID of the automation composition instance to delete
+        required: true
+        schema:
+          type: string
+          format: uuid
+      - name: X-onap-RequestId
+        in: header
+        description: RequestID for http transaction
+        schema:
+          type: string
+          format: uuid
+      responses:
+        200:
+          description: Serialised instance of
+            [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
+            containing the UUID of the deleted automation composition instance
+          content:
+            application/json:
+              schema:
+                title: InstantiationResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.json'
+            application/yaml:
+              schema:
+                title: InstantiationResponse
+                type: object
+              example:
+                externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml'
+        401:
+          description: Authentication Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        403:
+          description: Authorization Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+        404:
+          description: The specified automation composition instance was not found
+          content: {}
+        409:
+          description: Deletion of this automation composition instance would cause a conflict because the automation composition instance is deployed.
+            Deletion is not allowed. See the content for error messages.
+          content: {}
+        500:
+          description: Internal Server Error
+          headers:
+            X-LatestVersion:
+              schema:
+                type: string
+            X-PatchVersion:
+              schema:
+                type: string
+            X-MinorVersion:
+              schema:
+                type: string
+            X-onap-RequestId:
+              schema:
+                type: string
+                format: uuid
+          content: {}
+      security:
+      - basicAuth: []
+      x-interface info:
+        api-version: 1.0.0
+        last-mod-release: London
+
+components:
+  securitySchemes:
+    basicAuth:
+      type: http
+      scheme: basic