docs: add missing @param

R/api.R

@@ -1,12 +1,3 @@
-bb_make_request <- function(resource) {
-  request("https://api.statistiken.bundesbank.de/rest") |>
-    req_user_agent("worldbank (https://m-muecke.github.io/worldbank)") |>
-    req_url_path_append(resource) |>
-    req_error(body = \(resp) resp_body_json(resp)$title) |>
-    req_perform() |>
-    resp_body_xml()
-}
-
 #' Returns data for a given flow and key
 #'
 #' @param flow character(1) flow to query
@@ -39,18 +30,9 @@ bb_data <- function(flow, key = NULL) {
   as_tibble(data)
 }
 
-bb_metadata <- function(resource, id = NULL) {
-  stopifnot(is.null(id) || is.character(id) && length(id) == 1)
-  # only supports xml return format
-  resource <- "metadata/datastructure/BBK"
-  if (!is.null(id)) {
-    resource <- paste(resource, toupper(id), sep = "/")
-  }
-  bb_make_request(resource)
-}
-
 #' Returns available data structures
 #'
+#' @param id character(1) id to query. Default `NULL`.
 #' @references <https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata>
 #' @family metadata
 #' @export
@@ -60,6 +42,7 @@ bb_data_structure <- function(id = NULL) {
 
 #' Returns available dataflows
 #'
+#' @param id character(1) id to query. Default `NULL`.
 #' @references <https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata>
 #' @family metadata
 #' @export
@@ -69,18 +52,39 @@ bb_dataflow <- function(id = NULL) {
 
 #' Returns available code lists
 #'
+#' @param id character(1) id to query. Default `NULL`.
 #' @references <https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata>
 #' @family metadata
 #' @export
 bb_codelist <- function(id = NULL) {
   bb_metadata("metadata/codelist/BBK", id)
 }
 
+#' Returns available concepts
 #'
-#'
+#' @param id character(1) id to query. Default `NULL`.
 #' @references <https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata>
 #' @family metadata
 #' @export
 bb_concept_scheme <- function(id = NULL) {
   bb_metadata("metadata/conceptscheme/BBK", id)
 }
+
+bb_metadata <- function(resource, id = NULL) {
+  stopifnot(is.null(id) || is.character(id) && length(id) == 1)
+  # only supports xml return format
+  resource <- "metadata/datastructure/BBK"
+  if (!is.null(id)) {
+    resource <- paste(resource, toupper(id), sep = "/")
+  }
+  bb_make_request(resource)
+}
+
+bb_make_request <- function(resource) {
+  request("https://api.statistiken.bundesbank.de/rest") |>
+    req_user_agent("worldbank (https://m-muecke.github.io/worldbank)") |>
+    req_url_path_append(resource) |>
+    req_error(body = \(resp) resp_body_json(resp)$title) |>
+    req_perform() |>
+    resp_body_xml()
+}