openecomp-be/api/openecomp-sdc-rest-webapp/unique-type-rest/unique-type-rest-services/src/main/java/org/openecomp/sdcrests/uniquevalue/rest/UniqueTypes.java

   1 /*
   2  * Copyright © 2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.openecomp.sdcrests.uniquevalue.rest;
  17
  18 import io.swagger.annotations.Api;
  19 import io.swagger.annotations.ApiOperation;
  20 import io.swagger.annotations.ApiParam;
  21 import io.swagger.annotations.ApiResponse;
  22 import io.swagger.annotations.ApiResponses;
  23 import org.springframework.validation.annotation.Validated;
  24
  25 import javax.validation.constraints.NotNull;
  26 import javax.ws.rs.Consumes;
  27 import javax.ws.rs.GET;
  28 import javax.ws.rs.HeaderParam;
  29 import javax.ws.rs.Path;
  30 import javax.ws.rs.PathParam;
  31 import javax.ws.rs.Produces;
  32 import javax.ws.rs.core.MediaType;
  33 import javax.ws.rs.core.Response;
  34
  35 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  36 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  37
  38 @Path("/v1.0/unique-types")
  39 @Produces(MediaType.APPLICATION_JSON)
  40 @Consumes(MediaType.APPLICATION_JSON)
  41 @Api(value = "Unique Types")
  42 @Validated
  43 public interface UniqueTypes {
  44
  45   @GET
  46   @Path("/")
  47   @ApiOperation(value = "Lists unique value types")
  48   Response listUniqueTypes(@NotNull(message = USER_MISSING_ERROR_MSG)
  49                            @HeaderParam(USER_ID_HEADER_PARAM) String user);
  50
  51   @GET
  52   @Path("/{type}/values/{value}")
  53   @ApiOperation(value = "Gets unique value")
  54   @ApiResponses(value = {
  55       @ApiResponse(code = 200, message = "Indication whether the unique value is occupied"),
  56       @ApiResponse(code = 404, message = "Unsupported unique type")})
  57   Response getUniqueValue(
  58       @ApiParam("The unique value type, for example: 'VlmName'") @PathParam("type") String type,
  59       @ApiParam("The unique value") @PathParam("value") String value,
  60       @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
  61 }