From 1bdc6625ebd1730e0a85fafd1db166913f4c58e3 Mon Sep 17 00:00:00 2001
From: Will Beasley <wibeasley@hotmail.com>
Date: Fri, 25 Oct 2024 12:40:36 -0500
Subject: [PATCH] doc for `redcap_file_repo_list_oneshot()`

ref #549
---
 NEWS.md                              | 4 ++++
 R/redcap-file-repo-list.R            | 4 ++--
 _pkgdown.yml                         | 6 ++++++
 man/redcap_file_repo_list_oneshot.Rd | 5 ++---
 4 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/NEWS.md b/NEWS.md
index 3f8a827c..6607b8a1 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -15,6 +15,10 @@ Version 1.4.x  (Not yet released on CRAN)
 
 These features are not yet on CRAN.  Install with `remotes::install_github("OuhscBbmc/REDCapR")`
 
+### New Features
+
+* `redcap_file_repo_list_oneshot()` export a list of files/folders from the file repository (requested by @agdamsbo, #549)
+
 Version 1.3.0  (released 2024-10-22)
 ==========================================================
 
diff --git a/R/redcap-file-repo-list.R b/R/redcap-file-repo-list.R
index 1b97353b..08551e7f 100644
--- a/R/redcap-file-repo-list.R
+++ b/R/redcap-file-repo-list.R
@@ -1,13 +1,13 @@
 #' @title
 #' Export a List of Files/Folders from the File Repository
-#'#'
+#'
 #' @description
 #' Allows you to export a list of all files and sub-folders from a specific
 #' folder in a project's File Repository.
 #' Each sub-folder will have an associated folder_id number,
 #' and each file will have an associated doc_id number.
 #'
-#' @param folder_id the `folder_id` of a specific folder in the
+#' @param folder_id the integer of a specific folder in the
 #' File Repository for which you wish to export a list of its
 #' files and sub-folders.
 #' If `NA` (the default),
diff --git a/_pkgdown.yml b/_pkgdown.yml
index f0ac4515..42267218 100644
--- a/_pkgdown.yml
+++ b/_pkgdown.yml
@@ -46,8 +46,14 @@ reference:
       - redcap_write_oneshot
       - redcap_delete
       - redcap_report
+
+  - title: "File API Operations"
+    desc: >
+      Manipulating files in the REDCap records and in the file repository.
+    contents:
       - redcap_file_download_oneshot
       - redcap_file_upload_oneshot
+      - redcap_file_repo_list_oneshot
 
   - title: "Additional API Methods"
     desc: >
diff --git a/man/redcap_file_repo_list_oneshot.Rd b/man/redcap_file_repo_list_oneshot.Rd
index 33a888fc..6e072e70 100644
--- a/man/redcap_file_repo_list_oneshot.Rd
+++ b/man/redcap_file_repo_list_oneshot.Rd
@@ -2,8 +2,7 @@
 % Please edit documentation in R/redcap-file-repo-list.R
 \name{redcap_file_repo_list_oneshot}
 \alias{redcap_file_repo_list_oneshot}
-\title{Export a List of Files/Folders from the File Repository
-#'}
+\title{Export a List of Files/Folders from the File Repository}
 \usage{
 redcap_file_repo_list_oneshot(
   redcap_uri,
@@ -24,7 +23,7 @@ Required.}
 \item{token}{The user-specific string that serves as the password for a
 project.  Required.}
 
-\item{folder_id}{the \code{folder_id} of a specific folder in the
+\item{folder_id}{the integer of a specific folder in the
 File Repository for which you wish to export a list of its
 files and sub-folders.
 If \code{NA} (the default),