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