io.blockfrost.sdk.impl.retrofit.HealthApi Maven / Gradle / Ivy
package io.blockfrost.sdk.impl.retrofit;
import io.blockfrost.sdk.api.model.Clock;
import io.blockfrost.sdk.api.model.Health;
import okhttp3.ResponseBody;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Header;
public interface HealthApi {
/**
* Current backend time
* This endpoint provides the current UNIX time. Your application might use this to verify if the client clock is not out of sync.
*
* @return Call<Clock>
*/
@GET("health/clock")
Call healthClockGet(@Header("project_id") String projectId);
/**
* Backend health status
* Return backend status as a boolean. Your application should handle situations when backend for the given chain is unavailable.
*
* @return Call<Health>
*/
@GET("health")
Call healthGet(@Header("project_id") String projectId);
/**
* Root endpoint
* Root endpoint has no other function than to point end users to documentation.
*
* @return Call<ApiRoot>
*/
@GET("/")
Call rootGet(@Header("project_id") String projectId);
}