otf-service-api/src/main/java/org/oran/otf/api/service/VirtualTestHeadService.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 org.oran.otf.common.model.TestHead;\r
  20 import org.oran.otf.common.model.local.OTFApiResponse;\r
  21 import io.swagger.annotations.Api;\r
  22 import io.swagger.v3.oas.annotations.Operation;\r
  23 import io.swagger.v3.oas.annotations.media.Content;\r
  24 import io.swagger.v3.oas.annotations.media.Schema;\r
  25 import io.swagger.v3.oas.annotations.responses.ApiResponse;\r
  26 import io.swagger.v3.oas.annotations.tags.Tag;\r
  27 \r
  28 import javax.ws.rs.*;\r
  29 import javax.ws.rs.core.HttpHeaders;\r
  30 import javax.ws.rs.core.MediaType;\r
  31 import javax.ws.rs.core.Response;\r
  32 \r
  33 \r
  34 @Api\r
  35 @Path("/virtualTestHead")\r
  36 @Tag(name = "Health Service", description = "Query the availability of the API")\r
  37 @Produces({MediaType.APPLICATION_JSON})\r
  38 public interface VirtualTestHeadService {\r
  39 \r
  40     @PATCH\r
  41     @Path("/v1/{testHeadName}")\r
  42     @Produces({MediaType.APPLICATION_JSON})\r
  43     @Operation(\r
  44             summary = "Used to update fields in the virtual test head",\r
  45             responses = {\r
  46                     @ApiResponse(\r
  47                             responseCode = "200",\r
  48                             description = "The response will include the new vth object",\r
  49                             content =\r
  50                             @Content(\r
  51                                     mediaType = "application/json",\r
  52                                     schema = @Schema(implementation = OTFApiResponse.class)))\r
  53             })\r
  54     Response updateVirtualTestHead(@HeaderParam(HttpHeaders.AUTHORIZATION) String authorization, @PathParam("testHeadName") String testHeadName, TestHead newTestHead);\r
  55 }\r