Merge pull request #28 from ScotGovAnalysis/dev-9007

Final tweaks before release

Author: alice-hannah

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: objr
 Title: Wrapper for Objective APIs
-Version: 0.0.0.9006
+Version: 0.0.0.9007
 Authors@R: c(
     person("Scottish Government", , , "statistics.enquiries@gov.scot", role = "cph"),
     person("Alice", "Hannah", , "alice.hannah@gov.scot", role = c("aut", "cre"))

NAMESPACE

@@ -1,7 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
 export(add_participants)
-export(allow_bypass_2fa)
 export(asset_info)
 export(assets)
 export(comments)
@@ -22,6 +21,7 @@ export(rollback_to_version)
 export(upload_file)
 export(upload_file_version)
 export(versions)
+export(workgroup_bypass_2fa)
 export(workspaces)
 export(write_data)
 export(write_data_version)

R/assets.R

@@ -1,12 +1,18 @@
 #' Get data frame of assets in workspace
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/getAssets}{API documentation}.
+# nolint end
+#'
 #' @param workspace_uuid UUID of workspace
 #' @param type List of asset types to return. Defaults to all types;
 #' document, folder and link.
 #' @inheritParams objr
 #' @inheritParams workspaces
 #'
-#' @return Tibble
+#' @return A tibble
 #'
 #' @export
 
@@ -37,10 +43,16 @@ assets <- function(workspace_uuid,
 
 #' Get asset information
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/getAssetByUuid}{API documentation}.
+# nolint end
+#'
 #' @param asset_uuid UUID of asset
 #' @inheritParams objr
 #'
-#' @return Tibble
+#' @return A tibble
 #'
 #' @export
 
@@ -62,11 +74,18 @@ asset_info <- function(asset_uuid,
 
 #' Delete an asset
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/deleteAsset}{API documentation}.
+# nolint end
+#'
+#' Note: This functionality is disabled in Scottish Government workspaces.
+#'
 #' @param asset_uuid UUID of asset
 #' @inheritParams objr
 #'
-#' @details Note: Note: This functionality is disabled in Scottish Government
-#' workspaces.
+#' @return API response (invisibly)
 #'
 #' @export
 
@@ -92,10 +111,18 @@ delete_asset <- function(asset_uuid,
 
 #' Rename an asset
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/updateAssetName}{API documentation}.
+# nolint end
+#'
 #' @param asset_uuid UUID of asset
 #' @param new_name Character. New name to give asset.
 #' @inheritParams objr
 #'
+#' @return API response (invisibly)
+#'
 #' @export
 
 rename_asset <- function(asset_uuid,

R/bypass_2fa.R

@@ -1,18 +1,26 @@
 #' Allow/disallow bypassing of two-factor authentication for workgroup
 #'
-#' @description More information on two-factor authentication can be found in
+#' @details
+#' More information on two-factor authentication can be found in
 #' `vignette("two-factor")`.
 #'
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Workgroups/setWorkgroupMfaBypassAllowed}{API documentation}.
+# nolint end
+#'
 #' @param workgroup_uuid Workgroup UUID
 #' @param allow_bypass Logical to indicate whether the workgroup should allow
 #' selected participants to bypass two-factor authentication verification.
 #' @inheritParams objr
 #'
+#' @return API response (invisibly)
+#'
 #' @export
 
