1 /* Copyright (c) 2019 AT&T Intellectual Property. #
\r
3 # Licensed under the Apache License, Version 2.0 (the "License"); #
\r
4 # you may not use this file except in compliance with the License. #
\r
5 # You may obtain a copy of the License at #
\r
7 # http://www.apache.org/licenses/LICENSE-2.0 #
\r
9 # Unless required by applicable law or agreed to in writing, software #
\r
10 # distributed under the License is distributed on an "AS IS" BASIS, #
\r
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
\r
12 # See the License for the specific language governing permissions and #
\r
13 # limitations under the License. #
\r
14 ##############################################################################*/
\r
17 package org.oran.otf.api.service;
\r
19 import org.oran.otf.common.model.local.OTFApiResponse;
\r
20 import io.swagger.annotations.Api;
\r
21 import io.swagger.v3.oas.annotations.Operation;
\r
22 import io.swagger.v3.oas.annotations.media.Content;
\r
23 import io.swagger.v3.oas.annotations.media.Schema;
\r
24 import io.swagger.v3.oas.annotations.responses.ApiResponse;
\r
25 import io.swagger.v3.oas.annotations.tags.Tag;
\r
27 import javax.ws.rs.GET;
\r
28 import javax.ws.rs.Path;
\r
29 import javax.ws.rs.Produces;
\r
30 import javax.ws.rs.core.MediaType;
\r
31 import javax.ws.rs.core.Response;
\r
35 @Tag(name = "Health Service", description = "Query the availability of the API")
\r
36 @Produces({MediaType.APPLICATION_JSON})
\r
37 public interface HealthService {
\r
41 @Produces({MediaType.APPLICATION_JSON})
\r
43 summary = "Checks if the test control unit is available",
\r
46 responseCode = "200",
\r
47 description = "The test control unit is available",
\r
50 mediaType = "application/json",
\r
51 schema = @Schema(implementation = OTFApiResponse.class)))
\r
53 Response getHealth();
\r