Package gov.nasa.pds.api.base

Interface HealthcheckApi

All Known Implementing Classes:

HealthcheckApiController

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2024-09-03T18:10:48.512595446Z[GMT]")
@Validated
public interface HealthcheckApi

Method Summary

Modifier and Type	Method	Description
default Optional<org.springframework.web.context.request.NativeWebRequest>	getRequest()
default org.springframework.http.ResponseEntity<Map<String,Object>>	healthcheck()	GET /healthcheck : returns payload of system health information.

Method Details

getRequest

default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()

healthcheck

@RequestMapping(method=GET,
                value="/healthcheck",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Map<String,Object>> healthcheck()
                                                                         throws Exception

GET /healthcheck : returns payload of system health information. Detection of any fatal issues results in a non-200 response. The primary intention of this endpoint is to provide an accurate assessment of the service to determine if ECS/Fargate should instantiate a new instance of the task.

Returns:

The system checked out as healthy, returning a JSON payload of results (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or The system did not check out as healthy, returning a JSON payload of results, including error messages indicating the source(s) of the failure(s) (status code 418) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception