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.annotations.Api;
  24 import io.swagger.annotations.ApiOperation;
  25 import org.openecomp.sdcrests.health.types.HealthInfoDtos;
  26 import org.springframework.validation.annotation.Validated;
  27
  28 import javax.ws.rs.Consumes;
  29 import javax.ws.rs.GET;
  30 import javax.ws.rs.Path;
  31 import javax.ws.rs.Produces;
  32 import javax.ws.rs.core.MediaType;
  33 import javax.ws.rs.core.Response;
  34
  35 @Path("/v1.0/healthcheck")
  36 @Produces(MediaType.APPLICATION_JSON)
  37 @Consumes(MediaType.APPLICATION_JSON)
  38 @Api(value = "Health Check")
  39 @Validated
  40 public interface HealthCheck {
  41
  42   @GET
  43   @ApiOperation(value = "Perform health check",
  44       response = HealthInfoDtos.class,
  45       responseContainer = "List")
  46   Response checkHealth();
  47
  48 }