-allow_bypass_2fa <- function(workgroup_uuid,
-                             allow_bypass = TRUE,
-                             use_proxy = FALSE) {
+workgroup_bypass_2fa <- function(workgroup_uuid,
+                                 allow_bypass = TRUE,
+                                 use_proxy = FALSE) {
 
   response <- objr(
     endpoint = "workgroups",
@@ -36,16 +44,25 @@ allow_bypass_2fa <- function(workgroup_uuid,
 #' Allow/disallow bypassing of two-factor authentication for workspace
 #' participant
 #'
-#' @description Note that this setting can only be updated by a workspace owner.
+#' @details
+#' This setting can only be updated by a workspace owner.
+#'
 #' More information on two-factor authentication can be found in
 #' `vignette("two-factor")`.
 #'
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Participants/setParticipantBypassMfa}{API documentation}.
+# nolint end
+#'
 #' @param participant_uuid Participant UUID (note that this is different to the
 #' user UUID)
 #' @param allow_bypass Logical to indicate whether the participant should be
 #' able to bypass two-factor authentication for workspace.
 #' @inheritParams objr
 #'
+#' @return API response (invisibly)
+#'
 #' @export
 
 participant_bypass_2fa <- function(participant_uuid,

R/comments.R

@@ -1,5 +1,11 @@
 #' Get comments for workspaces of current user
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Comments/getComments}{API documentation}.
+# nolint end
+#'
 #' @param created_after Date (and optionally time) to filter comments created
 #' since this date/time. If a time is not supplied, all comments made on this
 #' day will be included.
@@ -8,7 +14,7 @@
 #' @inheritParams objr
 #' @inheritParams workspaces
 #'
-#' @return Data frame
+#' @return A tibble
 #'
 #' @examples
 #' \dontrun{
@@ -58,6 +64,12 @@ comments <- function(created_after = NULL,
 
 #' Create a new thread
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Comments/createThread}{API documentation}.
+# nolint end
+#'
 #' @param workspace_uuid UUID of workspace
 #' @param text Character string to include in body of thread
 #' @param mentioned_assets UUID(s) of asset(s) to mention
@@ -97,6 +109,12 @@ new_thread <- function(workspace_uuid,
 
 #' Create a new reply to a thread
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Comments/createReply}{API documentation}.
+# nolint end
+#'
 #' @param thread_uuid UUID of thread to reply to
 #' @inheritParams new_thread
 #' @inheritParams objr

R/create_folder.R

@@ -1,5 +1,11 @@
 #' Create a new folder
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/createFolder}{API documentation}.
+# nolint end
+#'
 #' @param folder_name Name to give new folder
 #' @param workspace_uuid UUID of the workspace to create the new folder in
 #' @param description Optional description of folder
@@ -8,6 +14,8 @@
 #' of the workspace.
 #' @inheritParams objr
 #'
+#' @return API response (invisibly)
+#'
 #' @export
 
 create_folder <- function(folder_name,

R/documents.R

@@ -1,10 +1,16 @@
 #' Get data frame of document versions
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/getVersionsByDocumentUuid}{API documentation}.
+# nolint end
+#'
 #' @param document_uuid UUID of document (asset)
 #' @inheritParams objr
 #' @inheritParams workspaces
 #'
-#' @return Data frame
+#' @return A tibble
 #'
 #' @export
 
@@ -45,10 +51,18 @@ versions <- function(document_uuid,
 
 #' Rollback a document to a previous version
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/rollbackDocument}{API documentation}.
+# nolint end
+#'
 #' @param document_uuid UUID of document (asset)
 #' @param version_uuid UUID of version to rollback to
 #' @inheritParams objr
 #'
+#' @return API response (invisibly)
+#'
 #' @export
 
 rollback_to_version <- function(document_uuid,

R/download.R

@@ -57,13 +57,21 @@ download_helper <- function(document_uuid,
 #' * Use `download_file_version()` with a document version UUID for a specific
 #'   version of a document.
 #'
+#' @details
+#' More details on the endpoints used by these functions are available in the
+#' API documentation:
+# nolint start: line_length_linter
+#' * \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/download}{`download_file`}
+#' * \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/downloadVersion}{`download_file_version`}
+# nolint end
+#'
 #' @param document_uuid UUID of asset or document version
 #' @param folder Folder to save downloaded file to
 #' @param overwrite Logical to indicate whether file should be overwritten if
 #' already exists. Defaults to `FALSE`.
 #' @inheritParams objr
 #'
-#' @return An httr2 [httr2::response()][response] (invisibly)
+#' @return API response (invisibly)
 #'
 #' @export
 
@@ -107,11 +115,8 @@ download_file_version <- function(document_uuid,
 #' * Use `read_data_version()` with a document version UUID for a specific
 #'   version of a document.
 #'
-#' @param document_uuid UUID of asset or document version
-#' @param ... Additional arguments passed to read function. See details.
-#' @inheritParams objr
-#'
-#' @details This function can be used to read the following data file types:
+#' @details
+#' This function can be used to read the following data file types:
 #' csv, rds, xlsx.
 #'
 #' The function works by downloading the file from Objective Connect to a
@@ -132,7 +137,18 @@ download_file_version <- function(document_uuid,
 #' function, please \href{https://github.com/ScotGovAnalysis/objr/issues/new}{open an issue on the GitHub repository}.
 # nolint end
 #'
-#' @return For csv and xlsx files, a data frame. For rds files, an R object.
+#' More details on the endpoints used by these functions are available in the
+#' API documentation:
+# nolint start: line_length_linter
+#' * \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/download}{`read_data`}
+#' * \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Assets/downloadVersion}{`read_data_version`}
+# nolint end
+#'
+#' @param document_uuid UUID of asset or document version
+#' @param ... Additional arguments passed to read function. See details.
+#' @inheritParams objr
+#'
+#' @return Format depends on file type. See details.
 #'
 #' @export
 

R/my_user_id.R

@@ -1,5 +1,11 @@
 #' Get user ID for current authenticated user
 #'
+#' @details
+#' More details on this endpoint are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/Users/getCurrentUser}{API documentation}.
+# nolint end
+#'
 #' @inheritParams objr
 #'
 #' @return A character value of the authenticated user's ID

R/objr.R

@@ -1,5 +1,11 @@
 #' Core request function
 #'
+#' @details
+#' More details on endpoints are available in the
+# nolint start: line_length_linter
+#' \href{https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/}{API documentation}.
+# nolint end
+#'
 #' @param endpoint The endpoint to append to the API server address
 #' @param url_path A list of values to be added to the request URL path.
 #' Values will be separated with `/`.
@@ -13,7 +19,7 @@
 #' @param content_type Content-Type header. Defaults to 'application/json'.
 #' @param use_proxy Logical to indicate whether to use proxy
 #'
-#' @return An httr2 [httr2::response()][response]
+#' @return API response
 #'
 #' @export