diff options
author | FrancescoFioraEst <francesco.fiora@est.tech> | 2022-11-10 11:52:31 +0000 |
---|---|---|
committer | Francesco Fiora <francesco.fiora@est.tech> | 2022-11-10 13:43:01 +0000 |
commit | cfa51e6177b801fcf456390cdaea520b6378de39 (patch) | |
tree | 4023fa957d8b1430c26ed0ff60376c9852d6055d /runtime-acm | |
parent | 0e1635767afcc47566ec6971386500d75c66e821 (diff) |
Align Code Generation to Commissioned Automation Composition endpoints
Issue-ID: POLICY-4450
Change-Id: Ic1bbc83611c2fb743f71d1d7ddb735756a37a6e6
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
Diffstat (limited to 'runtime-acm')
-rw-r--r-- | runtime-acm/pom.xml | 8 | ||||
-rw-r--r-- | runtime-acm/src/main/resources/openapi/openapi.yaml | 564 |
2 files changed, 319 insertions, 253 deletions
diff --git a/runtime-acm/pom.xml b/runtime-acm/pom.xml index ea134683f..9aa89c090 100644 --- a/runtime-acm/pom.xml +++ b/runtime-acm/pom.xml @@ -67,12 +67,14 @@ <configuration> <inputSpec>${project.basedir}/src/main/resources/openapi/openapi.yaml</inputSpec> <invokerPackage>org.onap.acm.rest.controller</invokerPackage> - <modelPackage>org.onap.acm.rest.model</modelPackage> - <apiPackage>org.onap.acm.rest.api</apiPackage> + <modelPackage>org.onap.policy.clamp.models.acm.concepts</modelPackage> + <apiPackage>org.onap.policy.clamp.acm.runtime.main.rest</apiPackage> <language>spring</language> <generateModels>false</generateModels> <generateSupportingFiles>false</generateSupportingFiles> - <importMappings>InstancePropertiesResponse=org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstancePropertiesResponse, + <importMappings>ToscaServiceTemplates=org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplates, + SimpleResponse=org.onap.policy.clamp.models.acm.messages.rest.SimpleResponse, + InstancePropertiesResponse=org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstancePropertiesResponse, CommissioningResponse=org.onap.policy.clamp.models.acm.messages.rest.commissioning.CommissioningResponse, ToscaNodeTemplate=org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate, ToscaServiceTemplate=org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate, diff --git a/runtime-acm/src/main/resources/openapi/openapi.yaml b/runtime-acm/src/main/resources/openapi/openapi.yaml index dfa8ec6d1..a9f536de4 100644 --- a/runtime-acm/src/main/resources/openapi/openapi.yaml +++ b/runtime-acm/src/main/resources/openapi/openapi.yaml @@ -32,14 +32,14 @@ servers: default: onap/acm/v3 description: This value is assigned by the service provider tags: -- name: Automation Composition Controller +- name: Automation Composition Definition description: Automation Composition Controller paths: /compositions: get: tags: - - Automation Composition Controller + - Automation Composition Definition summary: Query the commissioned automation composition definitions definitions description: Query the commissioned automation composition @@ -69,21 +69,6 @@ paths: 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: @@ -98,29 +83,21 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error - headers: - X-LatestVersion: - schema: - type: string - X-PatchVersion: - schema: - type: string - X-MinorVersion: + content: + application/json: schema: - type: string - X-onap-RequestId: + title: ToscaServiceTemplate + type: ToscaServiceTemplates + example: + externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json' + application/yaml: schema: - type: string - format: uuid - content: {} - 404: - description: Not Found - content: {} - 500: - description: Internal Server Error + title: ToscaServiceTemplate + type: ToscaServiceTemplates + 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: @@ -135,7 +112,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -143,7 +124,7 @@ paths: last-mod-release: London post: tags: - - Automation Composition Controller + - Automation Composition Definition summary: Commissions automation composition definitions description: Commissions automation composition definitions, returning the UUIDs of automation composition definitions commissioned by this request. @@ -163,39 +144,21 @@ paths: application/json: schema: title: ToscaServiceTemplate - type: object + type: ToscaServiceTemplate 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 + type: ToscaServiceTemplate example: externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml' required: true responses: - 200: + 201: 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: @@ -210,9 +173,21 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: CommissioningResponse + type: CommissioningResponse + 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: CommissioningResponse + example: + externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml' + 401: + description: Authentication Error headers: X-LatestVersion: schema: @@ -227,15 +202,13 @@ paths: schema: type: string format: uuid - content: {} - 404: - description: Not Found - content: {} - 406: - description: Specified automation composition definition is not acceptable. See the content for error messages. - content: {} - 500: - description: Internal Server Error + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 400: + description: Bad Request headers: X-LatestVersion: schema: @@ -250,7 +223,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -260,7 +237,7 @@ paths: /compositions/{compositionId}: get: tags: - - Automation Composition Controller + - Automation Composition Definition summary: Get details of the requested commissioned automation composition definitions description: Get details of the requested commissioned automation composition @@ -286,21 +263,6 @@ paths: 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: @@ -315,9 +277,21 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: ToscaServiceTemplate + type: ToscaServiceTemplate + 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: ToscaServiceTemplate + 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: @@ -332,12 +306,13 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse 404: description: Specified automation composition definition not found - content: {} - 500: - description: Internal Server Error headers: X-LatestVersion: schema: @@ -352,7 +327,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -360,7 +339,7 @@ paths: last-mod-release: London put: tags: - - Automation Composition Controller + - Automation Composition Definition 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 @@ -386,13 +365,13 @@ paths: application/json: schema: title: ToscaServiceTemplate - type: object + type: ToscaServiceTemplate 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 + type: ToscaServiceTemplate example: externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.yaml' required: true @@ -401,22 +380,33 @@ paths: 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 + 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: application/json: schema: title: CommissioningResponse - type: object + type: CommissioningResponse 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 + type: CommissioningResponse 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: @@ -433,9 +423,13 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 404: + description: Specified automation composition definition not found headers: X-LatestVersion: schema: @@ -450,19 +444,13 @@ paths: 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 + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 400: + description: Bad Request headers: X-LatestVersion: schema: @@ -477,7 +465,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -486,7 +478,7 @@ paths: x-codegen-request-body-name: body delete: tags: - - Automation Composition Controller + - Automation Composition Definition 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 @@ -509,17 +501,31 @@ paths: 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 + 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: application/json: schema: title: CommissioningResponse - type: object + type: CommissioningResponse 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 + type: CommissioningResponse example: externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml' 401: @@ -538,9 +544,13 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 404: + description: Specified automation composition definition not found headers: X-LatestVersion: schema: @@ -555,16 +565,13 @@ paths: 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 + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 400: + description: Bad Request headers: X-LatestVersion: schema: @@ -579,7 +586,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -588,7 +599,7 @@ paths: /compositions/{compositionId}/instances: get: tags: - - Automation Composition Controller + - Automation Composition Instance 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 @@ -624,21 +635,6 @@ paths: 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: @@ -653,9 +649,21 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: AutomationCompositions + type: AutomationCompositions + 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: AutomationCompositions + 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: @@ -670,12 +678,13 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse 404: description: The specified automation composition definition was not found - content: {} - 500: - description: Internal Server Error headers: X-LatestVersion: schema: @@ -690,7 +699,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -698,7 +711,7 @@ paths: last-mod-release: London post: tags: - - Automation Composition Controller + - Automation Composition Instance 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. @@ -725,37 +738,48 @@ paths: application/json: schema: title: AutomationCompositions - type: object + type: AutomationCompositions 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 + type: AutomationCompositions example: externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstances.yaml' required: true responses: - 200: + 201: 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 + 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: application/json: schema: title: InstantiationResponse - type: object + type: InstantiationResponse 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 + type: InstantiationResponse 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: @@ -772,9 +796,13 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 404: + description: The specified automation composition definition was not found headers: X-LatestVersion: schema: @@ -789,15 +817,13 @@ paths: schema: type: string format: uuid - content: {} - 404: - description: The specified automation composition definition was not found - content: {} - 406: - description: Specified automation composition instance definition is not acceptable. See the content for error messages. - content: {} - 500: - description: Internal Server Error + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 400: + description: Bad Request headers: X-LatestVersion: schema: @@ -812,7 +838,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -822,7 +852,7 @@ paths: /compositions/{compositionId}/instances/{instanceId}: get: tags: - - Automation Composition Controller + - Automation Composition Instance summary: Get automation composition instance details. description: Get details of the requested automation composition instance. operationId: getCompositionInstance @@ -852,21 +882,6 @@ paths: 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: @@ -881,9 +896,21 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: AutomationCompositions + type: AutomationComposition + 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: AutomationComposition + 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: @@ -898,12 +925,13 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse 404: description: The automation composition instance was not found - content: {} - 500: - description: Internal Server Error headers: X-LatestVersion: schema: @@ -918,7 +946,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -926,7 +958,7 @@ paths: last-mod-release: London put: tags: - - Automation Composition Controller + - Automation Composition Instance 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 @@ -974,22 +1006,33 @@ paths: 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 + 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: application/json: schema: title: InstantiationResponse - type: object + type: InstantiationResponse 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 + type: InstantiationResponse 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: @@ -1006,9 +1049,13 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 404: + description: The specified automation composition instance was not found headers: X-LatestVersion: schema: @@ -1023,19 +1070,13 @@ paths: 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 + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 400: + description: Bad Request headers: X-LatestVersion: schema: @@ -1050,7 +1091,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: @@ -1059,7 +1104,7 @@ paths: x-codegen-request-body-name: body delete: tags: - - Automation Composition Controller + - Automation Composition Instance summary: Delete an automation composition instance description: Deletes a automation composition instance, returning the UUID of the deleted automation composition instance operationId: deleteCompositionInstance @@ -1089,17 +1134,31 @@ paths: 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 + 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: application/json: schema: title: InstantiationResponse - type: object + type: InstantiationResponse 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 + type: InstantiationResponse example: externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml' 401: @@ -1118,9 +1177,13 @@ paths: schema: type: string format: uuid - content: {} - 403: - description: Authorization Error + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 404: + description: The specified automation composition instance was not found headers: X-LatestVersion: schema: @@ -1135,16 +1198,13 @@ paths: 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 + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse + 400: + description: Bad Request headers: X-LatestVersion: schema: @@ -1159,7 +1219,11 @@ paths: schema: type: string format: uuid - content: {} + content: + application/json: + schema: + title: SimpleResponse + type: SimpleResponse security: - basicAuth: [] x-interface info: |