R/get_deims_api_version.R

Defines functions get_deims_API_version

Documented in get_deims_API_version

#' Get version of DEIMS-SDR API
#' @description `r lifecycle::badge("stable")`
#' This function obtains the version of the DEIMS-SDR API.
#' @param deims_url A `character`. DEIMS-SDR base URL. Defaults to package
#' settings.
#' @return version number.
#' @importFrom httr RETRY content
#' @importFrom dplyr as_tibble pull
#' @export
get_deims_API_version <- function(deims_url = get_deims_base_url()) {
  api_url <- paste0(deims_url, "api")
  q <- "{version: .info.version}"
  export <- httr::RETRY("GET", url = api_url)
  jj <- suppressMessages(httr::content(export, "text", encoding = "UTF-8"))

  apiversion <- do_Q(q, jj) %>% dplyr::as_tibble() %>% dplyr::pull(version)

  return(apiversion)
}
oggioniale/ReLTER documentation built on Jan. 4, 2024, 3:48 p.m.