otf-service-api/src/main/java/org/oran/otf/api/service/TestStrategyService.java

   1 /*  Copyright (c) 2019 AT&T Intellectual Property.                             #\r
   2 #                                                                              #\r
   3 #   Licensed under the Apache License, Version 2.0 (the "License");            #\r
   4 #   you may not use this file except in compliance with the License.           #\r
   5 #   You may obtain a copy of the License at                                    #\r
   6 #                                                                              #\r
   7 #       http://www.apache.org/licenses/LICENSE-2.0                             #\r
   8 #                                                                              #\r
   9 #   Unless required by applicable law or agreed to in writing, software        #\r
  10 #   distributed under the License is distributed on an "AS IS" BASIS,          #\r
  11 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #\r
  12 #   See the License for the specific language governing permissions and        #\r
  13 #   limitations under the License.                                             #\r
  14 ##############################################################################*/\r
  15 \r
  16 \r
  17 package org.oran.otf.api.service;\r
  18 \r
  19 import io.swagger.annotations.Api;\r
  20 import io.swagger.v3.oas.annotations.Hidden;\r
  21 import io.swagger.v3.oas.annotations.tags.Tag;\r
  22 import java.io.InputStream;\r
  23 import javax.ws.rs.Consumes;\r
  24 import javax.ws.rs.DELETE;\r
  25 import javax.ws.rs.HeaderParam;\r
  26 import javax.ws.rs.POST;\r
  27 import javax.ws.rs.Path;\r
  28 import javax.ws.rs.PathParam;\r
  29 import javax.ws.rs.Produces;\r
  30 import javax.ws.rs.core.MediaType;\r
  31 import javax.ws.rs.core.Response;\r
  32 import org.glassfish.jersey.media.multipart.FormDataParam;\r
  33 \r
  34 @Api\r
  35 @Hidden\r
  36 @Path("/testStrategy")\r
  37 @Tag(name = "Test Service", description = "Deploy and delete test strategies to and from the test control unit. (This documentation will only be available to the development team)")\r
  38 @Produces({MediaType.APPLICATION_JSON})\r
  39 public interface TestStrategyService {\r
  40   @POST\r
  41   @Hidden\r
  42   @Path("/deploy/v1")\r
  43   @Consumes(MediaType.MULTIPART_FORM_DATA)\r
  44   @Produces(MediaType.APPLICATION_JSON)\r
  45   Response deployTestStrategy(\r
  46       @FormDataParam("bpmn") InputStream bpmn,\r
  47       @FormDataParam("resources") InputStream compressedResources,\r
  48       @FormDataParam("testDefinitionId") String testDefinitionId,\r
  49       @FormDataParam("testDefinitionDeployerId") String testDefinitionDeployerId,\r
  50       @FormDataParam("definitionId") String definitionId,\r
  51       @HeaderParam("Authorization") String authorization);\r
  52 \r
  53   @DELETE\r
  54   @Hidden\r
  55   @Path("/delete/v1/testDefinitionId/{testDefinitionId}")\r
  56   Response deleteByTestDefinitionId(\r
  57       @PathParam("testDefinitionId") String testDefinitionId,\r
  58       @HeaderParam("authorization") String authorization);\r
  59 \r
  60   @DELETE\r
  61   @Hidden\r
  62   @Path("/delete/v1/deploymentId/{deploymentId}")\r
  63   Response deleteByDeploymentId(\r
  64       @PathParam("deploymentId") String deploymentId,\r
  65       @HeaderParam("authorization") String authorization);\r
  66 }\r