openecomp-be/api/openecomp-sdc-rest-webapp/healthcheck-rest/healthcheck-rest-services/src/main/java/org/openecomp/sdcrests/health/rest/HealthCheck.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdcrests.health.rest;
  22
  23 import io.swagger.v3.oas.annotations.Operation;
  24 import io.swagger.v3.oas.annotations.info.Info;
  25 import io.swagger.v3.oas.annotations.media.Content;
  26 import io.swagger.v3.oas.annotations.media.Schema;
  27 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  28 import io.swagger.v3.oas.annotations.tags.Tag;
  29 import io.swagger.v3.oas.annotations.tags.Tags;
  30 import org.openecomp.sdcrests.health.types.HealthInfoDtos;
  31 import org.springframework.validation.annotation.Validated;
  32
  33 import javax.ws.rs.Consumes;
  34 import javax.ws.rs.GET;
  35 import javax.ws.rs.Path;
  36 import javax.ws.rs.Produces;
  37 import javax.ws.rs.core.MediaType;
  38 import javax.ws.rs.core.Response;
  39
  40 @Path("/v1.0/healthcheck")
  41 @Produces(MediaType.APPLICATION_JSON)
  42 @Consumes(MediaType.APPLICATION_JSON)
  43 @Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Health Check")})
  44 @Validated
  45 public interface HealthCheck {
  46
  47   @GET
  48   @Operation(description = "Perform health check", responses = @ApiResponse(content = @Content(schema = @Schema(implementation = HealthInfoDtos.class))))
  49   Response checkHealth();
  50
  51 }