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.*;
  19 import org.springframework.validation.annotation.Validated;
  20
  21 import javax.validation.constraints.NotNull;
  22 import javax.ws.rs.*;
  23 import javax.ws.rs.core.MediaType;
  24 import javax.ws.rs.core.Response;
  25
  26 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  27 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  28
  29 @Path("/v1.0/unique-types")
  30 @Produces(MediaType.APPLICATION_JSON)
  31 @Consumes(MediaType.APPLICATION_JSON)
  32 @Api(value = "Unique Types")
  33 @Validated
  34 public interface UniqueTypes {
  35
  36   @GET
  37   @Path("/")
  38   @ApiOperation(value = "Lists unique value types")
  39   Response listUniqueTypes(@NotNull(message = USER_MISSING_ERROR_MSG)
  40                            @HeaderParam(USER_ID_HEADER_PARAM) String user);
  41
  42   @GET
  43   @Path("/{type}/values/{value}")
  44   @ApiOperation(value = "Gets unique value")
  45   @ApiResponses(value = {
  46       @ApiResponse(code = 200, message = "Indication whether the unique value is occupied"),
  47       @ApiResponse(code = 404, message = "Unsupported unique type")})
  48   Response getUniqueValue(
  49       @ApiParam("The unique value type, for example: 'VlmName'") @PathParam("type") String type,
  50       @ApiParam("The unique value") @PathParam("value") String value,
  51       @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
  52 }