diff options
Diffstat (limited to 'runtime-acm/src/main')
32 files changed, 3821 insertions, 401 deletions
diff --git a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/commissioning/CommissioningProvider.java b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/commissioning/CommissioningProvider.java index 19d4afe11..66a67a304 100644 --- a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/commissioning/CommissioningProvider.java +++ b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/commissioning/CommissioningProvider.java @@ -94,10 +94,6 @@ public class CommissioningProvider { */ public CommissioningResponse createAutomationCompositionDefinitions(ToscaServiceTemplate serviceTemplate) { - if (verifyIfDefinitionExists()) { - throw new PfModelRuntimeException(Status.BAD_REQUEST, - "Delete instances, to commission automation composition definitions"); - } var acmDefinition = acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplate); serviceTemplate = acmDefinition.getServiceTemplate(); var participantList = participantProvider.getParticipants(); @@ -191,13 +187,4 @@ public class CommissioningProvider { private boolean verifyIfInstanceExists(UUID compositionId) { return !acProvider.getAcInstancesByCompositionId(compositionId).isEmpty(); } - - /** - * Validates to see if there is any instance saved. - * - * @return true if exists instance - */ - private boolean verifyIfDefinitionExists() { - return !acDefinitionProvider.getAllAcDefinitions().isEmpty(); - } } diff --git a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/instantiation/AutomationCompositionInstantiationProvider.java b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/instantiation/AutomationCompositionInstantiationProvider.java index 03a2f4e25..374c94f5d 100644 --- a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/instantiation/AutomationCompositionInstantiationProvider.java +++ b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/instantiation/AutomationCompositionInstantiationProvider.java @@ -22,6 +22,7 @@ package org.onap.policy.clamp.acm.runtime.instantiation; import java.util.List; +import java.util.UUID; import java.util.function.Function; import java.util.stream.Collectors; import javax.ws.rs.core.Response; @@ -29,12 +30,14 @@ import javax.ws.rs.core.Response.Status; import lombok.AllArgsConstructor; import org.onap.policy.clamp.acm.runtime.supervision.SupervisionHandler; import org.onap.policy.clamp.common.acm.exception.AutomationCompositionException; +import org.onap.policy.clamp.common.acm.exception.AutomationCompositionRuntimeException; import org.onap.policy.clamp.models.acm.concepts.AutomationComposition; import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionState; import org.onap.policy.clamp.models.acm.concepts.AutomationCompositions; import org.onap.policy.clamp.models.acm.concepts.Participant; import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationCommand; import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationResponse; +import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationUpdate; import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider; import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider; import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider; @@ -43,7 +46,6 @@ import org.onap.policy.common.parameters.BeanValidationResult; import org.onap.policy.common.parameters.ObjectValidationResult; import org.onap.policy.common.parameters.ValidationStatus; import org.onap.policy.models.base.PfModelRuntimeException; -import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; @@ -55,6 +57,7 @@ import org.springframework.transaction.annotation.Transactional; @AllArgsConstructor public class AutomationCompositionInstantiationProvider { private static final String AUTOMATION_COMPOSITION_NODE_ELEMENT_TYPE = "AutomationCompositionElement"; + private static final String DO_NOT_MATCH = " do not match with "; private final AutomationCompositionProvider automationCompositionProvider; private final SupervisionHandler supervisionHandler; @@ -65,11 +68,16 @@ public class AutomationCompositionInstantiationProvider { /** * Create automation composition. * + * @param compositionId The UUID of the automation composition definition * @param automationComposition the automation composition * @return the result of the instantiation operation */ - public InstantiationResponse createAutomationComposition(AutomationComposition automationComposition) { - + public InstantiationResponse createAutomationComposition(UUID compositionId, + AutomationComposition automationComposition) { + if (!compositionId.equals(automationComposition.getCompositionId())) { + throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, + automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId); + } var checkAutomationCompositionOpt = automationCompositionProvider.findAutomationComposition(automationComposition.getKey().asIdentifier()); if (checkAutomationCompositionOpt.isPresent()) { @@ -93,20 +101,34 @@ public class AutomationCompositionInstantiationProvider { /** * Update automation composition. * - * @param automationComposition the automation composition - * @return the result of the instantiation operation + * @param compositionId The UUID of the automation composition definition + * @param instanceId The UUID of the automation composition instance + * @param instanceUpdate the automation composition + * @return the result of the update */ - public InstantiationResponse updateAutomationComposition(AutomationComposition automationComposition) { - var validationResult = validateAutomationComposition(automationComposition); - if (!validationResult.isValid()) { - throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, validationResult.getResult()); + public InstantiationResponse updateAutomationComposition(UUID compositionId, UUID instanceId, + InstantiationUpdate instanceUpdate) { + var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId); + if (!compositionId.equals(automationComposition.getCompositionId())) { + throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, + automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId); + } + if (instanceUpdate.getElements() != null) { + automationComposition.setElements(instanceUpdate.getElements()); + var validationResult = validateAutomationComposition(automationComposition); + if (!validationResult.isValid()) { + throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, validationResult.getResult()); + } + automationComposition = automationCompositionProvider.updateAutomationComposition(automationComposition); + } + + if (instanceUpdate.getInstantiationCommand() != null) { + issueAutomationCompositionCommand(automationComposition, instanceUpdate.getInstantiationCommand()); } - automationCompositionProvider.updateAutomationComposition(automationComposition); var response = new InstantiationResponse(); - response.setInstanceId(automationComposition.getInstanceId()); + response.setInstanceId(instanceId); response.setAffectedAutomationComposition(automationComposition.getKey().asIdentifier()); - return response; } @@ -130,19 +152,35 @@ public class AutomationCompositionInstantiationProvider { } /** + * Get Automation Composition. + * + * @param compositionId The UUID of the automation composition definition + * @param instanceId The UUID of the automation composition instance + * @return the Automation Composition + */ + @Transactional(readOnly = true) + public AutomationComposition getAutomationComposition(UUID compositionId, UUID instanceId) { + var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId); + if (!automationComposition.getCompositionId().equals(compositionId)) { + throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, + "Composition Id " + compositionId + DO_NOT_MATCH + automationComposition.getCompositionId()); + } + return automationComposition; + } + + /** * Delete the automation composition with the given name and version. * - * @param name the name of the automation composition to delete - * @param version the version of the automation composition to delete + * @param compositionId The UUID of the automation composition definition + * @param instanceId The UUID of the automation composition instance * @return the result of the deletion */ - public InstantiationResponse deleteAutomationComposition(String name, String version) { - var automationCompositionOpt = - automationCompositionProvider.findAutomationComposition(new ToscaConceptIdentifier(name, version)); - if (automationCompositionOpt.isEmpty()) { - throw new PfModelRuntimeException(Response.Status.NOT_FOUND, "Automation composition not found"); + public InstantiationResponse deleteAutomationComposition(UUID compositionId, UUID instanceId) { + var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId); + if (!compositionId.equals(automationComposition.getCompositionId())) { + throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, + automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId); } - var automationComposition = automationCompositionOpt.get(); if (!AutomationCompositionState.UNINITIALISED.equals(automationComposition.getState())) { throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, "Automation composition state is still " + automationComposition.getState()); @@ -174,42 +212,33 @@ public class AutomationCompositionInstantiationProvider { /** * Issue a command to automation compositions, setting their ordered state. * + * @param automationComposition the AutomationComposition * @param command the command to issue to automation compositions - * @return the result of the initiation command - * @throws AutomationCompositionException on ordered state invalid */ - public InstantiationResponse issueAutomationCompositionCommand(InstantiationCommand command) - throws AutomationCompositionException { + public void issueAutomationCompositionCommand(AutomationComposition automationComposition, + InstantiationCommand command) { if (command.getOrderedState() == null) { - throw new AutomationCompositionException(Status.BAD_REQUEST, + throw new AutomationCompositionRuntimeException(Status.BAD_REQUEST, "ordered state invalid or not specified on command"); } var participants = participantProvider.getParticipants(); if (participants.isEmpty()) { - throw new AutomationCompositionException(Status.BAD_REQUEST, "No participants registered"); - } - var automationCompositionOpt = - automationCompositionProvider.findAutomationComposition(command.getAutomationCompositionIdentifier()); - if (automationCompositionOpt.isEmpty()) { - throw new AutomationCompositionException(Response.Status.BAD_REQUEST, - "AutomationComposition with id " + command.getAutomationCompositionIdentifier() + " not found"); + throw new AutomationCompositionRuntimeException(Status.BAD_REQUEST, "No participants registered"); } - - var automationComposition = automationCompositionOpt.get(); var validationResult = validateIssueAutomationComposition(automationComposition, participants); if (!validationResult.isValid()) { - throw new AutomationCompositionException(Response.Status.BAD_REQUEST, validationResult.getResult()); + throw new AutomationCompositionRuntimeException(Response.Status.BAD_REQUEST, validationResult.getResult()); } automationComposition.setCascadedOrderedState(command.getOrderedState()); - supervisionHandler.triggerAutomationCompositionSupervision(automationComposition); + try { + supervisionHandler.triggerAutomationCompositionSupervision(automationComposition); + } catch (AutomationCompositionException e) { + throw new AutomationCompositionRuntimeException(Response.Status.BAD_REQUEST, e.getMessage()); + } automationCompositionProvider.updateAutomationComposition(automationComposition); - var response = new InstantiationResponse(); - response.setAffectedAutomationComposition(command.getAutomationCompositionIdentifier()); - - return response; } private BeanValidationResult validateIssueAutomationComposition(AutomationComposition automationComposition, diff --git a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/rest/InstantiationController.java b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/rest/InstantiationController.java index d575a690e..e828843a6 100644 --- a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/rest/InstantiationController.java +++ b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/rest/InstantiationController.java @@ -21,32 +21,16 @@ package org.onap.policy.clamp.acm.runtime.main.rest; -import io.swagger.annotations.ApiOperation; -import io.swagger.annotations.ApiParam; -import io.swagger.annotations.ApiResponse; -import io.swagger.annotations.ApiResponses; -import io.swagger.annotations.Authorization; -import io.swagger.annotations.Extension; -import io.swagger.annotations.ExtensionProperty; -import io.swagger.annotations.ResponseHeader; import java.util.UUID; import lombok.RequiredArgsConstructor; import org.onap.policy.clamp.acm.runtime.instantiation.AutomationCompositionInstantiationProvider; +import org.onap.policy.clamp.acm.runtime.main.rest.gen.AutomationCompositionInstanceApi; import org.onap.policy.clamp.acm.runtime.main.web.AbstractRestController; -import org.onap.policy.clamp.common.acm.exception.AutomationCompositionException; import org.onap.policy.clamp.models.acm.concepts.AutomationComposition; import org.onap.policy.clamp.models.acm.concepts.AutomationCompositions; -import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationCommand; import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationResponse; -import org.springframework.http.MediaType; +import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationUpdate; import org.springframework.http.ResponseEntity; -import org.springframework.web.bind.annotation.DeleteMapping; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PostMapping; -import org.springframework.web.bind.annotation.PutMapping; -import org.springframework.web.bind.annotation.RequestBody; -import org.springframework.web.bind.annotation.RequestHeader; -import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; /** @@ -54,129 +38,55 @@ import org.springframework.web.bind.annotation.RestController; */ @RestController @RequiredArgsConstructor -public class InstantiationController extends AbstractRestController { - - private static final String TAGS = "Clamp Automation Composition Instantiation API"; +public class InstantiationController extends AbstractRestController implements AutomationCompositionInstanceApi { // The Automation Composition provider for instantiation requests private final AutomationCompositionInstantiationProvider provider; /** - * Creates a automation composition. + * Creates an automation composition. * - * @param requestId request ID used in ONAP logging + * @param compositionId The UUID of the automation composition definition * @param automationComposition the automation composition + * @param requestId request ID used in ONAP logging * @return a response */ - // @formatter:off - @PostMapping(value = "/instantiation", - produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML}, - consumes = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML}) - @ApiOperation( - value = "Commissions automation composition definitions", - notes = "Commissions automation composition definitions, returning the automation composition IDs", - response = InstantiationResponse.class, - tags = {TAGS}, - authorizations = @Authorization(value = AUTHORIZATION_TYPE), - responseHeaders = { - @ResponseHeader( - name = VERSION_MINOR_NAME, - description = VERSION_MINOR_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = VERSION_PATCH_NAME, - description = VERSION_PATCH_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = VERSION_LATEST_NAME, - description = VERSION_LATEST_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = REQUEST_ID_NAME, - description = REQUEST_ID_HDR_DESCRIPTION, - response = UUID.class) - }, - extensions = { - @Extension - ( - name = EXTENSION_NAME, - properties = { - @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION), - @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE) - } - ) - } - ) - @ApiResponses( - value = { - @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE), - @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE), - @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE) - } - ) - // @formatter:on - public ResponseEntity<InstantiationResponse> createCompositionInstance( - @RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId, - @ApiParam( - value = "Entity Body of automation composition", - required = true) @RequestBody AutomationComposition automationComposition) { + @Override + public ResponseEntity<InstantiationResponse> createCompositionInstance(UUID compositionId, + AutomationComposition automationComposition, UUID requestId) { + + var response = provider.createAutomationComposition(compositionId, automationComposition); + return ResponseEntity + .created(createUri("/compositions/" + compositionId + "/instances/" + response.getInstanceId())) + .body(response); + } - return ResponseEntity.ok().body(provider.createAutomationComposition(automationComposition)); + /** + * Gets an automation composition. + * + * @param compositionId The UUID of the automation composition definition + * @param instanceId The UUID of the automation composition instance + * @param requestId request ID used in ONAP logging + * @return the automation composition instance + */ + @Override + public ResponseEntity<AutomationComposition> getCompositionInstance(UUID compositionId, UUID instanceId, + UUID requestId) { + return ResponseEntity.ok().body(provider.getAutomationComposition(compositionId, instanceId)); } /** * Queries details of all automation compositions. * - * @param requestId request ID used in ONAP logging + * @param compositionId The UUID of the automation composition definition * @param name the name of the automation composition to get, null for all automation compositions * @param version the version of the automation composition to get, null for all automation compositions + * @param requestId request ID used in ONAP logging * @return the automation compositions */ - // @formatter:off - @GetMapping(value = "/instantiation", - produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML}) - @ApiOperation(value = "Query details of the requested automation compositions", - notes = "Queries details of the requested automation compositions, returning all composition details", - response = AutomationCompositions.class, - tags = {TAGS}, - authorizations = @Authorization(value = AUTHORIZATION_TYPE), - responseHeaders = { - @ResponseHeader( - name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION, - response = String.class), - @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION, - response = String.class), - @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION, - response = String.class), - @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION, - response = UUID.class)}, - extensions = { - @Extension - ( - name = EXTENSION_NAME, - properties = { - @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION), - @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE) - } - ) - } - ) - @ApiResponses( - value = { - @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE), - @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE), - @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE) - } - ) - // @formatter:on - public ResponseEntity<AutomationCompositions> queryCompositionInstances( - @RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId, - @ApiParam(value = "Automation composition definition name", required = false) @RequestParam( - value = "name", - required = false) String name, - @ApiParam(value = "Automation composition definition version", required = false) @RequestParam( - value = "version", - required = false) String version) { + @Override + public ResponseEntity<AutomationCompositions> queryCompositionInstances(UUID compositionId, String name, + String version, UUID requestId) { return ResponseEntity.ok().body(provider.getAutomationCompositions(name, version)); } @@ -184,182 +94,32 @@ public class InstantiationController extends AbstractRestController { /** * Updates a automation composition. * + * @param compositionId The UUID of the automation composition definition + * @param instanceId The UUID of the automation composition instance + * @param instanceUpdate the automation composition to update * @param requestId request ID used in ONAP logging - * @param automationComposition the automation composition * @return a response */ - // @formatter:off - @PutMapping(value = "/instantiation", - produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML}, - consumes = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML}) - @ApiOperation( - value = "Updates automation composition definitions", - notes = "Updates automation composition definitions, returning the updated composition definition IDs", - response = InstantiationResponse.class, - tags = {TAGS}, - authorizations = @Authorization(value = AUTHORIZATION_TYPE), - responseHeaders = { - @ResponseHeader( - name = VERSION_MINOR_NAME, - description = VERSION_MINOR_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = VERSION_PATCH_NAME, - description = VERSION_PATCH_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = VERSION_LATEST_NAME, - description = VERSION_LATEST_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = REQUEST_ID_NAME, - description = REQUEST_ID_HDR_DESCRIPTION, - response = UUID.class) - }, - extensions = { - @Extension - ( - name = EXTENSION_NAME, - properties = { - @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION), - @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE) - } - ) - } - ) - @ApiResponses( - value = { - @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE), - @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE), - @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE) - } - ) - // @formatter:on - public ResponseEntity<InstantiationResponse> updateCompositionInstance( - @RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId, - @ApiParam( - value = "Entity Body of Automation Composition", - required = true) @RequestBody AutomationComposition automationComposition) { + @Override + public ResponseEntity<InstantiationResponse> updateCompositionInstance(UUID compositionId, UUID instanceId, + InstantiationUpdate instanceUpdate, UUID requestId) { - return ResponseEntity.ok().body(provider.updateAutomationComposition(automationComposition)); + return ResponseEntity.ok() + .body(provider.updateAutomationComposition(compositionId, instanceId, instanceUpdate)); } /** * Deletes a automation composition definition. * + * @param compositionId The UUID of the automation composition definition + * @param instanceId The UUID of the automation composition instance * @param requestId request ID used in ONAP logging - * @param name the name of the automation composition to delete - * @param version the version of the automation composition to delete * @return a response */ - // @formatter:off - @DeleteMapping(value = "/instantiation", - produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML}) - @ApiOperation(value = "Delete a automation composition", - notes = "Deletes a automation composition, returning optional error details", - response = InstantiationResponse.class, - tags = {TAGS}, - authorizations = @Authorization(value = AUTHORIZATION_TYPE), - responseHeaders = { - @ResponseHeader( - name = VERSION_MINOR_NAME, - description = VERSION_MINOR_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = VERSION_PATCH_NAME, - description = VERSION_PATCH_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = VERSION_LATEST_NAME, - description = VERSION_LATEST_DESCRIPTION, - response = String.class), - @ResponseHeader( - name = REQUEST_ID_NAME, - description = REQUEST_ID_HDR_DESCRIPTION, - response = UUID.class)}, - extensions = { - @Extension - ( - name = EXTENSION_NAME, - properties = { - @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION), - @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE) - } - ) - } - ) - @ApiResponses( - value = { - @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE), - @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE), - @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE) - } - ) - // @formatter:on - - public ResponseEntity<InstantiationResponse> deleteCompositionInstance( - @RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId, - @ApiParam(value = "Automation composition definition name", required = true) @RequestParam("name") String name, - @ApiParam(value = "Automation composition definition version") @RequestParam( - value = "version", - required = true) String version) { - - return ResponseEntity.ok().body(provider.deleteAutomationComposition(name, version)); - } - - /** - * Issues automation composition commands to automation compositions. - * - * @param requestId request ID used in ONAP logging - * @param command the command to issue to automation compositions - * @return the automation composition definitions - * @throws AutomationCompositionException on errors issuing a command - */ - // @formatter:off - @PutMapping(value = "/instantiation/command", - produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML}, - consumes = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML}) - @ApiOperation(value = "Issue a command to the requested automation compositions", - notes = "Issues a command to an automation composition, ordering a state change on the composition", - response = InstantiationResponse.class, - tags = {TAGS}, - authorizations = @Authorization(value = AUTHORIZATION_TYPE), - responseHeaders = { - @ResponseHeader( - name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION, - response = String.class), - @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION, - response = String.class), - @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION, - response = String.class), - @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION, - response = UUID.class)}, - extensions = { - @Extension - ( - name = EXTENSION_NAME, - properties = { - @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION), - @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE) - } - ) - } - ) - @ApiResponses( - value = { - @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE), - @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE), - @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE) - } - ) - // @formatter:on - public ResponseEntity<InstantiationResponse> issueAutomationCompositionCommand( - @RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId, - @ApiParam( - value = "Entity Body of automation composition command", - required = true) @RequestBody InstantiationCommand command) - throws AutomationCompositionException { + @Override + public ResponseEntity<InstantiationResponse> deleteCompositionInstance(UUID compositionId, UUID instanceId, + UUID requestId) { - return ResponseEntity.accepted().body(provider.issueAutomationCompositionCommand(command)); + return ResponseEntity.ok().body(provider.deleteAutomationComposition(compositionId, instanceId)); } } diff --git a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/web/AbstractRestController.java b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/web/AbstractRestController.java index 61522dd66..736f258ee 100644 --- a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/web/AbstractRestController.java +++ b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/web/AbstractRestController.java @@ -20,13 +20,6 @@ package org.onap.policy.clamp.acm.runtime.main.web; -import io.swagger.annotations.Api; -import io.swagger.annotations.BasicAuthDefinition; -import io.swagger.annotations.Info; -import io.swagger.annotations.SecurityDefinition; -import io.swagger.annotations.SwaggerDefinition; -import io.swagger.annotations.Tag; -import java.net.HttpURLConnection; import java.net.URI; import java.net.URISyntaxException; import javax.ws.rs.core.MediaType; @@ -37,57 +30,11 @@ import org.springframework.web.bind.annotation.RequestMapping; /** * Common superclass to provide REST endpoints for the participant simulator. */ -// @formatter:off @RequestMapping(value = "/v2", produces = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML}) -@Api(value = "Automation Composition Commissioning API") -@SwaggerDefinition( - info = @Info(description = - "Automation Composition Service", version = "v1.0", - title = "Automation Composition"), - consumes = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML}, - produces = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML}, - schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS}, - tags = {@Tag(name = "automationcomposition", description = "Automation Composition Service")}, - securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")})) -// @formatter:on public abstract class AbstractRestController { public static final String APPLICATION_YAML = "application/yaml"; - public static final String EXTENSION_NAME = "interface info"; - - public static final String API_VERSION_NAME = "api-version"; - public static final String API_VERSION = "1.0.0"; - - public static final String LAST_MOD_NAME = "last-mod-release"; - public static final String LAST_MOD_RELEASE = "Istanbul"; - - public static final String VERSION_MINOR_NAME = "X-MinorVersion"; - public static final String VERSION_MINOR_DESCRIPTION = - "Used to request or communicate a MINOR version back from the client" - + " to the server, and from the server back to the client"; - - public static final String VERSION_PATCH_NAME = "X-PatchVersion"; - public static final String VERSION_PATCH_DESCRIPTION = "Used only to communicate a PATCH version in a response for" - + " troubleshooting purposes only, and will not be provided by" + " the client on request"; - - public static final String VERSION_LATEST_NAME = "X-LatestVersion"; - public static final String VERSION_LATEST_DESCRIPTION = "Used only to communicate an API's latest version"; - - public static final String REQUEST_ID_NAME = "X-ONAP-RequestID"; - public static final String REQUEST_ID_HDR_DESCRIPTION = "Used to track REST transactions for logging purpose"; - public static final String REQUEST_ID_PARAM_DESCRIPTION = "RequestID for http transaction"; - - public static final String AUTHORIZATION_TYPE = "basicAuth"; - - public static final int AUTHENTICATION_ERROR_CODE = HttpURLConnection.HTTP_UNAUTHORIZED; - public static final int AUTHORIZATION_ERROR_CODE = HttpURLConnection.HTTP_FORBIDDEN; - public static final int SERVER_ERROR_CODE = HttpURLConnection.HTTP_INTERNAL_ERROR; - - public static final String AUTHENTICATION_ERROR_MESSAGE = "Authentication Error"; - public static final String AUTHORIZATION_ERROR_MESSAGE = "Authorization Error"; - public static final String SERVER_ERROR_MESSAGE = "Internal Server Error"; - /** * Constructor. */ diff --git a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/web/GlobalControllerExceptionHandler.java b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/web/GlobalControllerExceptionHandler.java index fef358bb1..96d3bb2a7 100644 --- a/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/web/GlobalControllerExceptionHandler.java +++ b/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/main/web/GlobalControllerExceptionHandler.java @@ -20,7 +20,7 @@ package org.onap.policy.clamp.acm.runtime.main.web; -import org.onap.policy.clamp.common.acm.exception.AutomationCompositionException; +import org.onap.policy.clamp.common.acm.exception.AutomationCompositionRuntimeException; import org.onap.policy.clamp.models.acm.messages.rest.SimpleResponse; import org.onap.policy.clamp.models.acm.rest.RestUtils; import org.onap.policy.models.base.PfModelException; @@ -33,13 +33,13 @@ import org.springframework.web.bind.annotation.RestControllerAdvice; public class GlobalControllerExceptionHandler { /** - * Handle AutomationCompositionException. + * Handle AutomationCompositionRuntimeException. * - * @param ex AutomationCompositionException + * @param ex AutomationCompositionRuntimeException * @return ResponseEntity */ - @ExceptionHandler(AutomationCompositionException.class) - public ResponseEntity<SimpleResponse> handleBadRequest(AutomationCompositionException ex) { + @ExceptionHandler(AutomationCompositionRuntimeException.class) + public ResponseEntity<SimpleResponse> handleBadRequest(AutomationCompositionRuntimeException ex) { return RestUtils.toSimpleResponse(ex); } diff --git a/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json b/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json new file mode 100644 index 000000000..20602f730 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json @@ -0,0 +1,25 @@ +{ + "compositionId": "562ed027-2689-481a-b3a5-e284b1fbc33f", + "affectedAutomationCompositionDefinitions": [ + { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.AutomationCompositionDefinition", + "version": "1.2.3" + } + ] +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml new file mode 100644 index 000000000..893205dca --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml @@ -0,0 +1,12 @@ +compositionId: 562ed027-2689-481a-b3a5-e284b1fbc33f +affectedAutomationCompositionDefinitions: +- name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 +- name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.AutomationCompositionDefinition + version: 1.2.3 diff --git a/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.json b/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.json new file mode 100644 index 000000000..b662bc6b6 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.json @@ -0,0 +1,6 @@ +{ + "affectedAutomationComposition": { + "name": "InstanceHttp", + "version": "1.0.1" + } +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml new file mode 100644 index 000000000..1fbca51ac --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml @@ -0,0 +1,3 @@ +affectedAutomationComposition: + name: InstanceHttp + version: 1.0.1 diff --git a/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json b/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json new file mode 100644 index 000000000..bef6791a3 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json @@ -0,0 +1,491 @@ +{ + "service_templates": [ + { + "tosca_definitions_version": "tosca_simple_yaml_1_3", + "data_types": { + "onap.datatypes.ToscaConceptIdentifier": { + "properties": { + "name": { + "name": "name", + "type": "string", + "type_version": "0.0.0", + "required": true + }, + "version": { + "name": "version", + "type": "string", + "type_version": "0.0.0", + "required": true + } + }, + "name": "onap.datatypes.ToscaConceptIdentifier", + "version": "0.0.0", + "derived_from": "tosca.datatypes.Root", + "metadata": {} + }, + "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest": { + "properties": { + "restRequestId": { + "name": "restRequestId", + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0", + "description": "The name and version of a REST request to be sent to a REST endpoint", + "required": true + }, + "httpMethod": { + "name": "httpMethod", + "type": "string", + "type_version": "0.0.0", + "description": "The REST method to use", + "required": true, + "constraints": [ + { + "valid_values": [ + "POST", + "PUT", + "GET", + "DELETE" + ] + } + ] + }, + "path": { + "name": "path", + "type": "string", + "type_version": "0.0.0", + "description": "The path of the REST request relative to the base URL", + "required": true + }, + "body": { + "name": "body", + "type": "string", + "type_version": "0.0.0", + "description": "The body of the REST request for PUT and POST requests", + "required": false + }, + "expectedResponse": { + "name": "expectedResponse", + "type": "integer", + "type_version": "0.0.0", + "description": "THe expected HTTP status code for the REST request", + "required": true, + "constraints": [] + } + }, + "name": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest", + "version": "1.0.0", + "derived_from": "tosca.datatypes.Root", + "metadata": {} + }, + "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity": { + "properties": { + "configurationEntityId": { + "name": "configurationEntityId", + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0", + "description": "The name and version of a Configuration Entity to be handled by the HTTP Automation Composition Element", + "required": true + }, + "restSequence": { + "name": "restSequence", + "type": "list", + "type_version": "0.0.0", + "description": "A sequence of REST commands to send to the REST endpoint", + "required": false, + "entry_schema": { + "type": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest", + "type_version": "1.0.0" + } + } + }, + "name": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity", + "version": "1.0.0", + "derived_from": "tosca.datatypes.Root", + "metadata": {} + } + }, + "node_types": { + "org.onap.policy.clamp.acm.Participant": { + "properties": { + "provider": { + "name": "provider", + "type": "string", + "type_version": "0.0.0", + "required": false + } + }, + "name": "org.onap.policy.clamp.acm.Participant", + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "metadata": {} + }, + "org.onap.policy.clamp.acm.AutomationCompositionElement": { + "properties": { + "provider": { + "name": "provider", + "type": "string", + "type_version": "0.0.0", + "description": "Specifies the organization that provides the automation composition element", + "required": false, + "metadata": { + "common": "true" + } + }, + "participant_id": { + "name": "participant_id", + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0", + "required": true, + "metadata": { + "common": "true" + } + }, + "participantType": { + "name": "participantType", + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0", + "description": "The identity of the participant type that hosts this type of Automation Composition Element", + "required": true, + "metadata": { + "common": "true" + } + }, + "startPhase": { + "name": "startPhase", + "type": "integer", + "type_version": "0.0.0", + "description": "A value indicating the start phase in which this automation composition element will be started, the first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped in reverse start phase order. Automation Composition Elements with the same start phase are started and stopped simultaneously", + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + }, + "uninitializedToPassiveTimeout": { + "name": "uninitializedToPassiveTimeout", + "type": "integer", + "type_version": "0.0.0", + "description": "The maximum time in seconds to wait for a state chage from uninitialized to passive", + "default": 60.0, + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + }, + "passiveToRunningTimeout": { + "name": "passiveToRunningTimeout", + "type": "integer", + "type_version": "0.0.0", + "description": "The maximum time in seconds to wait for a state chage from passive to running", + "default": 60.0, + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + }, + "runningToPassiveTimeout": { + "name": "runningToPassiveTimeout", + "type": "integer", + "type_version": "0.0.0", + "description": "The maximum time in seconds to wait for a state chage from running to passive", + "default": 60.0, + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + }, + "passiveToUninitializedTimeout": { + "name": "passiveToUninitializedTimeout", + "type": "integer", + "type_version": "0.0.0", + "description": "The maximum time in seconds to wait for a state chage from passive to uninitialized", + "default": 60.0, + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + } + }, + "name": "org.onap.policy.clamp.acm.AutomationCompositionElement", + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "metadata": {} + }, + "org.onap.policy.clamp.acm.AutomationComposition": { + "properties": { + "provider": { + "name": "provider", + "type": "string", + "type_version": "0.0.0", + "description": "Specifies the organization that provides the automation composition element", + "required": false, + "metadata": { + "common": "true" + } + }, + "elements": { + "name": "elements", + "type": "list", + "type_version": "0.0.0", + "description": "Specifies a list of automation composition element definitions that make up this automation composition definition", + "required": true, + "entry_schema": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0" + }, + "metadata": { + "common": "true" + } + } + }, + "name": "org.onap.policy.clamp.acm.AutomationComposition", + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "metadata": {} + }, + "org.onap.policy.clamp.acm.HttpAutomationCompositionElement": { + "properties": { + "baseUrl": { + "name": "baseUrl", + "type": "string", + "type_version": "0.0.0", + "description": "The base URL to be prepended to each path, identifies the host for the REST endpoints.", + "required": true + }, + "httpHeaders": { + "name": "httpHeaders", + "type": "map", + "type_version": "0.0.0", + "description": "HTTP headers to send on REST requests", + "required": false, + "entry_schema": { + "type": "string", + "type_version": "0.0.0" + } + }, + "configurationEntities": { + "name": "configurationEntities", + "type": "map", + "type_version": "0.0.0", + "description": "The connfiguration entities the Automation Composition Element is managing and their associated REST requests", + "required": true, + "entry_schema": { + "type": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity", + "type_version": "1.0.0" + } + } + }, + "name": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "version": "1.0.1", + "derived_from": "org.onap.policy.clamp.acm.AutomationCompositionElement", + "metadata": {} + } + }, + "topology_template": { + "node_templates": { + "org.onap.policy.clamp.acm.HttpParticipant": { + "type": "org.onap.policy.clamp.acm.Participant", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP" + }, + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4", + "metadata": {}, + "description": "Participant for Http requests" + }, + "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement": { + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-starter:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.starter", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request1", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.startertobridge\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"STARTER\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + }, + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3", + "metadata": {}, + "description": "Automation composition element for the http requests of AC Element Starter microservice" + }, + "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement": { + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-bridge:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.bridge", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request2", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.bridgetosink\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"BRIDGE\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + }, + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3", + "metadata": {}, + "description": "Automation composition element for the http requests of AC Element Bridge microservice" + }, + "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement": { + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-sink:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.sink", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request3", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.sink\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"SINK\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + }, + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3", + "metadata": {}, + "description": "Automation composition element for the http requests of AC Element Sink microservice" + }, + "onap.policy.clamp.ac.element.AutomationCompositionDefinition": { + "type": "org.onap.policy.clamp.acm.AutomationComposition", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP", + "elements": [ + { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + } + ] + }, + "name": "onap.policy.clamp.ac.element.AutomationCompositionDefinition", + "version": "1.2.3", + "metadata": {}, + "description": "Automation composition for Demp" + } + } + }, + "name": "tosca", + "version": "1.0.0", + "metadata": {} + } + ] +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.yaml b/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.yaml new file mode 100644 index 000000000..001e07d0d --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.yaml @@ -0,0 +1,393 @@ +service_templates: +- tosca_definitions_version: tosca_simple_yaml_1_3 + data_types: + onap.datatypes.ToscaConceptIdentifier: + properties: + name: + name: name + type: string + type_version: 0.0.0 + required: true + version: + name: version + type: string + type_version: 0.0.0 + required: true + name: onap.datatypes.ToscaConceptIdentifier + version: 0.0.0 + derived_from: tosca.datatypes.Root + metadata: {} + org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest: + properties: + restRequestId: + name: restRequestId + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + description: The name and version of a REST request to be sent to a REST + endpoint + required: true + httpMethod: + name: httpMethod + type: string + type_version: 0.0.0 + description: The REST method to use + required: true + constraints: + - valid_values: + - POST + - PUT + - GET + - DELETE + path: + name: path + type: string + type_version: 0.0.0 + description: The path of the REST request relative to the base URL + required: true + body: + name: body + type: string + type_version: 0.0.0 + description: The body of the REST request for PUT and POST requests + required: false + expectedResponse: + name: expectedResponse + type: integer + type_version: 0.0.0 + description: THe expected HTTP status code for the REST request + required: true + constraints: [] + name: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest + version: 1.0.0 + derived_from: tosca.datatypes.Root + metadata: {} + org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity: + properties: + configurationEntityId: + name: configurationEntityId + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + description: The name and version of a Configuration Entity to be handled + by the HTTP Automation Composition Element + required: true + restSequence: + name: restSequence + type: list + type_version: 0.0.0 + description: A sequence of REST commands to send to the REST endpoint + required: false + entry_schema: + type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest + type_version: 1.0.0 + name: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity + version: 1.0.0 + derived_from: tosca.datatypes.Root + metadata: {} + node_types: + org.onap.policy.clamp.acm.Participant: + properties: + provider: + name: provider + type: string + type_version: 0.0.0 + required: false + name: org.onap.policy.clamp.acm.Participant + version: 1.0.1 + derived_from: tosca.nodetypes.Root + metadata: {} + org.onap.policy.clamp.acm.AutomationCompositionElement: + properties: + provider: + name: provider + type: string + type_version: 0.0.0 + description: Specifies the organization that provides the automation composition + element + required: false + metadata: + common: 'true' + participant_id: + name: participant_id + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + required: true + metadata: + common: 'true' + participantType: + name: participantType + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + description: The identity of the participant type that hosts this type of + Automation Composition Element + required: true + metadata: + common: 'true' + startPhase: + name: startPhase + type: integer + type_version: 0.0.0 + description: A value indicating the start phase in which this automation + composition element will be started, the first start phase is zero. Automation + Composition Elements are started in their start_phase order and stopped + in reverse start phase order. Automation Composition Elements with the + same start phase are started and stopped simultaneously + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + uninitializedToPassiveTimeout: + name: uninitializedToPassiveTimeout + type: integer + type_version: 0.0.0 + description: The maximum time in seconds to wait for a state chage from + uninitialized to passive + default: 60.0 + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + passiveToRunningTimeout: + name: passiveToRunningTimeout + type: integer + type_version: 0.0.0 + description: The maximum time in seconds to wait for a state chage from + passive to running + default: 60.0 + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + runningToPassiveTimeout: + name: runningToPassiveTimeout + type: integer + type_version: 0.0.0 + description: The maximum time in seconds to wait for a state chage from + running to passive + default: 60.0 + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + passiveToUninitializedTimeout: + name: passiveToUninitializedTimeout + type: integer + type_version: 0.0.0 + description: The maximum time in seconds to wait for a state chage from + passive to uninitialized + default: 60.0 + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + name: org.onap.policy.clamp.acm.AutomationCompositionElement + version: 1.0.1 + derived_from: tosca.nodetypes.Root + metadata: {} + org.onap.policy.clamp.acm.AutomationComposition: + properties: + provider: + name: provider + type: string + type_version: 0.0.0 + description: Specifies the organization that provides the automation composition + element + required: false + metadata: + common: 'true' + elements: + name: elements + type: list + type_version: 0.0.0 + description: Specifies a list of automation composition element definitions + that make up this automation composition definition + required: true + entry_schema: + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + metadata: + common: 'true' + name: org.onap.policy.clamp.acm.AutomationComposition + version: 1.0.1 + derived_from: tosca.nodetypes.Root + metadata: {} + org.onap.policy.clamp.acm.HttpAutomationCompositionElement: + properties: + baseUrl: + name: baseUrl + type: string + type_version: 0.0.0 + description: The base URL to be prepended to each path, identifies the host + for the REST endpoints. + required: true + httpHeaders: + name: httpHeaders + type: map + type_version: 0.0.0 + description: HTTP headers to send on REST requests + required: false + entry_schema: + type: string + type_version: 0.0.0 + configurationEntities: + name: configurationEntities + type: map + type_version: 0.0.0 + description: The connfiguration entities the Automation Composition Element + is managing and their associated REST requests + required: true + entry_schema: + type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity + type_version: 1.0.0 + name: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + version: 1.0.1 + derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement + metadata: {} + topology_template: + node_templates: + org.onap.policy.clamp.acm.HttpParticipant: + type: org.onap.policy.clamp.acm.Participant + type_version: 1.0.1 + properties: + provider: ONAP + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + metadata: {} + description: Participant for Http requests + onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement: + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-starter:8084 + httpHeaders: + Content-Type: application/json + Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0 + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.starter + version: 1.0.0 + restSequence: + - restRequestId: + name: request1 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.startertobridge", + "version": "1.0.0" }, "timerMs": 4000, "elementType": "STARTER", "topicParameterGroup": + { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", + "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": + "dmaap" } }' + expectedResponse: 201 + name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + metadata: {} + description: Automation composition element for the http requests of AC Element + Starter microservice + onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement: + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-bridge:8084 + httpHeaders: + Content-Type: application/json + Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0 + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.bridge + version: 1.0.0 + restSequence: + - restRequestId: + name: request2 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.bridgetosink", + "version": "1.0.0" }, "timerMs": 4000, "elementType": "BRIDGE", "topicParameterGroup": + { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", + "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": + "dmaap" } }' + expectedResponse: 201 + name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + metadata: {} + description: Automation composition element for the http requests of AC Element + Bridge microservice + onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement: + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-sink:8084 + httpHeaders: + Content-Type: application/json + Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0 + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.sink + version: 1.0.0 + restSequence: + - restRequestId: + name: request3 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.sink", "version": + "1.0.0" }, "timerMs": 4000, "elementType": "SINK", "topicParameterGroup": + { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", + "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": + "dmaap" } }' + expectedResponse: 201 + name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 + metadata: {} + description: Automation composition element for the http requests of AC Element + Sink microservice + onap.policy.clamp.ac.element.AutomationCompositionDefinition: + type: org.onap.policy.clamp.acm.AutomationComposition + type_version: 1.0.1 + properties: + provider: ONAP + elements: + - name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + - name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + - name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 + name: onap.policy.clamp.ac.element.AutomationCompositionDefinition + version: 1.2.3 + metadata: {} + description: Automation composition for Demp + name: tosca + version: 1.0.0 + metadata: {} diff --git a/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json b/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json new file mode 100644 index 000000000..55b99b28c --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json @@ -0,0 +1,72 @@ +{ + "automationCompositionList": [ + { + "compositionId": "562ed027-2689-481a-b3a5-e284b1fbc33f", + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "elements": { + "709c62b3-8918-41b9-a747-d21eb79c6c23": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c23", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Sink Automation Composition Element for the Demo", + "propertiesMap": {} + }, + "709c62b3-8918-41b9-a747-d21eb79c6c25": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c25", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Bridge Automation Composition Element for the Demo", + "propertiesMap": {} + }, + "709c62b3-8918-41b9-a747-d21eb79c6c24": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c24", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Starter Automation Composition Element for the Demo", + "propertiesMap": {} + } + }, + "primed": false, + "name": "InstanceHttp", + "version": "1.0.1", + "description": "Demo automation composition instance Http" + } + ] +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml new file mode 100644 index 000000000..3fa6506ea --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml @@ -0,0 +1,54 @@ +automationCompositionList: +- compositionId: 562ed027-2689-481a-b3a5-e284b1fbc33f + state: UNINITIALISED + orderedState: UNINITIALISED + elements: + 709c62b3-8918-41b9-a747-d21eb79c6c23: + id: 709c62b3-8918-41b9-a747-d21eb79c6c23 + definition: + name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + participantId: + name: HttpParticipant0 + version: 1.0.0 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Sink Automation Composition Element for the Demo + propertiesMap: {} + 709c62b3-8918-41b9-a747-d21eb79c6c25: + id: 709c62b3-8918-41b9-a747-d21eb79c6c25 + definition: + name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + participantId: + name: HttpParticipant0 + version: 1.0.0 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Bridge Automation Composition Element for the Demo + propertiesMap: {} + 709c62b3-8918-41b9-a747-d21eb79c6c24: + id: 709c62b3-8918-41b9-a747-d21eb79c6c24 + definition: + name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + participantId: + name: HttpParticipant0 + version: 1.0.0 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Starter Automation Composition Element for the Demo + propertiesMap: {} + primed: false + name: InstanceHttp + version: 1.0.1 + description: Demo automation composition instance Http diff --git a/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json b/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json new file mode 100644 index 000000000..37ea18974 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json @@ -0,0 +1,487 @@ +{ + "tosca_definitions_version": "tosca_simple_yaml_1_3", + "data_types": { + "onap.datatypes.ToscaConceptIdentifier": { + "properties": { + "name": { + "name": "name", + "type": "string", + "type_version": "0.0.0", + "required": true + }, + "version": { + "name": "version", + "type": "string", + "type_version": "0.0.0", + "required": true + } + }, + "name": "onap.datatypes.ToscaConceptIdentifier", + "version": "0.0.0", + "derived_from": "tosca.datatypes.Root", + "metadata": {} + }, + "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest": { + "properties": { + "restRequestId": { + "name": "restRequestId", + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0", + "description": "The name and version of a REST request to be sent to a REST endpoint", + "required": true + }, + "httpMethod": { + "name": "httpMethod", + "type": "string", + "type_version": "0.0.0", + "description": "The REST method to use", + "required": true, + "constraints": [ + { + "valid_values": [ + "POST", + "PUT", + "GET", + "DELETE" + ] + } + ] + }, + "path": { + "name": "path", + "type": "string", + "type_version": "0.0.0", + "description": "The path of the REST request relative to the base URL", + "required": true + }, + "body": { + "name": "body", + "type": "string", + "type_version": "0.0.0", + "description": "The body of the REST request for PUT and POST requests", + "required": false + }, + "expectedResponse": { + "name": "expectedResponse", + "type": "integer", + "type_version": "0.0.0", + "description": "THe expected HTTP status code for the REST request", + "required": true, + "constraints": [] + } + }, + "name": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest", + "version": "1.0.0", + "derived_from": "tosca.datatypes.Root", + "metadata": {} + }, + "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity": { + "properties": { + "configurationEntityId": { + "name": "configurationEntityId", + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0", + "description": "The name and version of a Configuration Entity to be handled by the HTTP Automation Composition Element", + "required": true + }, + "restSequence": { + "name": "restSequence", + "type": "list", + "type_version": "0.0.0", + "description": "A sequence of REST commands to send to the REST endpoint", + "required": false, + "entry_schema": { + "type": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest", + "type_version": "1.0.0" + } + } + }, + "name": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity", + "version": "1.0.0", + "derived_from": "tosca.datatypes.Root", + "metadata": {} + } + }, + "node_types": { + "org.onap.policy.clamp.acm.Participant": { + "properties": { + "provider": { + "name": "provider", + "type": "string", + "type_version": "0.0.0", + "required": false + } + }, + "name": "org.onap.policy.clamp.acm.Participant", + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "metadata": {} + }, + "org.onap.policy.clamp.acm.AutomationCompositionElement": { + "properties": { + "provider": { + "name": "provider", + "type": "string", + "type_version": "0.0.0", + "description": "Specifies the organization that provides the automation composition element", + "required": false, + "metadata": { + "common": "true" + } + }, + "participant_id": { + "name": "participant_id", + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0", + "required": true, + "metadata": { + "common": "true" + } + }, + "participantType": { + "name": "participantType", + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0", + "description": "The identity of the participant type that hosts this type of Automation Composition Element", + "required": true, + "metadata": { + "common": "true" + } + }, + "startPhase": { + "name": "startPhase", + "type": "integer", + "type_version": "0.0.0", + "description": "A value indicating the start phase in which this automation composition element will be started, the first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped in reverse start phase order. Automation Composition Elements with the same start phase are started and stopped simultaneously", + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + }, + "uninitializedToPassiveTimeout": { + "name": "uninitializedToPassiveTimeout", + "type": "integer", + "type_version": "0.0.0", + "description": "The maximum time in seconds to wait for a state chage from uninitialized to passive", + "default": 60.0, + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + }, + "passiveToRunningTimeout": { + "name": "passiveToRunningTimeout", + "type": "integer", + "type_version": "0.0.0", + "description": "The maximum time in seconds to wait for a state chage from passive to running", + "default": 60.0, + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + }, + "runningToPassiveTimeout": { + "name": "runningToPassiveTimeout", + "type": "integer", + "type_version": "0.0.0", + "description": "The maximum time in seconds to wait for a state chage from running to passive", + "default": 60.0, + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + }, + "passiveToUninitializedTimeout": { + "name": "passiveToUninitializedTimeout", + "type": "integer", + "type_version": "0.0.0", + "description": "The maximum time in seconds to wait for a state chage from passive to uninitialized", + "default": 60.0, + "required": false, + "constraints": [ + { + "greater_or_equal": "0" + } + ], + "metadata": { + "common": "true" + } + } + }, + "name": "org.onap.policy.clamp.acm.AutomationCompositionElement", + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "metadata": {} + }, + "org.onap.policy.clamp.acm.AutomationComposition": { + "properties": { + "provider": { + "name": "provider", + "type": "string", + "type_version": "0.0.0", + "description": "Specifies the organization that provides the automation composition element", + "required": false, + "metadata": { + "common": "true" + } + }, + "elements": { + "name": "elements", + "type": "list", + "type_version": "0.0.0", + "description": "Specifies a list of automation composition element definitions that make up this automation composition definition", + "required": true, + "entry_schema": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "type_version": "0.0.0" + }, + "metadata": { + "common": "true" + } + } + }, + "name": "org.onap.policy.clamp.acm.AutomationComposition", + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "metadata": {} + }, + "org.onap.policy.clamp.acm.HttpAutomationCompositionElement": { + "properties": { + "baseUrl": { + "name": "baseUrl", + "type": "string", + "type_version": "0.0.0", + "description": "The base URL to be prepended to each path, identifies the host for the REST endpoints.", + "required": true + }, + "httpHeaders": { + "name": "httpHeaders", + "type": "map", + "type_version": "0.0.0", + "description": "HTTP headers to send on REST requests", + "required": false, + "entry_schema": { + "type": "string", + "type_version": "0.0.0" + } + }, + "configurationEntities": { + "name": "configurationEntities", + "type": "map", + "type_version": "0.0.0", + "description": "The connfiguration entities the Automation Composition Element is managing and their associated REST requests", + "required": true, + "entry_schema": { + "type": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity", + "type_version": "1.0.0" + } + } + }, + "name": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "version": "1.0.1", + "derived_from": "org.onap.policy.clamp.acm.AutomationCompositionElement", + "metadata": {} + } + }, + "topology_template": { + "node_templates": { + "org.onap.policy.clamp.acm.HttpParticipant": { + "type": "org.onap.policy.clamp.acm.Participant", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP" + }, + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4", + "metadata": {}, + "description": "Participant for Http requests" + }, + "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement": { + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-starter:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.starter", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request1", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.startertobridge\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"STARTER\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + }, + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3", + "metadata": {}, + "description": "Automation composition element for the http requests of AC Element Starter microservice" + }, + "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement": { + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-bridge:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.bridge", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request2", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.bridgetosink\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"BRIDGE\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + }, + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3", + "metadata": {}, + "description": "Automation composition element for the http requests of AC Element Bridge microservice" + }, + "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement": { + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-sink:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.sink", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request3", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.sink\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"SINK\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + }, + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3", + "metadata": {}, + "description": "Automation composition element for the http requests of AC Element Sink microservice" + }, + "onap.policy.clamp.ac.element.AutomationCompositionDefinition": { + "type": "org.onap.policy.clamp.acm.AutomationComposition", + "type_version": "1.0.1", + "properties": { + "provider": "ONAP", + "elements": [ + { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + } + ] + }, + "name": "onap.policy.clamp.ac.element.AutomationCompositionDefinition", + "version": "1.2.3", + "metadata": {}, + "description": "Automation composition for Demp" + } + } + }, + "name": "tosca", + "version": "1.0.0", + "metadata": {} +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml b/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml new file mode 100644 index 000000000..5e2c61144 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml @@ -0,0 +1,391 @@ +tosca_definitions_version: tosca_simple_yaml_1_3 +data_types: + onap.datatypes.ToscaConceptIdentifier: + properties: + name: + name: name + type: string + type_version: 0.0.0 + required: true + version: + name: version + type: string + type_version: 0.0.0 + required: true + name: onap.datatypes.ToscaConceptIdentifier + version: 0.0.0 + derived_from: tosca.datatypes.Root + metadata: {} + org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest: + properties: + restRequestId: + name: restRequestId + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + description: The name and version of a REST request to be sent to a REST endpoint + required: true + httpMethod: + name: httpMethod + type: string + type_version: 0.0.0 + description: The REST method to use + required: true + constraints: + - valid_values: + - POST + - PUT + - GET + - DELETE + path: + name: path + type: string + type_version: 0.0.0 + description: The path of the REST request relative to the base URL + required: true + body: + name: body + type: string + type_version: 0.0.0 + description: The body of the REST request for PUT and POST requests + required: false + expectedResponse: + name: expectedResponse + type: integer + type_version: 0.0.0 + description: THe expected HTTP status code for the REST request + required: true + constraints: [] + name: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest + version: 1.0.0 + derived_from: tosca.datatypes.Root + metadata: {} + org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity: + properties: + configurationEntityId: + name: configurationEntityId + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + description: The name and version of a Configuration Entity to be handled + by the HTTP Automation Composition Element + required: true + restSequence: + name: restSequence + type: list + type_version: 0.0.0 + description: A sequence of REST commands to send to the REST endpoint + required: false + entry_schema: + type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest + type_version: 1.0.0 + name: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity + version: 1.0.0 + derived_from: tosca.datatypes.Root + metadata: {} +node_types: + org.onap.policy.clamp.acm.Participant: + properties: + provider: + name: provider + type: string + type_version: 0.0.0 + required: false + name: org.onap.policy.clamp.acm.Participant + version: 1.0.1 + derived_from: tosca.nodetypes.Root + metadata: {} + org.onap.policy.clamp.acm.AutomationCompositionElement: + properties: + provider: + name: provider + type: string + type_version: 0.0.0 + description: Specifies the organization that provides the automation composition + element + required: false + metadata: + common: 'true' + participant_id: + name: participant_id + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + required: true + metadata: + common: 'true' + participantType: + name: participantType + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + description: The identity of the participant type that hosts this type of + Automation Composition Element + required: true + metadata: + common: 'true' + startPhase: + name: startPhase + type: integer + type_version: 0.0.0 + description: A value indicating the start phase in which this automation composition + element will be started, the first start phase is zero. Automation Composition + Elements are started in their start_phase order and stopped in reverse start + phase order. Automation Composition Elements with the same start phase are + started and stopped simultaneously + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + uninitializedToPassiveTimeout: + name: uninitializedToPassiveTimeout + type: integer + type_version: 0.0.0 + description: The maximum time in seconds to wait for a state chage from uninitialized + to passive + default: 60.0 + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + passiveToRunningTimeout: + name: passiveToRunningTimeout + type: integer + type_version: 0.0.0 + description: The maximum time in seconds to wait for a state chage from passive + to running + default: 60.0 + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + runningToPassiveTimeout: + name: runningToPassiveTimeout + type: integer + type_version: 0.0.0 + description: The maximum time in seconds to wait for a state chage from running + to passive + default: 60.0 + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + passiveToUninitializedTimeout: + name: passiveToUninitializedTimeout + type: integer + type_version: 0.0.0 + description: The maximum time in seconds to wait for a state chage from passive + to uninitialized + default: 60.0 + required: false + constraints: + - greater_or_equal: '0' + metadata: + common: 'true' + name: org.onap.policy.clamp.acm.AutomationCompositionElement + version: 1.0.1 + derived_from: tosca.nodetypes.Root + metadata: {} + org.onap.policy.clamp.acm.AutomationComposition: + properties: + provider: + name: provider + type: string + type_version: 0.0.0 + description: Specifies the organization that provides the automation composition + element + required: false + metadata: + common: 'true' + elements: + name: elements + type: list + type_version: 0.0.0 + description: Specifies a list of automation composition element definitions + that make up this automation composition definition + required: true + entry_schema: + type: onap.datatypes.ToscaConceptIdentifier + type_version: 0.0.0 + metadata: + common: 'true' + name: org.onap.policy.clamp.acm.AutomationComposition + version: 1.0.1 + derived_from: tosca.nodetypes.Root + metadata: {} + org.onap.policy.clamp.acm.HttpAutomationCompositionElement: + properties: + baseUrl: + name: baseUrl + type: string + type_version: 0.0.0 + description: The base URL to be prepended to each path, identifies the host + for the REST endpoints. + required: true + httpHeaders: + name: httpHeaders + type: map + type_version: 0.0.0 + description: HTTP headers to send on REST requests + required: false + entry_schema: + type: string + type_version: 0.0.0 + configurationEntities: + name: configurationEntities + type: map + type_version: 0.0.0 + description: The connfiguration entities the Automation Composition Element + is managing and their associated REST requests + required: true + entry_schema: + type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity + type_version: 1.0.0 + name: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + version: 1.0.1 + derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement + metadata: {} +topology_template: + node_templates: + org.onap.policy.clamp.acm.HttpParticipant: + type: org.onap.policy.clamp.acm.Participant + type_version: 1.0.1 + properties: + provider: ONAP + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + metadata: {} + description: Participant for Http requests + onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement: + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-starter:8084 + httpHeaders: + Content-Type: application/json + Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0 + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.starter + version: 1.0.0 + restSequence: + - restRequestId: + name: request1 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.startertobridge", + "version": "1.0.0" }, "timerMs": 4000, "elementType": "STARTER", "topicParameterGroup": + { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", + "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": + "dmaap" } }' + expectedResponse: 201 + name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + metadata: {} + description: Automation composition element for the http requests of AC Element + Starter microservice + onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement: + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-bridge:8084 + httpHeaders: + Content-Type: application/json + Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0 + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.bridge + version: 1.0.0 + restSequence: + - restRequestId: + name: request2 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.bridgetosink", + "version": "1.0.0" }, "timerMs": 4000, "elementType": "BRIDGE", "topicParameterGroup": + { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", + "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": + "dmaap" } }' + expectedResponse: 201 + name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + metadata: {} + description: Automation composition element for the http requests of AC Element + Bridge microservice + onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement: + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-sink:8084 + httpHeaders: + Content-Type: application/json + Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0 + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.sink + version: 1.0.0 + restSequence: + - restRequestId: + name: request3 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.sink", "version": + "1.0.0" }, "timerMs": 4000, "elementType": "SINK", "topicParameterGroup": + { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", + "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": + "dmaap" } }' + expectedResponse: 201 + name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 + metadata: {} + description: Automation composition element for the http requests of AC Element + Sink microservice + onap.policy.clamp.ac.element.AutomationCompositionDefinition: + type: org.onap.policy.clamp.acm.AutomationComposition + type_version: 1.0.1 + properties: + provider: ONAP + elements: + - name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + - name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + - name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 + name: onap.policy.clamp.ac.element.AutomationCompositionDefinition + version: 1.2.3 + metadata: {} + description: Automation composition for Demp +name: tosca +version: 1.0.0 +metadata: {} diff --git a/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.json b/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.json new file mode 100644 index 000000000..20602f730 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.json @@ -0,0 +1,25 @@ +{ + "compositionId": "562ed027-2689-481a-b3a5-e284b1fbc33f", + "affectedAutomationCompositionDefinitions": [ + { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.AutomationCompositionDefinition", + "version": "1.2.3" + } + ] +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml new file mode 100644 index 000000000..893205dca --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml @@ -0,0 +1,12 @@ +compositionId: 562ed027-2689-481a-b3a5-e284b1fbc33f +affectedAutomationCompositionDefinitions: +- name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 +- name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.AutomationCompositionDefinition + version: 1.2.3 diff --git a/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.json b/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.json new file mode 100644 index 000000000..61314cf6c --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.json @@ -0,0 +1,410 @@ +{ + "tosca_definitions_version": "tosca_simple_yaml_1_3", + "data_types": { + "onap.datatypes.ToscaConceptIdentifier": { + "derived_from": "tosca.datatypes.Root", + "properties": { + "name": { + "type": "string", + "required": true + }, + "version": { + "type": "string", + "required": true + } + } + }, + "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest": { + "version": "1.0.0", + "derived_from": "tosca.datatypes.Root", + "properties": { + "restRequestId": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "required": true, + "description": "The name and version of a REST request to be sent to a REST endpoint" + }, + "httpMethod": { + "type": "string", + "required": true, + "constraints": [ + { + "valid_values": [ + "POST", + "PUT", + "GET", + "DELETE" + ] + } + ], + "description": "The REST method to use" + }, + "path": { + "type": "string", + "required": true, + "description": "The path of the REST request relative to the base URL" + }, + "body": { + "type": "string", + "required": false, + "description": "The body of the REST request for PUT and POST requests" + }, + "expectedResponse": { + "type": "integer", + "required": true, + "constraints": [], + "description": "THe expected HTTP status code for the REST request" + } + } + }, + "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity": { + "version": "1.0.0", + "derived_from": "tosca.datatypes.Root", + "properties": { + "configurationEntityId": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "required": true, + "description": "The name and version of a Configuration Entity to be handled by the HTTP Automation Composition Element" + }, + "restSequence": { + "type": "list", + "entry_schema": { + "type": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest", + "type_version": "1.0.0" + }, + "description": "A sequence of REST commands to send to the REST endpoint" + } + } + } + }, + "node_types": { + "org.onap.policy.clamp.acm.Participant": { + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "properties": { + "provider": { + "type": "string", + "required": false + } + } + }, + "org.onap.policy.clamp.acm.AutomationCompositionElement": { + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "properties": { + "provider": { + "type": "string", + "required": false, + "metadata": { + "common": true + }, + "description": "Specifies the organization that provides the automation composition element" + }, + "participant_id": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "required": true, + "metadata": { + "common": true + } + }, + "participantType": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "required": true, + "metadata": { + "common": true + }, + "description": "The identity of the participant type that hosts this type of Automation Composition Element" + }, + "startPhase": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "metadata": { + "common": true + }, + "description": "A value indicating the start phase in which this automation composition element will be started, the first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped in reverse start phase order. Automation Composition Elements with the same start phase are started and stopped simultaneously" + }, + "uninitializedToPassiveTimeout": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "default": 60, + "metadata": { + "common": true + }, + "description": "The maximum time in seconds to wait for a state chage from uninitialized to passive" + }, + "passiveToRunningTimeout": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "default": 60, + "metadata": { + "common": true + }, + "description": "The maximum time in seconds to wait for a state chage from passive to running" + }, + "runningToPassiveTimeout": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "default": 60, + "metadata": { + "common": true + }, + "description": "The maximum time in seconds to wait for a state chage from running to passive" + }, + "passiveToUninitializedTimeout": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "default": 60, + "metadata": { + "common": true + }, + "description": "The maximum time in seconds to wait for a state chage from passive to uninitialized" + } + } + }, + "org.onap.policy.clamp.acm.AutomationComposition": { + "version": "1.0.1", + "derived_from": "tosca.nodetypes.Root", + "properties": { + "provider": { + "type": "string", + "required": false, + "metadata": { + "common": true + }, + "description": "Specifies the organization that provides the automation composition element" + }, + "elements": { + "type": "list", + "required": true, + "metadata": { + "common": true + }, + "entry_schema": { + "type": "onap.datatypes.ToscaConceptIdentifier" + }, + "description": "Specifies a list of automation composition element definitions that make up this automation composition definition" + } + } + }, + "org.onap.policy.clamp.acm.HttpAutomationCompositionElement": { + "version": "1.0.1", + "derived_from": "org.onap.policy.clamp.acm.AutomationCompositionElement", + "properties": { + "baseUrl": { + "type": "string", + "required": true, + "description": "The base URL to be prepended to each path, identifies the host for the REST endpoints." + }, + "httpHeaders": { + "type": "map", + "required": false, + "entry_schema": { + "type": "string" + }, + "description": "HTTP headers to send on REST requests" + }, + "configurationEntities": { + "type": "map", + "required": true, + "entry_schema": { + "type": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity", + "type_version": "1.0.0" + }, + "description": "The connfiguration entities the Automation Composition Element is managing and their associated REST requests" + } + } + } + }, + "topology_template": { + "node_templates": { + "org.onap.policy.clamp.acm.HttpParticipant": { + "version": "2.3.4", + "type": "org.onap.policy.clamp.acm.Participant", + "type_version": "1.0.1", + "description": "Participant for Http requests", + "properties": { + "provider": "ONAP" + } + }, + "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement": { + "version": "1.2.3", + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "description": "Automation composition element for the http requests of AC Element Starter microservice", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-starter:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.starter", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request1", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.startertobridge\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"STARTER\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + } + }, + "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement": { + "version": "1.2.3", + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "description": "Automation composition element for the http requests of AC Element Bridge microservice", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-bridge:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.bridge", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request2", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.bridgetosink\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"BRIDGE\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + } + }, + "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement": { + "version": "1.2.3", + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.1", + "description": "Automation composition element for the http requests of AC Element Sink microservice", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-sink:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.sink", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request3", + "version": "1.0.1" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.sink\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"SINK\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + } + }, + "onap.policy.clamp.ac.element.AutomationCompositionDefinition": { + "version": "1.2.3", + "type": "org.onap.policy.clamp.acm.AutomationComposition", + "type_version": "1.0.1", + "description": "Automation composition for Demp", + "properties": { + "provider": "ONAP", + "elements": [ + { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + } + ] + } + } + } + } +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml b/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml new file mode 100644 index 000000000..c60209836 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml @@ -0,0 +1,312 @@ +# ============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========================================================= +tosca_definitions_version: tosca_simple_yaml_1_3 +data_types: + onap.datatypes.ToscaConceptIdentifier: + derived_from: tosca.datatypes.Root + properties: + name: + type: string + required: true + version: + type: string + required: true + + org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest: + version: 1.0.0 + derived_from: tosca.datatypes.Root + properties: + restRequestId: + type: onap.datatypes.ToscaConceptIdentifier + required: true + description: The name and version of a REST request to be sent to a REST endpoint + httpMethod: + type: string + required: true + constraints: + - valid_values: + - POST + - PUT + - GET + - DELETE + description: The REST method to use + path: + type: string + required: true + description: The path of the REST request relative to the base URL + body: + type: string + required: false + description: The body of the REST request for PUT and POST requests + expectedResponse: + type: integer + required: true + constraints: [] + description: THe expected HTTP status code for the REST request + org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity: + version: 1.0.0 + derived_from: tosca.datatypes.Root + properties: + configurationEntityId: + type: onap.datatypes.ToscaConceptIdentifier + required: true + description: The name and version of a Configuration Entity to be handled + by the HTTP Automation Composition Element + restSequence: + type: list + entry_schema: + type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest + type_version: 1.0.0 + description: A sequence of REST commands to send to the REST endpoint + +node_types: + org.onap.policy.clamp.acm.Participant: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + org.onap.policy.clamp.acm.AutomationCompositionElement: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + metadata: + common: true + description: Specifies the organization that provides the automation composition element + participant_id: + type: onap.datatypes.ToscaConceptIdentifier + required: true + metadata: + common: true + participantType: + type: onap.datatypes.ToscaConceptIdentifier + required: true + metadata: + common: true + description: The identity of the participant type that hosts this type of Automation Composition Element + startPhase: + type: integer + required: false + constraints: + - greater_or_equal: 0 + metadata: + common: true + description: A value indicating the start phase in which this automation composition element will be started, the + first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped + in reverse start phase order. Automation Composition Elements with the same start phase are started and + stopped simultaneously + uninitializedToPassiveTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from uninitialized to passive + passiveToRunningTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from passive to running + runningToPassiveTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from running to passive + passiveToUninitializedTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from passive to uninitialized + org.onap.policy.clamp.acm.AutomationComposition: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + metadata: + common: true + description: Specifies the organization that provides the automation composition element + elements: + type: list + required: true + metadata: + common: true + entry_schema: + type: onap.datatypes.ToscaConceptIdentifier + description: Specifies a list of automation composition element definitions that make up this automation composition definition + org.onap.policy.clamp.acm.HttpAutomationCompositionElement: + version: 1.0.1 + derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement + properties: + baseUrl: + type: string + required: true + description: The base URL to be prepended to each path, identifies the host for the REST endpoints. + httpHeaders: + type: map + required: false + entry_schema: + type: string + description: HTTP headers to send on REST requests + configurationEntities: + type: map + required: true + entry_schema: + type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity + type_version: 1.0.0 + description: The connfiguration entities the Automation Composition Element is managing and their associated REST requests + +topology_template: + node_templates: + org.onap.policy.clamp.acm.HttpParticipant: + version: 2.3.4 + type: org.onap.policy.clamp.acm.Participant + type_version: 1.0.1 + description: Participant for Http requests + properties: + provider: ONAP + onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement: + # Http config for AC Element Starter. + version: 1.2.3 + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + description: Automation composition element for the http requests of AC Element Starter microservice + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-starter:8084 + httpHeaders: + Content-Type: application/json + Authorization: 'Basic cnVudGltZVVzZXI6emIhWHp0RzM0' + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.starter + version: 1.0.0 + restSequence: + - restRequestId: + name: request1 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.startertobridge", "version": "1.0.0" }, "timerMs": 4000, "elementType": "STARTER", "topicParameterGroup": { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": "dmaap" } }' + expectedResponse: 201 + onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement: + # Http config for AC Element Bridge. + version: 1.2.3 + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + description: Automation composition element for the http requests of AC Element Bridge microservice + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-bridge:8084 + httpHeaders: + Content-Type: application/json + Authorization: 'Basic cnVudGltZVVzZXI6emIhWHp0RzM0' + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.bridge + version: 1.0.0 + restSequence: + - restRequestId: + name: request2 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.bridgetosink", "version": "1.0.0" }, "timerMs": 4000, "elementType": "BRIDGE", "topicParameterGroup": { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": "dmaap" } }' + expectedResponse: 201 + onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement: + # Http config for AC Element Sink. + version: 1.2.3 + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.1 + description: Automation composition element for the http requests of AC Element Sink microservice + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-sink:8084 + httpHeaders: + Content-Type: application/json + Authorization: 'Basic cnVudGltZVVzZXI6emIhWHp0RzM0' + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.sink + version: 1.0.0 + restSequence: + - restRequestId: + name: request3 + version: 1.0.1 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.sink", "version": "1.0.0" }, "timerMs": 4000, "elementType": "SINK", "topicParameterGroup": { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": "dmaap" } }' + expectedResponse: 201 + + onap.policy.clamp.ac.element.AutomationCompositionDefinition: + version: 1.2.3 + type: org.onap.policy.clamp.acm.AutomationComposition + type_version: 1.0.1 + description: Automation composition for Demp + properties: + provider: ONAP + elements: + - name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + - name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + - name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 diff --git a/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.json b/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.json new file mode 100644 index 000000000..d2886038f --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.json @@ -0,0 +1,64 @@ +{ + "name": "InstanceHttp", + "version": "1.0.1", + "compositionId": "562ed027-2689-481a-b3a5-e284b1fbc33f", + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Demo automation composition instance Http", + "elements": { + "709c62b3-8918-41b9-a747-d21eb79c6c24": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c24", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Starter Automation Composition Element for the Demo" + }, + "709c62b3-8918-41b9-a747-d21eb79c6c25": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c25", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Bridge Automation Composition Element for the Demo" + }, + "709c62b3-8918-41b9-a747-d21eb79c6c23": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c23", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Sink Automation Composition Element for the Demo" + } + } +} diff --git a/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.yaml b/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.yaml new file mode 100644 index 000000000..96111aa35 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.yaml @@ -0,0 +1,49 @@ +name: InstanceHttp +version: 1.0.1 +compositionId: 562ed027-2689-481a-b3a5-e284b1fbc33f +state: UNINITIALISED +orderedState: UNINITIALISED +description: Demo automation composition instance Http +elements: + 709c62b3-8918-41b9-a747-d21eb79c6c24: + id: 709c62b3-8918-41b9-a747-d21eb79c6c24 + definition: + name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + participantId: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Starter Automation Composition Element for the Demo + 709c62b3-8918-41b9-a747-d21eb79c6c25: + id: 709c62b3-8918-41b9-a747-d21eb79c6c25 + definition: + name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + participantId: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Bridge Automation Composition Element for the Demo + 709c62b3-8918-41b9-a747-d21eb79c6c23: + id: 709c62b3-8918-41b9-a747-d21eb79c6c23 + definition: + name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 + participantId: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Sink Automation Composition Element for the Demo diff --git a/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json b/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json new file mode 100644 index 000000000..b662bc6b6 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json @@ -0,0 +1,6 @@ +{ + "affectedAutomationComposition": { + "name": "InstanceHttp", + "version": "1.0.1" + } +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml new file mode 100644 index 000000000..1fbca51ac --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml @@ -0,0 +1,3 @@ +affectedAutomationComposition: + name: InstanceHttp + version: 1.0.1 diff --git a/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.json b/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.json new file mode 100644 index 000000000..78b81d628 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.json @@ -0,0 +1,410 @@ +{ + "tosca_definitions_version": "tosca_simple_yaml_1_3", + "data_types": { + "onap.datatypes.ToscaConceptIdentifier": { + "derived_from": "tosca.datatypes.Root", + "properties": { + "name": { + "type": "string", + "required": true + }, + "version": { + "type": "string", + "required": true + } + } + }, + "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest": { + "version": "1.0.0", + "derived_from": "tosca.datatypes.Root", + "properties": { + "restRequestId": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "required": true, + "description": "The name and version of a REST request to be sent to a REST endpoint" + }, + "httpMethod": { + "type": "string", + "required": true, + "constraints": [ + { + "valid_values": [ + "POST", + "PUT", + "GET", + "DELETE" + ] + } + ], + "description": "The REST method to use" + }, + "path": { + "type": "string", + "required": true, + "description": "The path of the REST request relative to the base URL" + }, + "body": { + "type": "string", + "required": false, + "description": "The body of the REST request for PUT and POST requests" + }, + "expectedResponse": { + "type": "integer", + "required": true, + "constraints": [], + "description": "THe expected HTTP status code for the REST request" + } + } + }, + "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity": { + "version": "1.0.0", + "derived_from": "tosca.datatypes.Root", + "properties": { + "configurationEntityId": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "required": true, + "description": "The name and version of a Configuration Entity to be handled by the HTTP Automation Composition Element" + }, + "restSequence": { + "type": "list", + "entry_schema": { + "type": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest", + "type_version": "1.0.0" + }, + "description": "A sequence of REST commands to send to the REST endpoint" + } + } + } + }, + "node_types": { + "org.onap.policy.clamp.acm.Participant": { + "version": "1.0.2", + "derived_from": "tosca.nodetypes.Root", + "properties": { + "provider": { + "type": "string", + "required": false + } + } + }, + "org.onap.policy.clamp.acm.AutomationCompositionElement": { + "version": "1.0.2", + "derived_from": "tosca.nodetypes.Root", + "properties": { + "provider": { + "type": "string", + "required": false, + "metadata": { + "common": true + }, + "description": "Specifies the organization that provides the automation composition element" + }, + "participant_id": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "required": true, + "metadata": { + "common": true + } + }, + "participantType": { + "type": "onap.datatypes.ToscaConceptIdentifier", + "required": true, + "metadata": { + "common": true + }, + "description": "The identity of the participant type that hosts this type of Automation Composition Element" + }, + "startPhase": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "metadata": { + "common": true + }, + "description": "A value indicating the start phase in which this automation composition element will be started, the first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped in reverse start phase order. Automation Composition Elements with the same start phase are started and stopped simultaneously" + }, + "uninitializedToPassiveTimeout": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "default": 60, + "metadata": { + "common": true + }, + "description": "The maximum time in seconds to wait for a state chage from uninitialized to passive" + }, + "passiveToRunningTimeout": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "default": 60, + "metadata": { + "common": true + }, + "description": "The maximum time in seconds to wait for a state chage from passive to running" + }, + "runningToPassiveTimeout": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "default": 60, + "metadata": { + "common": true + }, + "description": "The maximum time in seconds to wait for a state chage from running to passive" + }, + "passiveToUninitializedTimeout": { + "type": "integer", + "required": false, + "constraints": [ + { + "greater_or_equal": 0 + } + ], + "default": 60, + "metadata": { + "common": true + }, + "description": "The maximum time in seconds to wait for a state chage from passive to uninitialized" + } + } + }, + "org.onap.policy.clamp.acm.AutomationComposition": { + "version": "1.0.2", + "derived_from": "tosca.nodetypes.Root", + "properties": { + "provider": { + "type": "string", + "required": false, + "metadata": { + "common": true + }, + "description": "Specifies the organization that provides the automation composition element" + }, + "elements": { + "type": "list", + "required": true, + "metadata": { + "common": true + }, + "entry_schema": { + "type": "onap.datatypes.ToscaConceptIdentifier" + }, + "description": "Specifies a list of automation composition element definitions that make up this automation composition definition" + } + } + }, + "org.onap.policy.clamp.acm.HttpAutomationCompositionElement": { + "version": "1.0.2", + "derived_from": "org.onap.policy.clamp.acm.AutomationCompositionElement", + "properties": { + "baseUrl": { + "type": "string", + "required": true, + "description": "The base URL to be prepended to each path, identifies the host for the REST endpoints." + }, + "httpHeaders": { + "type": "map", + "required": false, + "entry_schema": { + "type": "string" + }, + "description": "HTTP headers to send on REST requests" + }, + "configurationEntities": { + "type": "map", + "required": true, + "entry_schema": { + "type": "org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity", + "type_version": "1.0.0" + }, + "description": "The connfiguration entities the Automation Composition Element is managing and their associated REST requests" + } + } + } + }, + "topology_template": { + "node_templates": { + "org.onap.policy.clamp.acm.HttpParticipant": { + "version": "2.3.4", + "type": "org.onap.policy.clamp.acm.Participant", + "type_version": "1.0.2", + "description": "Participant for Http requests", + "properties": { + "provider": "ONAP" + } + }, + "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement": { + "version": "1.2.3", + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.2", + "description": "Automation composition element for the http requests of AC Element Starter microservice", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-starter:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.starter", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request1", + "version": "1.0.2" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.startertobridge\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"STARTER\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + } + }, + "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement": { + "version": "1.2.3", + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.2", + "description": "Automation composition element for the http requests of AC Element Bridge microservice", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-bridge:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.bridge", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request2", + "version": "1.0.2" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.bridgetosink\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"BRIDGE\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + } + }, + "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement": { + "version": "1.2.3", + "type": "org.onap.policy.clamp.acm.HttpAutomationCompositionElement", + "type_version": "1.0.2", + "description": "Automation composition element for the http requests of AC Element Sink microservice", + "properties": { + "provider": "ONAP", + "participant_id": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "uninitializedToPassiveTimeout": 180, + "startPhase": 0, + "baseUrl": "http://acelement-sink:8084", + "httpHeaders": { + "Content-Type": "application/json", + "Authorization": "Basic cnVudGltZVVzZXI6emIhWHp0RzM0" + }, + "configurationEntities": [ + { + "configurationEntityId": { + "name": "onap.policy.clamp.ac.sink", + "version": "1.0.0" + }, + "restSequence": [ + { + "restRequestId": { + "name": "request3", + "version": "1.0.2" + }, + "httpMethod": "POST", + "path": "/onap/policy/clamp/acelement/v2/activate", + "body": "{ \"receiverId\": { \"name\": \"onap.policy.clamp.ac.sink\", \"version\": \"1.0.0\" }, \"timerMs\": 4000, \"elementType\": \"SINK\", \"topicParameterGroup\": { \"server\": \"message-router\", \"listenerTopic\": \"POLICY_UPDATE_MSG\", \"publisherTopic\": \"AC_ELEMENT_MSG\", \"fetchTimeout\": 15000, \"topicCommInfrastructure\": \"dmaap\" } }", + "expectedResponse": 201 + } + ] + } + ] + } + }, + "onap.policy.clamp.ac.element.AutomationCompositionDefinition": { + "version": "1.2.3", + "type": "org.onap.policy.clamp.acm.AutomationComposition", + "type_version": "1.0.2", + "description": "Automation composition for Demp", + "properties": { + "provider": "ONAP", + "elements": [ + { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + } + ] + } + } + } + } +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.yaml b/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.yaml new file mode 100644 index 000000000..cacadce4f --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdate.yaml @@ -0,0 +1,312 @@ +# ============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========================================================= +tosca_definitions_version: tosca_simple_yaml_1_3 +data_types: + onap.datatypes.ToscaConceptIdentifier: + derived_from: tosca.datatypes.Root + properties: + name: + type: string + required: true + version: + type: string + required: true + + org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest: + version: 1.0.0 + derived_from: tosca.datatypes.Root + properties: + restRequestId: + type: onap.datatypes.ToscaConceptIdentifier + required: true + description: The name and version of a REST request to be sent to a REST endpoint + httpMethod: + type: string + required: true + constraints: + - valid_values: + - POST + - PUT + - GET + - DELETE + description: The REST method to use + path: + type: string + required: true + description: The path of the REST request relative to the base URL + body: + type: string + required: false + description: The body of the REST request for PUT and POST requests + expectedResponse: + type: integer + required: true + constraints: [] + description: THe expected HTTP status code for the REST request + org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity: + version: 1.0.0 + derived_from: tosca.datatypes.Root + properties: + configurationEntityId: + type: onap.datatypes.ToscaConceptIdentifier + required: true + description: The name and version of a Configuration Entity to be handled + by the HTTP Automation Composition Element + restSequence: + type: list + entry_schema: + type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest + type_version: 1.0.0 + description: A sequence of REST commands to send to the REST endpoint + +node_types: + org.onap.policy.clamp.acm.Participant: + version: 1.0.2 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + org.onap.policy.clamp.acm.AutomationCompositionElement: + version: 1.0.2 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + metadata: + common: true + description: Specifies the organization that provides the automation composition element + participant_id: + type: onap.datatypes.ToscaConceptIdentifier + required: true + metadata: + common: true + participantType: + type: onap.datatypes.ToscaConceptIdentifier + required: true + metadata: + common: true + description: The identity of the participant type that hosts this type of Automation Composition Element + startPhase: + type: integer + required: false + constraints: + - greater_or_equal: 0 + metadata: + common: true + description: A value indicating the start phase in which this automation composition element will be started, the + first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped + in reverse start phase order. Automation Composition Elements with the same start phase are started and + stopped simultaneously + uninitializedToPassiveTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from uninitialized to passive + passiveToRunningTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from passive to running + runningToPassiveTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from running to passive + passiveToUninitializedTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from passive to uninitialized + org.onap.policy.clamp.acm.AutomationComposition: + version: 1.0.2 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + metadata: + common: true + description: Specifies the organization that provides the automation composition element + elements: + type: list + required: true + metadata: + common: true + entry_schema: + type: onap.datatypes.ToscaConceptIdentifier + description: Specifies a list of automation composition element definitions that make up this automation composition definition + org.onap.policy.clamp.acm.HttpAutomationCompositionElement: + version: 1.0.2 + derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement + properties: + baseUrl: + type: string + required: true + description: The base URL to be prepended to each path, identifies the host for the REST endpoints. + httpHeaders: + type: map + required: false + entry_schema: + type: string + description: HTTP headers to send on REST requests + configurationEntities: + type: map + required: true + entry_schema: + type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity + type_version: 1.0.0 + description: The connfiguration entities the Automation Composition Element is managing and their associated REST requests + +topology_template: + node_templates: + org.onap.policy.clamp.acm.HttpParticipant: + version: 2.3.4 + type: org.onap.policy.clamp.acm.Participant + type_version: 1.0.2 + description: Participant for Http requests + properties: + provider: ONAP + onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement: + # Http config for AC Element Starter. + version: 1.2.3 + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.2 + description: Automation composition element for the http requests of AC Element Starter microservice + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-starter:8084 + httpHeaders: + Content-Type: application/json + Authorization: 'Basic cnVudGltZVVzZXI6emIhWHp0RzM0' + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.starter + version: 1.0.0 + restSequence: + - restRequestId: + name: request1 + version: 1.0.2 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.startertobridge", "version": "1.0.0" }, "timerMs": 4000, "elementType": "STARTER", "topicParameterGroup": { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": "dmaap" } }' + expectedResponse: 201 + onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement: + # Http config for AC Element Bridge. + version: 1.2.3 + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.2 + description: Automation composition element for the http requests of AC Element Bridge microservice + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-bridge:8084 + httpHeaders: + Content-Type: application/json + Authorization: 'Basic cnVudGltZVVzZXI6emIhWHp0RzM0' + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.bridge + version: 1.0.0 + restSequence: + - restRequestId: + name: request2 + version: 1.0.2 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.bridgetosink", "version": "1.0.0" }, "timerMs": 4000, "elementType": "BRIDGE", "topicParameterGroup": { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": "dmaap" } }' + expectedResponse: 201 + onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement: + # Http config for AC Element Sink. + version: 1.2.3 + type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement + type_version: 1.0.2 + description: Automation composition element for the http requests of AC Element Sink microservice + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + startPhase: 0 + baseUrl: http://acelement-sink:8084 + httpHeaders: + Content-Type: application/json + Authorization: 'Basic cnVudGltZVVzZXI6emIhWHp0RzM0' + configurationEntities: + - configurationEntityId: + name: onap.policy.clamp.ac.sink + version: 1.0.0 + restSequence: + - restRequestId: + name: request3 + version: 1.0.2 + httpMethod: POST + path: /onap/policy/clamp/acelement/v2/activate + body: '{ "receiverId": { "name": "onap.policy.clamp.ac.sink", "version": "1.0.0" }, "timerMs": 4000, "elementType": "SINK", "topicParameterGroup": { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG", "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure": "dmaap" } }' + expectedResponse: 201 + + onap.policy.clamp.ac.element.AutomationCompositionDefinition: + version: 1.2.3 + type: org.onap.policy.clamp.acm.AutomationComposition + type_version: 1.0.2 + description: Automation composition for Demp + properties: + provider: ONAP + elements: + - name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + - name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + - name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 diff --git a/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.json b/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.json new file mode 100644 index 000000000..20602f730 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.json @@ -0,0 +1,25 @@ +{ + "compositionId": "562ed027-2689-481a-b3a5-e284b1fbc33f", + "affectedAutomationCompositionDefinitions": [ + { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + }, + { + "name": "onap.policy.clamp.ac.element.AutomationCompositionDefinition", + "version": "1.2.3" + } + ] +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.yaml new file mode 100644 index 000000000..893205dca --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/putCompositionDefinitionUpdateResponse.yaml @@ -0,0 +1,12 @@ +compositionId: 562ed027-2689-481a-b3a5-e284b1fbc33f +affectedAutomationCompositionDefinitions: +- name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 +- name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 +- name: onap.policy.clamp.ac.element.AutomationCompositionDefinition + version: 1.2.3 diff --git a/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.json b/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.json new file mode 100644 index 000000000..2b3d96896 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.json @@ -0,0 +1,64 @@ +{ + "name": "InstanceHttp", + "version": "1.0.1", + "compositionId": "562ed027-2689-481a-b3a5-e284b1fbc33f", + "state": "UNINITIALISED", + "orderedState": "PASSIVE", + "description": "Demo automation composition instance Http", + "elements": { + "709c62b3-8918-41b9-a747-d21eb79c6c24": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c24", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement", + "version": "1.2.3" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Starter Automation Composition Element for the Demo" + }, + "709c62b3-8918-41b9-a747-d21eb79c6c25": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c25", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", + "version": "1.2.3" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Bridge Automation Composition Element for the Demo" + }, + "709c62b3-8918-41b9-a747-d21eb79c6c23": { + "id": "709c62b3-8918-41b9-a747-d21eb79c6c23", + "definition": { + "name": "onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement", + "version": "1.2.3" + }, + "participantId": { + "name": "HttpParticipant0", + "version": "1.0.0" + }, + "participantType": { + "name": "org.onap.policy.clamp.acm.HttpParticipant", + "version": "2.3.4" + }, + "state": "UNINITIALISED", + "orderedState": "UNINITIALISED", + "description": "Sink Automation Composition Element for the Demo" + } + } +} diff --git a/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.yaml b/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.yaml new file mode 100644 index 000000000..3628c6340 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.yaml @@ -0,0 +1,49 @@ +name: InstanceHttp +version: 1.0.1 +compositionId: 562ed027-2689-481a-b3a5-e284b1fbc33f +state: UNINITIALISED +orderedState: PASSIVE +description: Demo automation composition instance Http +elements: + 709c62b3-8918-41b9-a747-d21eb79c6c24: + id: 709c62b3-8918-41b9-a747-d21eb79c6c24 + definition: + name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement + version: 1.2.3 + participantId: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Starter Automation Composition Element for the Demo + 709c62b3-8918-41b9-a747-d21eb79c6c25: + id: 709c62b3-8918-41b9-a747-d21eb79c6c25 + definition: + name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement + version: 1.2.3 + participantId: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Bridge Automation Composition Element for the Demo + 709c62b3-8918-41b9-a747-d21eb79c6c23: + id: 709c62b3-8918-41b9-a747-d21eb79c6c23 + definition: + name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement + version: 1.2.3 + participantId: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.policy.clamp.acm.HttpParticipant + version: 2.3.4 + state: UNINITIALISED + orderedState: UNINITIALISED + description: Sink Automation Composition Element for the Demo diff --git a/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.json b/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.json new file mode 100644 index 000000000..b662bc6b6 --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.json @@ -0,0 +1,6 @@ +{ + "affectedAutomationComposition": { + "name": "InstanceHttp", + "version": "1.0.1" + } +}
\ No newline at end of file diff --git a/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.yaml new file mode 100644 index 000000000..1fbca51ac --- /dev/null +++ b/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdateResponse.yaml @@ -0,0 +1,3 @@ +affectedAutomationComposition: + name: InstanceHttp + version: 1.0.1 diff --git a/runtime-acm/src/main/resources/openapi/openapi.yaml b/runtime-acm/src/main/resources/openapi/openapi.yaml index de7b26ead..65d2c6b08 100644 --- a/runtime-acm/src/main/resources/openapi/openapi.yaml +++ b/runtime-acm/src/main/resources/openapi/openapi.yaml @@ -968,14 +968,12 @@ paths: content: application/json: schema: - title: InstantiationUpdate - type: object + $ref: '#/components/schemas/InstantiationUpdate' 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 + $ref: '#/components/schemas/InstantiationUpdate' example: externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putCompositionInstanceUpdate.yaml' required: true @@ -1228,6 +1226,9 @@ components: CommissioningResponse: title: CommissioningResponse type: object + InstantiationUpdate: + title: InstantiationUpdate + type: object InstantiationResponse: title: InstantiationResponse type: object |