diff options
author | micdzied <michal.1.dziedzic@nokia.com> | 2018-05-07 08:42:44 +0200 |
---|---|---|
committer | micdzied <michal.1.dziedzic@nokia.com> | 2018-05-07 12:43:40 +0200 |
commit | 7e7aa0c165665f74b628ba5c95fb3cdae72f4449 (patch) | |
tree | 737fe8068a44e7e297c305af1ff699b1f53a7c5e /prh-app-server/src/main/java/org/onap/dcaegen2/services/prh/controllers/HeartbeatController.java | |
parent | ee36c363b3c90055d9b10059775a9d54a76f767a (diff) |
creating swagger documentation
Change-Id: I8ca3faf2e6afb7add2785add2ac9096ded98f591
Issue-ID: DCAEGEN2-468
Signed-off-by: micdzied <michal.1.dziedzic@nokia.com>
Diffstat (limited to 'prh-app-server/src/main/java/org/onap/dcaegen2/services/prh/controllers/HeartbeatController.java')
-rw-r--r-- | prh-app-server/src/main/java/org/onap/dcaegen2/services/prh/controllers/HeartbeatController.java | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/prh-app-server/src/main/java/org/onap/dcaegen2/services/prh/controllers/HeartbeatController.java b/prh-app-server/src/main/java/org/onap/dcaegen2/services/prh/controllers/HeartbeatController.java index b91b56c5..05b91840 100644 --- a/prh-app-server/src/main/java/org/onap/dcaegen2/services/prh/controllers/HeartbeatController.java +++ b/prh-app-server/src/main/java/org/onap/dcaegen2/services/prh/controllers/HeartbeatController.java @@ -19,6 +19,10 @@ */ package org.onap.dcaegen2.services.prh.controllers; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiResponse; +import io.swagger.annotations.ApiResponses; import java.time.LocalDateTime; import java.time.format.DateTimeFormatter; @@ -36,12 +40,21 @@ import reactor.core.publisher.Mono; * @author <a href="mailto:przemyslaw.wasala@nokia.com">Przemysław Wąsala</a> on 4/19/18 */ @RestController +@Api(value = "HeartbeatController", description = "Check liveness of PRH service") public class HeartbeatController { private static final Logger logger = LoggerFactory.getLogger(PrhAppConfig.class); private static final DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("HH:mm:ss"); @RequestMapping(value = "heartbeat", method = RequestMethod.GET) + @ApiOperation(value = "Returns liveness of PRH service") + @ApiResponses(value = { + @ApiResponse(code = 200, message = "PRH sevice is living"), + @ApiResponse(code = 401, message = "You are not authorized to view the resource"), + @ApiResponse(code = 403, message = "Accessing the resource you were trying to reach is forbidden"), + @ApiResponse(code = 404, message = "The resource you were trying to reach is not found") + } + ) public Mono<ResponseEntity<String>> heartbeat() { logger.debug("Receiving request on on thread={} , time={} ", Thread.currentThread().getName(), dateTimeFormatter.format( |