diff options
Diffstat (limited to 'man/cepis_health.Rd')
| -rw-r--r-- | man/cepis_health.Rd | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/man/cepis_health.Rd b/man/cepis_health.Rd new file mode 100644 index 0000000..dc00d8b --- /dev/null +++ b/man/cepis_health.Rd @@ -0,0 +1,23 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/models.R +\name{cepis_health} +\alias{cepis_health} +\title{The answer of \code{GET /health}} +\description{ +A plain list of class \code{cepis_health}, returned by \code{\link[=cep_health]{cep_health()}}. Good for +two things: checking that the API answers, and knowing \strong{which version of +the database} is live. The DNE database changes every two weeks; \code{dne} +identifies it. +} +\section{Fields}{ + +\describe{ +\item{\code{status}}{\code{"ok"} when the API reports itself healthy.} +\item{\code{ok}}{\code{status == "ok"}. Derived, not sent by the API.} +\item{\code{dne}}{identifier of the fortnightly database.} +\item{\code{ceps}}{how many CEPs it holds.} +\item{\code{geo}}{how many of those carry a coordinate.} +\item{\code{base_gerada_em}}{when the base was generated, UTC.} +} +} + |