diff --git a/R/content.R b/R/content.R
index 0d2ec18d..0e3b2f64 100644
--- a/R/content.R
+++ b/R/content.R
@@ -140,7 +140,7 @@ Content <- R6::R6Class(
self$get_connect()$set_content_tag(self$get_content()$guid, tag_id = tag_id)
},
#' @description Remove a tag for this content.
- #' @param id The tag identifier.
+ #' @param tag_id The tag identifier.
tag_delete = function(tag_id) {
# note that deleting the parent tag deletes all children
self$get_connect()$remove_content_tag(self$get_content()$guid, tag_id = tag_id)
diff --git a/R/get.R b/R/get.R
index 9fab0c66..bd1b414c 100644
--- a/R/get.R
+++ b/R/get.R
@@ -10,28 +10,26 @@
#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{email}}{The user's email}
-#' \item{\strong{username}}{The user's username}
-#' \item{\strong{first_name}}{The user's first name}
-#' \item{\strong{last_name}}{The user's last name}
-#' \item{\strong{user_role}}{The user's role. It may have a value of
-#' administrator, publisher or viewer.}
-#' \item{\strong{created_time}}{The timestamp (in RFC3339 format) when the
-#' user was created in the Posit Connect server}
-#' \item{\strong{updated_time}}{The timestamp (in RFC3339 format) when the
-#' user was last updated in the Posit Connect server}
-#' \item{\strong{active_time}}{The timestamp (in RFC3339 format) when the
-#' user was last active on the Posit Connect server}
-#' \item{\strong{confirmed}}{When false, the created user must confirm their
-#' account through an email. This feature is unique to password
-#' authentication.}
-#' \item{\strong{locked}}{Whether or not the user is locked}
-#' \item{\strong{guid}}{The user's GUID, or unique identifier, in UUID RFC4122 format}
-#' }
+#'
+#' * `email`: The user's email
+#' * `username`: The user's username
+#' * `first_name`: The user's first name
+#' * `last_name`: The user's last name
+#' * `user_role`: The user's role. It may have a value of administrator,
+#' publisher or viewer.
+#' * `created_time`: The timestamp (in RFC3339 format) when the user was
+#' created in the Posit Connect server
+#' * `updated_time`: The timestamp (in RFC3339 format) when the user was last
+#' updated in the Posit Connect server
+#' * `active_time`: The timestamp (in RFC3339 format) when the user was last
+#' active on the Posit Connect server
+#' * `confirmed`: When false, the created user must confirm their account
+#' through an email. This feature is unique to password authentication.
+#' * `locked`: Whether or not the user is locked
+#' * `guid`: The user's GUID, or unique identifier, in UUID RFC4122 format
#'
#' @details
-#' Please see https://docs.posit.co/connect/api/#getUsers for more information
+#' Please see https://docs.posit.co/connect/api/#getUsers for more information.
#'
#' @examples
#' \dontrun{
@@ -67,16 +65,15 @@ get_users <- function(src, page_size = 20, prefix = NULL, limit = 25) {
#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{guid}}{The unique identifier of the group}
-#' \item{\strong{name}}{The group name}
-#' \item{\strong{owner_guid}}{The group owner's unique identifier.
-#' When using LDAP, or Proxied authentication with group provisioning
-#' enabled this property will always be null.}
-#' }
+#'
+#' * `guid`: The unique identifier of the group
+#' * `name`: The group name
+#' * `owner_guid`: The group owner's unique identifier. When using LDAP or
+#' Proxied authentication with group provisioning enabled this property
+#' will always be null.
#'
#' @details
-#' Please see https://docs.posit.co/connect/api/#getGroups for more information
+#' Please see https://docs.posit.co/connect/api/#getGroups for more information.
#'
#' @examples
#' \dontrun{
@@ -105,28 +102,28 @@ get_groups <- function(src, page_size = 20, prefix = NULL, limit = 25) {
#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{email}}{The user's email}
-#' \item{\strong{username}}{The user's username}
-#' \item{\strong{first_name}}{The user's first name}
-#' \item{\strong{last_name}}{The user's last name}
-#' \item{\strong{user_role}}{The user's role. It may have a value of
-#' administrator, publisher or viewer.}
-#' \item{\strong{created_time}}{The timestamp (in RFC3339 format) when the
-#' user was created in the Posit Connect server}
-#' \item{\strong{updated_time}}{The timestamp (in RFC3339 format) when the
-#' user was last updated in the Posit Connect server}
-#' \item{\strong{active_time}}{The timestamp (in RFC3339 format) when the
-#' user was last active on the Posit Connect server}
-#' \item{\strong{confirmed}}{When false, the created user must confirm their
-#' account through an email. This feature is unique to password
-#' authentication.}
-#' \item{\strong{locked}}{Whether or not the user is locked}
-#' \item{\strong{guid}}{The user's GUID, or unique identifier, in UUID RFC4122 format}
-#' }
+#'
+#' * `email`: The user's email
+#' * `username`: The user's username
+#' * `first_name`: The user's first name
+#' * `last_name`: The user's last name
+#' * `user_role`: The user's role. It may have a value of administrator,
+#' publisher or viewer.
+#' * `created_time`: The timestamp (in RFC3339 format) when the user
+#' was created in the Posit Connect server
+#' * `updated_time`: The timestamp (in RFC3339 format) when the user
+#' was last updated in the Posit Connect server
+#' * `active_time`: The timestamp (in RFC3339 format) when the user
+#' was last active on the Posit Connect server
+#' * `confirmed`: When false, the created user must confirm their
+#' account through an email. This feature is unique to password
+#' authentication.
+#' * `locked`: Whether or not the user is locked
+#' * `guid`: The user's GUID, or unique identifier, in UUID RFC4122 format
#'
#' @details
-#' Please see https://docs.posit.co/connect/api/#getGroupMembers for more information
+#' Please see https://docs.posit.co/connect/api/#getGroupMembers for more
+#' information.
#'
#' @examples
#' \dontrun{
@@ -163,104 +160,104 @@ get_group_members <- function(src, guid) {
#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{guid}}{The unique identifier of this content item.}
-#' \item{\strong{name}}{A simple, URL-friendly identifier. Allows
-#' alpha-numeric characters, hyphens ("-"), and underscores ("_").}
-#' \item{\strong{title}}{The title of this content.}
-#' \item{\strong{description}}{A rich description of this content}
-#' \item{\strong{access_type}}{Access type describes how this content manages
-#' its viewers. The value all is the most permissive; any visitor to Posit
-#' Connect will be able to view this content. The value logged_in indicates
-#' that all Posit Connect accounts may view the content. The acl value
-#' lets specifically enumerated users and groups view the content. Users
-#' configured as collaborators may always view content. It may have a
-#' value of all, logged_in or acl.}
-#' \item{\strong{connection_timeout}}{Maximum number of seconds allowed
-#' without data sent or received across a client connection. A value of 0
-#' means connections will never time-out (not recommended). When null, the
-#' default Scheduler.ConnectionTimeout is used. Applies only to content
-#' types that are executed on demand.}
-#' \item{\strong{read_timeout}}{Maximum number of seconds allowed without
-#' data received from a client connection. A value of 0 means a lack of client
-#' (browser) interaction never causes the connection to close. When null,
-#' the default Scheduler.ReadTimeout is used. Applies only to content types
-#' that are executed on demand.}
-#' \item{\strong{init_timeout}}{The maximum number of seconds allowed for an
-#' interactive application to start. Posit Connect must be able to connect
-#' to a newly launched Shiny application, for example, before this threshold
-#' has elapsed. When null, the default Scheduler.InitTimeout is used. Applies
-#' only to content types that are executed on demand.}
-#' \item{\strong{idle_timeout}}{The maximum number of seconds a worker process
-#' for an interactive application to remain alive after it goes idle (no
-#' active connections). When null, the default Scheduler.IdleTimeout is used.
-#' Applies only to content types that are executed on demand.}
-#' \item{\strong{max_processes}}{Specifies the total number of concurrent
-#' processes allowed for a single interactive application. When null, the
-#' default Scheduler.MaxProcesses is used. Applies only to content types
-#' that are executed on demand.}
-#' \item{\strong{min_processes}}{Specifies the minimum number of concurrent
-#' processes allowed for a single interactive application. When null, the
-#' default Scheduler.MinProcesses is used. Applies only to content types
-#' that are executed on demand.}
-#' \item{\strong{max_conns_per_process}}{Specifies the maximum number of
-#' client connections allowed to an individual process. Incoming connections
-#' which will exceed this limit are routed to a new process or rejected.
-#' When null, the default Scheduler.MaxConnsPerProcess is used. Applies
-#' only to content types that are executed on demand.}
-#' \item{\strong{load_factor}}{Controls how aggressively new processes are spawned.
-#' When null, the default Scheduler.LoadFactor is used. Applies only to
-#' content types that are executed on demand.}
-#' \item{\strong{created_time}}{The timestamp (RFC3339) indicating when this
-#' content was created.}
-#' \item{\strong{last_deployed_time}}{The timestamp (RFC3339) indicating when
-#' this content last had a successful bundle deployment performed.}
-#' \item{\strong{bundle_id}}{The identifier for the active deployment bundle.
-#' Automatically assigned upon the successful deployment of that bundle.}
-#' \item{\strong{app_mode}}{The runtime model for this content. Has a value
-#' of unknown before data is deployed to this item. Automatically assigned
-#' upon the first successful bundle deployment. Allowed: api, jupyter-static,
-#' python-api, python-bokeh, python-dash, python-streamlit, rmd-shiny,
-#' rmd-static, shiny, static, tensorflow-saved-model, unknown}
-#' \item{\strong{content_category}}{Describes the specialization of the content
-#' runtime model. Automatically assigned upon the first successful bundle
-#' deployment.}
-#' \item{\strong{parameterized}}{True when R Markdown rendered content
-#' allows parameter configuration. Automatically assigned upon the first
-#' successful bundle deployment. Applies only to content with an app_mode
-#' of rmd-static.}
-#' \item{\strong{r_version}}{The version of the R interpreter associated
-#' with this content. The value null represents that an R interpreter is
-#' not used by this content or that the R package environment has not been
-#' successfully restored. Automatically assigned upon the successful
-#' deployment of a bundle.}
-#' \item{\strong{py_version}}{The version of the Python interpreter
-#' associated with this content. The value null represents that a Python
-#' interpreter is not used by this content or that the Python package
-#' environment has not been successfully restored. Automatically assigned
-#' upon the successful deployment of a bundle.}
-#' \item{\strong{run_as}}{The UNIX user that executes this content.
-#' When null, the default Applications.RunAs is used. Applies
-#' only to executable content types - not static.}
-#' \item{\strong{run_as_current_user}}{Indicates if this content is allowed
-#' to execute as the logged-in user when using PAM authentication.
-#' Applies only to executable content types - not static.}
-#' \item{\strong{owner_guid}}{The unique identifier for the owner}
-#' \item{\strong{content_url}}{The URL associated with this content. Computed
-#' from the associated vanity URL or GUID for this content.}
-#' \item{\strong{dashboard_url}}{The URL within the Connect dashboard where
-#' this content can be configured. Computed from the GUID for this content.}
-#' \item{\strong{role}}{The relationship of the accessing user to this
-#' content. A value of owner is returned for the content owner. editor
-#' indicates a collaborator. The viewer value is given to users who are
-#' permitted to view the content. A none role is returned for
-#' administrators who cannot view the content but are permitted to view
-#' its configuration. Computed at the time of the request.}
-#' \item{\strong{id}}{The internal numeric identifier of this content item}
-#' }
+#' * `guid`: The unique identifier of this content item.
+#' * `name`: A simple, URL-friendly identifier. Allows alpha-numeric
+#' characters, hyphens ("-"), and underscores ("_").
+#' * `title`: The title of this content.
+#' * `description`: A rich description of this content
+#' * `access_type`: Access type describes how this content manages its
+#' viewers. It may have a value of `all`, `logged_in` or `acl`.
+#' The value `all` is the most permissive; any visitor to Posit
+#' Connect will be able to view this content. The value `logged_in`
+#' indicates that all Posit Connect accounts may view the content. The
+#' `acl` value lets specifically enumerated users and groups view the
+#' content. Users configured as collaborators may always view content.
+#' * `connection_timeout`: Maximum number of seconds allowed without data
+#' sent or received across a client connection. A value of 0 means
+#' connections will never time-out (not recommended). When null, the
+#' default `Scheduler.ConnectionTimeout` is used. Applies only to content
+#' types that are executed on demand.
+#' * `read_timeout`: Maximum number of seconds allowed without data received
+#' from a client connection. A value of 0 means a lack of client (browser)
+#' interaction never causes the connection to close. When null, the default
+#' `Scheduler.ReadTimeout` is used. Applies only to content types that are
+#' executed on demand.
+#' * `init_timeout`: The maximum number of seconds allowed for an interactive
+#' application to start. Posit Connect must be able to connect
+#' to a newly launched Shiny application, for example, before this threshold
+#' has elapsed. When null, the default `Scheduler.InitTimeout` is
+#' used. Applies only to content types that are executed on demand.
+#' * `idle_timeout`: The maximum number of seconds a worker process
+#' for an interactive application to remain alive after it goes idle (no
+#' active connections). When null, the default `Scheduler.IdleTimeout`
+#' is used. Applies only to content types that are executed on demand.
+#' * `max_processes`: Specifies the total number of concurrent processes
+#' allowed for a single interactive application. When null, the
+#' default `Scheduler.MaxProcesses` setting is used. Applies only to
+#' content types that are executed on demand.
+#' * `min_processes`: Specifies the minimum number of concurrent
+#' processes allowed for a single interactive application. When null, the
+#' default `Scheduler.MinProcesses` is used. Applies only to content types
+#' that are executed on demand.
+#' * `max_conns_per_process`: Specifies the maximum number of
+#' client connections allowed to an individual process. Incoming connections
+#' which will exceed this limit are routed to a new process or rejected.
+#' When null, the default `Scheduler.MaxConnsPerProcess` is used. Applies
+#' only to content types that are executed on demand.
+#' * `load_factor`: Controls how aggressively new processes are spawned.
+#' When null, the default `Scheduler.LoadFactor` is used. Applies only to
+#' content types that are executed on demand.
+#' * `created_time`: The timestamp (RFC3339) indicating when this
+#' content was created.
+#' * `last_deployed_time`: The timestamp (RFC3339) indicating when
+#' this content last had a successful bundle deployment performed.
+#' * `bundle_id`: The identifier for the active deployment bundle.
+#' Automatically assigned upon the successful deployment of that bundle.
+#' * `app_mode`: The runtime model for this content. Has a value
+#' of `unknown` before data is deployed to this item. Automatically assigned
+#' upon the first successful bundle deployment. Allowed: `api`,
+#' `jupyter-static`, `python-api`, `python-bokeh`, `python-dash`,
+#' `python-streamlit`, `rmd-shiny`, `rmd-static`, `shiny`, `static`,
+#' `tensorflow-saved-model`, `unknown`.
+#' * `content_category`: Describes the specialization of the content
+#' runtime model. Automatically assigned upon the first successful bundle
+#' deployment.
+#' * `parameterized`: True when R Markdown rendered content
+#' allows parameter configuration. Automatically assigned upon the first
+#' successful bundle deployment. Applies only to content with an app_mode
+#' of rmd-static.
+#' * `r_version`: The version of the R interpreter associated
+#' with this content. The value null represents that an R interpreter is
+#' not used by this content or that the R package environment has not been
+#' successfully restored. Automatically assigned upon the successful
+#' deployment of a bundle.
+#' * `py_version`: The version of the Python interpreter
+#' associated with this content. The value null represents that a Python
+#' interpreter is not used by this content or that the Python package
+#' environment has not been successfully restored. Automatically assigned
+#' upon the successful deployment of a bundle.
+#' * `run_as`: The UNIX user that executes this content.
+#' When null, the default Applications.RunAs is used. Applies
+#' only to executable content types - not static.
+#' * `run_as_current_user`: Indicates if this content is allowed
+#' to execute as the logged-in user when using PAM authentication.
+#' Applies only to executable content types - not static.
+#' * `owner_guid`: The unique identifier for the owner
+#' * `content_url`: The URL associated with this content. Computed
+#' from the associated vanity URL or GUID for this content.
+#' * `dashboard_url`: The URL within the Connect dashboard where
+#' this content can be configured. Computed from the GUID for this content.
+#' * `role`: The relationship of the accessing user to this
+#' content. A value of owner is returned for the content owner. editor
+#' indicates a collaborator. The viewer value is given to users who are
+#' permitted to view the content. A none role is returned for
+#' administrators who cannot view the content but are permitted to view
+#' its configuration. Computed at the time of the request.
+#' * `id`: The internal numeric identifier of this content item
#'
#' @details
-#' Please see https://docs.posit.co/connect/api/#get-/v1/content for more information
+#' Please see https://docs.posit.co/connect/api/#get-/v1/content for more
+#' information.
#'
#' @examples
#' \dontrun{
@@ -391,113 +388,113 @@ content_list_guid_has_access <- function(content_list, guid) {
#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{id}}{The application ID}
-#' \item{\strong{guid}}{The unique identifier of this content item.}
-#' \item{\strong{access_type}}{Access type describes how this content manages
-#' its viewers. The value all is the most permissive; any visitor to Posit
-#' Connect will be able to view this content. The value logged_in indicates
-#' that all Posit Connect accounts may view the content. The acl value
-#' lets specifically enumerated users and groups view the content. Users
-#' configured as collaborators may always view content. It may have a
-#' value of all, logged_in or acl.}
-#' \item{\strong{connection_timeout}}{Maximum number of seconds allowed
-#' without data sent or received across a client connection. A value of 0
-#' means connections will never time-out (not recommended). When null, the
-#' default Scheduler.ConnectionTimeout is used. Applies only to content
-#' types that are executed on demand.}
-#' \item{\strong{read_timeout}}{Maximum number of seconds allowed without
-#' data received from a client connection. A value of 0 means a lack of client
-#' (browser) interaction never causes the connection to close. When null,
-#' the default Scheduler.ReadTimeout is used. Applies only to content types
-#' that are executed on demand.}
-#' \item{\strong{init_timeout}}{The maximum number of seconds allowed for an
-#' interactive application to start. Posit Connect must be able to connect
-#' to a newly launched Shiny application, for example, before this threshold
-#' has elapsed. When null, the default Scheduler.InitTimeout is used. Applies
-#' only to content types that are executed on demand.}
-#' \item{\strong{idle_timeout}}{The maximum number of seconds a worker process
-#' for an interactive application to remain alive after it goes idle (no
-#' active connections). When null, the default Scheduler.IdleTimeout is used.
-#' Applies only to content types that are executed on demand.}
-#' \item{\strong{max_processes}}{Specifies the total number of concurrent
-#' processes allowed for a single interactive application. When null, the
-#' default Scheduler.MaxProcesses is used. Applies only to content types
-#' that are executed on demand.}
-#' \item{\strong{min_processes}}{Specifies the minimum number of concurrent
-#' processes allowed for a single interactive application. When null, the
-#' default Scheduler.MinProcesses is used. Applies only to content types
-#' that are executed on demand.}
-#' \item{\strong{max_conns_per_process}}{Specifies the maximum number of
-#' client connections allowed to an individual process. Incoming connections
-#' which will exceed this limit are routed to a new process or rejected.
-#' When null, the default Scheduler.MaxConnsPerProcess is used. Applies
-#' only to content types that are executed on demand.}
-#' \item{\strong{load_factor}}{Controls how aggressively new processes are spawned.
-#' When null, the default Scheduler.LoadFactor is used. Applies only to
-#' content types that are executed on demand.}
-#' \item{\strong{url}}{The URL associated with this content. Computed from
-#' the associated vanity URL or the identifiers for this content.}
-#' \item{\strong{vanity_url}}{The vanity url assigned to this app by an
-#' administrator}
-#' \item{\strong{name}}{A simple, URL-friendly identifier. Allows
-#' alpha-numeric characters, hyphens ("-"), and underscores ("_").}
-#' \item{\strong{title}}{The title of this content.}
-#' \item{\strong{bundle_id}}{The identifier for the active deployment bundle.
-#' Automatically assigned upon the successful deployment of that bundle.}
-#' \item{\strong{app_mode}}{The runtime model for this content. Has a value
-#' of unknown before data is deployed to this item. Automatically assigned
-#' upon the first successful bundle deployment.}
-#' \item{\strong{content_category}}{Describes the specialization of the content
-#' runtime model. Automatically assigned upon the first successful bundle
-#' deployment.}
-#' \item{\strong{has_parameters}}{True when R Markdown rendered content
-#' allows parameter configuration. Automatically assigned upon the first
-#' successful bundle deployment. Applies only to content with an app_mode
-#' of rmd-static.}
-#' \item{\strong{created_time}}{The timestamp (RFC3339) indicating when this
-#' content was created.}
-#' \item{\strong{last_deployed_time}}{The timestamp (RFC3339) indicating when
-#' this content last had a successful bundle deployment performed.}
-#' \item{\strong{r_version}}{The version of the R interpreter associated
-#' with this content. The value null represents that an R interpreter is
-#' not used by this content or that the R package environment has not been
-#' successfully restored. Automatically assigned upon the successful
-#' deployment of a bundle.}
-#' \item{\strong{py_version}}{The version of the Python interpreter
-#' associated with this content. The value null represents that a Python
-#' interpreter is not used by this content or that the Python package
-#' environment has not been successfully restored. Automatically assigned
-#' upon the successful deployment of a bundle.}
-#' \item{\strong{build_status}}{}
-#' \item{\strong{run_as}}{The UNIX user that executes this content.
-#' When null, the default Applications.RunAs is used. Applies
-#' only to executable content types - not static.}
-#' \item{\strong{run_as_current_user}}{Indicates if this content is allowed
-#' to execute as the logged-in user when using PAM authentication.
-#' Applies only to executable content types - not static.}
-#' \item{\strong{description}}{A rich description of this content}
-#' \item{\strong{app_role}}{The relationship of the accessing user to this
-#' content. A value of owner is returned for the content owner. editor
-#' indicates a collaborator. The viewer value is given to users who are
-#' permitted to view the content. A none role is returned for
-#' administrators who cannot view the content but are permitted to view
-#' its configuration. Computed at the time of the request.}
-#' \item{\strong{owner_first_name}}{The first name of the owner of the
-#' content.}
-#' \item{\strong{owner_last_name}}{The last name of the owner of the
-#' content.}
-#' \item{\strong{owner_username}}{The username of the owner of the
-#' content.}
-#' \item{\strong{owner_guid}}{The unique identifier for the owner}
-#' \item{\strong{owner_email}}{The email of the content owner}
-#' \item{\strong{owner_locked}}{Is the owners user account locked?}
-#' \item{\strong{is_scheduled}}{Is this content scheduled?}
-#' \item{\strong{git}}{Is this content deployed via git or GitHub?}
-#' }
+#'
+#' * `id`: The application ID
+#' * `guid`: The unique identifier of this content item.
+#' * `access_type`: Access type describes how this content manages its
+#' viewers. It may have a value of `all`, `logged_in` or `acl`.
+#' The value `all` is the most permissive; any visitor to Posit
+#' Connect will be able to view this content. The value `logged_in`
+#' indicates that all Posit Connect accounts may view the content. The
+#' `acl` value lets specifically enumerated users and groups view the
+#' content. Users configured as collaborators may always view content.
+#' * `connection_timeout`: Maximum number of seconds allowed without data
+#' sent or received across a client connection. A value of 0 means
+#' connections will never time-out (not recommended). When null, the
+#' default `Scheduler.ConnectionTimeout` is used. Applies only to content
+#' types that are executed on demand.
+#' * `read_timeout`: Maximum number of seconds allowed without data received
+#' from a client connection. A value of 0 means a lack of client (browser)
+#' interaction never causes the connection to close. When null, the default
+#' `Scheduler.ReadTimeout` is used. Applies only to content types that are
+#' executed on demand.
+#' * `init_timeout`: The maximum number of seconds allowed for an interactive
+#' application to start. Posit Connect must be able to connect
+#' to a newly launched Shiny application, for example, before this threshold
+#' has elapsed. When null, the default `Scheduler.InitTimeout` is
+#' used. Applies only to content types that are executed on demand.
+#' * `idle_timeout`: The maximum number of seconds a worker process
+#' for an interactive application to remain alive after it goes idle (no
+#' active connections). When null, the default `Scheduler.IdleTimeout`
+#' is used. Applies only to content types that are executed on demand.
+#' * `max_processes`: Specifies the total number of concurrent processes
+#' allowed for a single interactive application. When null, the
+#' default `Scheduler.MaxProcesses` setting is used. Applies only to
+#' content types that are executed on demand.
+#' * `min_processes`: Specifies the minimum number of concurrent
+#' processes allowed for a single interactive application. When null, the
+#' default `Scheduler.MinProcesses` is used. Applies only to content types
+#' that are executed on demand.
+#' * `max_conns_per_process`: Specifies the maximum number of
+#' client connections allowed to an individual process. Incoming connections
+#' which will exceed this limit are routed to a new process or rejected.
+#' When null, the default `Scheduler.MaxConnsPerProcess` is used. Applies
+#' only to content types that are executed on demand.
+#' * `load_factor`: Controls how aggressively new processes are spawned.
+#' When null, the default `Scheduler.LoadFactor` is used. Applies only to
+#' content types that are executed on demand.
+#' * `url`: The URL associated with this content. Computed from
+#' the associated vanity URL or the identifiers for this content.
+#' * `vanity_url`: The vanity url assigned to this app by an
+#' administrator
+#' * `name`: A simple, URL-friendly identifier. Allows
+#' alpha-numeric characters, hyphens ("-"), and underscores ("_").
+#' * `title`: The title of this content.
+#' * `bundle_id`: The identifier for the active deployment bundle.
+#' Automatically assigned upon the successful deployment of that bundle.
+#' * `app_mode`: The runtime model for this content. Has a value
+#' of unknown before data is deployed to this item. Automatically assigned
+#' upon the first successful bundle deployment.
+#' * `content_category`: Describes the specialization of the content
+#' runtime model. Automatically assigned upon the first successful bundle
+#' deployment.
+#' * `has_parameters`: True when R Markdown rendered content
+#' allows parameter configuration. Automatically assigned upon the first
+#' successful bundle deployment. Applies only to content with an app_mode
+#' of rmd-static.
+#' * `created_time`: The timestamp (RFC3339) indicating when this
+#' content was created.
+#' * `last_deployed_time`: The timestamp (RFC3339) indicating when
+#' this content last had a successful bundle deployment performed.
+#' * `r_version`: The version of the R interpreter associated
+#' with this content. The value null represents that an R interpreter is
+#' not used by this content or that the R package environment has not been
+#' successfully restored. Automatically assigned upon the successful
+#' deployment of a bundle.
+#' * `py_version`: The version of the Python interpreter
+#' associated with this content. The value null represents that a Python
+#' interpreter is not used by this content or that the Python package
+#' environment has not been successfully restored. Automatically assigned
+#' upon the successful deployment of a bundle.
+#' * `build_status`:
+#' * `run_as`: The UNIX user that executes this content.
+#' When null, the default Applications.RunAs is used. Applies
+#' only to executable content types - not static.
+#' * `run_as_current_user`: Indicates if this content is allowed
+#' to execute as the logged-in user when using PAM authentication.
+#' Applies only to executable content types - not static.
+#' * `description`: A rich description of this content
+#' * `app_role`: The relationship of the accessing user to this
+#' content. A value of owner is returned for the content owner. editor
+#' indicates a collaborator. The viewer value is given to users who are
+#' permitted to view the content. A none role is returned for
+#' administrators who cannot view the content but are permitted to view
+#' its configuration. Computed at the time of the request.
+#' * `owner_first_name`: The first name of the owner of the
+#' content.
+#' * `owner_last_name`: The last name of the owner of the
+#' content.
+#' * `owner_username`: The username of the owner of the
+#' content.
+#' * `owner_guid`: The unique identifier for the owner
+#' * `owner_email`: The email of the content owner
+#' * `owner_locked`: Is the owners user account locked?
+#' * `is_scheduled`: Is this content scheduled?
+#' * `git`: Is this content deployed via git or GitHub?
#'
#' @details
-#' Please see https://docs.posit.co/connect/api/#getContent for more information
+#' Please see https://docs.posit.co/connect/api/#getContent for more
+#' information.
#'
#' @examples
#' \dontrun{
@@ -556,25 +553,24 @@ get_content_old <- function(src, filter = NULL, limit = 25, page_size = 25) {
#' should be listed in ascending or descending order within the response.
#' Ordering is by the started timestamp field.
#'
-#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{content_guid}}{The GUID, in RFC4122 format, of the
-#' Shiny application this information pertains to.}
-#' \item{\strong{user_guid}}{The GUID, in RFC4122 format, of the user
-#' that visited the application.}
-#' \item{\strong{started}}{The timestamp, in RFC3339 format, when the
-#' user opened the application.}
-#' \item{\strong{ended}}{The timestamp, in RFC3339 format, when the
-#' user left the application.}
-#' \item{\strong{data_version}}{The data version the record was recorded
-#' with. The Shiny Application Events section of the Posit Connect Admin
-#' Guide explains how to interpret data_version values.}
-#' }
+#'
+#' * `content_guid`: The GUID, in RFC4122 format, of the
+#' Shiny application this information pertains to.
+#' * `user_guid`: The GUID, in RFC4122 format, of the user
+#' that visited the application.
+#' * `started`: The timestamp, in RFC3339 format, when the
+#' user opened the application.
+#' * `ended`: The timestamp, in RFC3339 format, when the
+#' user left the application.
+#' * `data_version`: The data version the record was recorded
+#' with. The Shiny Application Events section of the Posit Connect Admin
+#' Guide explains how to interpret data_version values.
#'
#' @details
-#' Please see https://docs.posit.co/connect/api/#getShinyAppUsage for more information
+#' Please see https://docs.posit.co/connect/api/#getShinyAppUsage for more
+#' information.
#'
#' @examples
#' \dontrun{
@@ -648,28 +644,26 @@ get_usage_shiny <- function(src, content_guid = NULL,
#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{content_guid}}{The GUID, in RFC4122 format, of the Shiny
-#' application this information pertains to.}
-#' \item{\strong{user_guid}}{The GUID, in RFC4122 format, of the user that
-#' visited the application.}
-#' \item{\strong{variant_key}}{The key of the variant the user visited.
-#' This will be null for static content.}
-#' \item{\strong{time}}{The timestamp, in RFC3339 format, when the user
-#' visited the content.}
-#' \item{\strong{rendering_id}}{The ID of the rendering the user visited.
-#' This will be null for static content.}
-#' \item{\strong{bundle_id}}{The ID of the particular bundle used.}
-#' \item{\strong{data_version}}{The data version the record was recorded
-#' with. The Rendered and Static Content Visit Events section of the
-#' Posit Connect Admin Guide explains how to interpret data_version
-#' values.}
-#' }
#'
+#' * `content_guid`: The GUID, in RFC4122 format, of the Shiny
+#' application this information pertains to.
+#' * `user_guid`: The GUID, in RFC4122 format, of the user that
+#' visited the application.
+#' * `variant_key`: The key of the variant the user visited.
+#' This will be null for static content.
+#' * `time`: The timestamp, in RFC3339 format, when the user
+#' visited the content.
+#' * `rendering_id`: The ID of the rendering the user visited.
+#' This will be null for static content.
+#' * `bundle_id`: The ID of the particular bundle used.
+#' * `data_version`: The data version the record was recorded
+#' with. The Rendered and Static Content Visit Events section of the
+#' Posit Connect Admin Guide explains how to interpret data_version
+#' values.
#'
#' @details
#' Please see https://docs.posit.co/connect/api/#getContentVisits for more
-#' information
+#' information.
#'
#' @examples
#' \dontrun{
@@ -728,18 +722,17 @@ get_usage_static <- function(src, content_guid = NULL,
#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{id}}{ID of the audit action}
-#' \item{\strong{time}}{Timestamp in RFC3339 format when action was taken}
-#' \item{\strong{user_id}}{User ID of the actor who made the audit action}
-#' \item{\strong{user_description}}{Description of the actor}
-#' \item{\strong{action}}{Audit action taken}
-#' \item{\strong{event_description}}{Description of action}
-#' }
+#'
+#' * `id`: ID of the audit action
+#' * `time`: Timestamp in RFC3339 format when action was taken
+#' * `user_id`: User ID of the actor who made the audit action
+#' * `user_description`: Description of the actor
+#' * `action`: Audit action taken
+#' * `event_description`: Description of action
#'
#' @details
#' Please see https://docs.posit.co/connect/api/#getAuditLogs for more
-#' information
+#' information.
#'
#' @examples
#' \dontrun{
@@ -780,18 +773,17 @@ get_audit_logs <- function(src, limit = 20L, previous = NULL,
#'
#' @return
#' A tibble with the following columns:
-#' \itemize{
-#' \item{\strong{pid}}{The PID of the current process}
-#' \item{\strong{appId}}{The application ID}
-#' \item{\strong{appGuid}}{The application GUID}
-#' \item{\strong{appName}}{The application name}
-#' \item{\strong{appUrl}}{The application URL}
-#' \item{\strong{appRunAs}}{The application RunAs user}
-#' \item{\strong{type}}{The type of process}
-#' \item{\strong{cpuCurrent}}{The current CPU usage}
-#' \item{\strong{cpuTotal}}{The total CPU usage}
-#' \item{\strong{ram}}{The current RAM usage}
-#' }
+#'
+#' * `pid`: The PID of the current process
+#' * `appId`: The application ID
+#' * `appGuid`: The application GUID
+#' * `appName`: The application name
+#' * `appUrl`: The application URL
+#' * `appRunAs`: The application RunAs user
+#' * `type`: The type of process
+#' * `cpuCurrent`: The current CPU usage
+#' * `cpuTotal`: The total CPU usage
+#' * `ram`: The current RAM usage
#'
#' @export
get_procs <- function(src) {
diff --git a/man/Content.Rd b/man/Content.Rd
index 3350fa6e..64239e4f 100644
--- a/man/Content.Rd
+++ b/man/Content.Rd
@@ -342,13 +342,13 @@ Set a tag for this content.
\subsection{Method \code{tag_delete()}}{
Remove a tag for this content.
\subsection{Usage}{
-\if{html}{\out{}}\preformatted{Content$tag_delete(id)}\if{html}{\out{
}}
+\if{html}{\out{}}\preformatted{Content$tag_delete(tag_id)}\if{html}{\out{
}}
}
\subsection{Arguments}{
\if{html}{\out{}}
\describe{
-\item{\code{id}}{The tag identifier.}
+\item{\code{tag_id}}{The tag identifier.}
}
\if{html}{\out{
}}
}
diff --git a/man/PositConnect.Rd b/man/PositConnect.Rd
index 0c1422fb..6dfa7990 100644
--- a/man/PositConnect.Rd
+++ b/man/PositConnect.Rd
@@ -93,6 +93,7 @@ Other R6 classes:
\item \href{#method-Connect-content}{\code{Connect$content()}}
\item \href{#method-Connect-task}{\code{Connect$task()}}
\item \href{#method-Connect-set_content_tag}{\code{Connect$set_content_tag()}}
+\item \href{#method-Connect-remove_content_tag}{\code{Connect$remove_content_tag()}}
\item \href{#method-Connect-user}{\code{Connect$user()}}
\item \href{#method-Connect-users}{\code{Connect$users()}}
\item \href{#method-Connect-users_remote}{\code{Connect$users_remote()}}
@@ -749,6 +750,25 @@ Set a tag for a content item.
\describe{
\item{\code{content_id}}{The content identifier.}
+\item{\code{tag_id}}{The tag identifier.}
+}
+\if{html}{\out{}}
+}
+}
+\if{html}{\out{
}}
+\if{html}{\out{}}
+\if{latex}{\out{\hypertarget{method-Connect-remove_content_tag}{}}}
+\subsection{Method \code{remove_content_tag()}}{
+Remove a tag from a content item.
+\subsection{Usage}{
+\if{html}{\out{}}\preformatted{Connect$remove_content_tag(content_id, tag_id)}\if{html}{\out{
}}
+}
+
+\subsection{Arguments}{
+\if{html}{\out{}}
+\describe{
+\item{\code{content_id}}{The content identifier.}
+
\item{\code{tag_id}}{The tag identifier.}
}
\if{html}{\out{
}}
diff --git a/man/get_audit_logs.Rd b/man/get_audit_logs.Rd
index 9849b8f7..8919706b 100644
--- a/man/get_audit_logs.Rd
+++ b/man/get_audit_logs.Rd
@@ -28,12 +28,12 @@ Ordering is by the started timestamp field.}
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{id}}{ID of the audit action}
-\item{\strong{time}}{Timestamp in RFC3339 format when action was taken}
-\item{\strong{user_id}}{User ID of the actor who made the audit action}
-\item{\strong{user_description}}{Description of the actor}
-\item{\strong{action}}{Audit action taken}
-\item{\strong{event_description}}{Description of action}
+\item \code{id}: ID of the audit action
+\item \code{time}: Timestamp in RFC3339 format when action was taken
+\item \code{user_id}: User ID of the actor who made the audit action
+\item \code{user_description}: Description of the actor
+\item \code{action}: Audit action taken
+\item \code{event_description}: Description of action
}
}
\description{
@@ -41,7 +41,7 @@ Get Audit Logs from Posit Connect Server
}
\details{
Please see https://docs.posit.co/connect/api/#getAuditLogs for more
-information
+information.
}
\examples{
\dontrun{
diff --git a/man/get_content.Rd b/man/get_content.Rd
index 86a58e33..cfac8e33 100644
--- a/man/get_content.Rd
+++ b/man/get_content.Rd
@@ -22,106 +22,108 @@ get_content(src, guid = NULL, owner_guid = NULL, name = NULL, ..., .p = NULL)
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{guid}}{The unique identifier of this content item.}
-\item{\strong{name}}{A simple, URL-friendly identifier. Allows
-alpha-numeric characters, hyphens ("-"), and underscores ("_").}
-\item{\strong{title}}{The title of this content.}
-\item{\strong{description}}{A rich description of this content}
-\item{\strong{access_type}}{Access type describes how this content manages
-its viewers. The value all is the most permissive; any visitor to Posit
-Connect will be able to view this content. The value logged_in indicates
-that all Posit Connect accounts may view the content. The acl value
-lets specifically enumerated users and groups view the content. Users
-configured as collaborators may always view content. It may have a
-value of all, logged_in or acl.}
-\item{\strong{connection_timeout}}{Maximum number of seconds allowed
-without data sent or received across a client connection. A value of 0
-means connections will never time-out (not recommended). When null, the
-default Scheduler.ConnectionTimeout is used. Applies only to content
-types that are executed on demand.}
-\item{\strong{read_timeout}}{Maximum number of seconds allowed without
-data received from a client connection. A value of 0 means a lack of client
-(browser) interaction never causes the connection to close. When null,
-the default Scheduler.ReadTimeout is used. Applies only to content types
-that are executed on demand.}
-\item{\strong{init_timeout}}{The maximum number of seconds allowed for an
-interactive application to start. Posit Connect must be able to connect
+\item \code{guid}: The unique identifier of this content item.
+\item \code{name}: A simple, URL-friendly identifier. Allows alpha-numeric
+characters, hyphens ("-"), and underscores ("_").
+\item \code{title}: The title of this content.
+\item \code{description}: A rich description of this content
+\item \code{access_type}: Access type describes how this content manages its
+viewers. It may have a value of \code{all}, \code{logged_in} or \code{acl}.
+The value \code{all} is the most permissive; any visitor to Posit
+Connect will be able to view this content. The value \code{logged_in}
+indicates that all Posit Connect accounts may view the content. The
+\code{acl} value lets specifically enumerated users and groups view the
+content. Users configured as collaborators may always view content.
+\item \code{connection_timeout}: Maximum number of seconds allowed without data
+sent or received across a client connection. A value of 0 means
+connections will never time-out (not recommended). When null, the
+default \code{Scheduler.ConnectionTimeout} is used. Applies only to content
+types that are executed on demand.
+\item \code{read_timeout}: Maximum number of seconds allowed without data received
+from a client connection. A value of 0 means a lack of client (browser)
+interaction never causes the connection to close. When null, the default
+\code{Scheduler.ReadTimeout} is used. Applies only to content types that are
+executed on demand.
+\item \code{init_timeout}: The maximum number of seconds allowed for an interactive
+application to start. Posit Connect must be able to connect
to a newly launched Shiny application, for example, before this threshold
-has elapsed. When null, the default Scheduler.InitTimeout is used. Applies
-only to content types that are executed on demand.}
-\item{\strong{idle_timeout}}{The maximum number of seconds a worker process
+has elapsed. When null, the default \code{Scheduler.InitTimeout} is
+used. Applies only to content types that are executed on demand.
+\item \code{idle_timeout}: The maximum number of seconds a worker process
for an interactive application to remain alive after it goes idle (no
-active connections). When null, the default Scheduler.IdleTimeout is used.
-Applies only to content types that are executed on demand.}
-\item{\strong{max_processes}}{Specifies the total number of concurrent
+active connections). When null, the default \code{Scheduler.IdleTimeout}
+is used. Applies only to content types that are executed on demand.
+\item \code{max_processes}: Specifies the total number of concurrent processes
+allowed for a single interactive application. When null, the
+default \code{Scheduler.MaxProcesses} setting is used. Applies only to
+content types that are executed on demand.
+\item \code{min_processes}: Specifies the minimum number of concurrent
processes allowed for a single interactive application. When null, the
-default Scheduler.MaxProcesses is used. Applies only to content types
-that are executed on demand.}
-\item{\strong{min_processes}}{Specifies the minimum number of concurrent
-processes allowed for a single interactive application. When null, the
-default Scheduler.MinProcesses is used. Applies only to content types
-that are executed on demand.}
-\item{\strong{max_conns_per_process}}{Specifies the maximum number of
+default \code{Scheduler.MinProcesses} is used. Applies only to content types
+that are executed on demand.
+\item \code{max_conns_per_process}: Specifies the maximum number of
client connections allowed to an individual process. Incoming connections
which will exceed this limit are routed to a new process or rejected.
-When null, the default Scheduler.MaxConnsPerProcess is used. Applies
-only to content types that are executed on demand.}
-\item{\strong{load_factor}}{Controls how aggressively new processes are spawned.
-When null, the default Scheduler.LoadFactor is used. Applies only to
-content types that are executed on demand.}
-\item{\strong{created_time}}{The timestamp (RFC3339) indicating when this
-content was created.}
-\item{\strong{last_deployed_time}}{The timestamp (RFC3339) indicating when
-this content last had a successful bundle deployment performed.}
-\item{\strong{bundle_id}}{The identifier for the active deployment bundle.
-Automatically assigned upon the successful deployment of that bundle.}
-\item{\strong{app_mode}}{The runtime model for this content. Has a value
-of unknown before data is deployed to this item. Automatically assigned
-upon the first successful bundle deployment. Allowed: api, jupyter-static,
-python-api, python-bokeh, python-dash, python-streamlit, rmd-shiny,
-rmd-static, shiny, static, tensorflow-saved-model, unknown}
-\item{\strong{content_category}}{Describes the specialization of the content
+When null, the default \code{Scheduler.MaxConnsPerProcess} is used. Applies
+only to content types that are executed on demand.
+\item \code{load_factor}: Controls how aggressively new processes are spawned.
+When null, the default \code{Scheduler.LoadFactor} is used. Applies only to
+content types that are executed on demand.
+\item \code{created_time}: The timestamp (RFC3339) indicating when this
+content was created.
+\item \code{last_deployed_time}: The timestamp (RFC3339) indicating when
+this content last had a successful bundle deployment performed.
+\item \code{bundle_id}: The identifier for the active deployment bundle.
+Automatically assigned upon the successful deployment of that bundle.
+\item \code{app_mode}: The runtime model for this content. Has a value
+of \code{unknown} before data is deployed to this item. Automatically assigned
+upon the first successful bundle deployment. Allowed: \code{api},
+\code{jupyter-static}, \code{python-api}, \code{python-bokeh}, \code{python-dash},
+\code{python-streamlit}, \code{rmd-shiny}, \code{rmd-static}, \code{shiny}, \code{static},
+\code{tensorflow-saved-model}, \code{unknown}.
+\item \code{content_category}: Describes the specialization of the content
runtime model. Automatically assigned upon the first successful bundle
-deployment.}
-\item{\strong{parameterized}}{True when R Markdown rendered content
+deployment.
+\item \code{parameterized}: True when R Markdown rendered content
allows parameter configuration. Automatically assigned upon the first
successful bundle deployment. Applies only to content with an app_mode
-of rmd-static.}
-\item{\strong{r_version}}{The version of the R interpreter associated
+of rmd-static.
+\item \code{r_version}: The version of the R interpreter associated
with this content. The value null represents that an R interpreter is
not used by this content or that the R package environment has not been
successfully restored. Automatically assigned upon the successful
-deployment of a bundle.}
-\item{\strong{py_version}}{The version of the Python interpreter
+deployment of a bundle.
+\item \code{py_version}: The version of the Python interpreter
associated with this content. The value null represents that a Python
interpreter is not used by this content or that the Python package
environment has not been successfully restored. Automatically assigned
-upon the successful deployment of a bundle.}
-\item{\strong{run_as}}{The UNIX user that executes this content.
+upon the successful deployment of a bundle.
+\item \code{run_as}: The UNIX user that executes this content.
When null, the default Applications.RunAs is used. Applies
-only to executable content types - not static.}
-\item{\strong{run_as_current_user}}{Indicates if this content is allowed
+only to executable content types - not static.
+\item \code{run_as_current_user}: Indicates if this content is allowed
to execute as the logged-in user when using PAM authentication.
-Applies only to executable content types - not static.}
-\item{\strong{owner_guid}}{The unique identifier for the owner}
-\item{\strong{content_url}}{The URL associated with this content. Computed
-from the associated vanity URL or GUID for this content.}
-\item{\strong{dashboard_url}}{The URL within the Connect dashboard where
-this content can be configured. Computed from the GUID for this content.}
-\item{\strong{role}}{The relationship of the accessing user to this
+Applies only to executable content types - not static.
+\item \code{owner_guid}: The unique identifier for the owner
+\item \code{content_url}: The URL associated with this content. Computed
+from the associated vanity URL or GUID for this content.
+\item \code{dashboard_url}: The URL within the Connect dashboard where
+this content can be configured. Computed from the GUID for this content.
+\item \code{role}: The relationship of the accessing user to this
content. A value of owner is returned for the content owner. editor
indicates a collaborator. The viewer value is given to users who are
permitted to view the content. A none role is returned for
administrators who cannot view the content but are permitted to view
-its configuration. Computed at the time of the request.}
-\item{\strong{id}}{The internal numeric identifier of this content item}
+its configuration. Computed at the time of the request.
+\item \code{id}: The internal numeric identifier of this content item
}
}
\description{
Get information about content on the Posit Connect server
}
\details{
-Please see https://docs.posit.co/connect/api/#get-/v1/content for more information
+Please see https://docs.posit.co/connect/api/#get-/v1/content for more
+information.
}
\examples{
\dontrun{
diff --git a/man/get_content_old.Rd b/man/get_content_old.Rd
index 763d5d43..06f4a4cc 100644
--- a/man/get_content_old.Rd
+++ b/man/get_content_old.Rd
@@ -18,115 +18,116 @@ get_content_old(src, filter = NULL, limit = 25, page_size = 25)
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{id}}{The application ID}
-\item{\strong{guid}}{The unique identifier of this content item.}
-\item{\strong{access_type}}{Access type describes how this content manages
-its viewers. The value all is the most permissive; any visitor to Posit
-Connect will be able to view this content. The value logged_in indicates
-that all Posit Connect accounts may view the content. The acl value
-lets specifically enumerated users and groups view the content. Users
-configured as collaborators may always view content. It may have a
-value of all, logged_in or acl.}
-\item{\strong{connection_timeout}}{Maximum number of seconds allowed
-without data sent or received across a client connection. A value of 0
-means connections will never time-out (not recommended). When null, the
-default Scheduler.ConnectionTimeout is used. Applies only to content
-types that are executed on demand.}
-\item{\strong{read_timeout}}{Maximum number of seconds allowed without
-data received from a client connection. A value of 0 means a lack of client
-(browser) interaction never causes the connection to close. When null,
-the default Scheduler.ReadTimeout is used. Applies only to content types
-that are executed on demand.}
-\item{\strong{init_timeout}}{The maximum number of seconds allowed for an
-interactive application to start. Posit Connect must be able to connect
+\item \code{id}: The application ID
+\item \code{guid}: The unique identifier of this content item.
+\item \code{access_type}: Access type describes how this content manages its
+viewers. It may have a value of \code{all}, \code{logged_in} or \code{acl}.
+The value \code{all} is the most permissive; any visitor to Posit
+Connect will be able to view this content. The value \code{logged_in}
+indicates that all Posit Connect accounts may view the content. The
+\code{acl} value lets specifically enumerated users and groups view the
+content. Users configured as collaborators may always view content.
+\item \code{connection_timeout}: Maximum number of seconds allowed without data
+sent or received across a client connection. A value of 0 means
+connections will never time-out (not recommended). When null, the
+default \code{Scheduler.ConnectionTimeout} is used. Applies only to content
+types that are executed on demand.
+\item \code{read_timeout}: Maximum number of seconds allowed without data received
+from a client connection. A value of 0 means a lack of client (browser)
+interaction never causes the connection to close. When null, the default
+\code{Scheduler.ReadTimeout} is used. Applies only to content types that are
+executed on demand.
+\item \code{init_timeout}: The maximum number of seconds allowed for an interactive
+application to start. Posit Connect must be able to connect
to a newly launched Shiny application, for example, before this threshold
-has elapsed. When null, the default Scheduler.InitTimeout is used. Applies
-only to content types that are executed on demand.}
-\item{\strong{idle_timeout}}{The maximum number of seconds a worker process
+has elapsed. When null, the default \code{Scheduler.InitTimeout} is
+used. Applies only to content types that are executed on demand.
+\item \code{idle_timeout}: The maximum number of seconds a worker process
for an interactive application to remain alive after it goes idle (no
-active connections). When null, the default Scheduler.IdleTimeout is used.
-Applies only to content types that are executed on demand.}
-\item{\strong{max_processes}}{Specifies the total number of concurrent
+active connections). When null, the default \code{Scheduler.IdleTimeout}
+is used. Applies only to content types that are executed on demand.
+\item \code{max_processes}: Specifies the total number of concurrent processes
+allowed for a single interactive application. When null, the
+default \code{Scheduler.MaxProcesses} setting is used. Applies only to
+content types that are executed on demand.
+\item \code{min_processes}: Specifies the minimum number of concurrent
processes allowed for a single interactive application. When null, the
-default Scheduler.MaxProcesses is used. Applies only to content types
-that are executed on demand.}
-\item{\strong{min_processes}}{Specifies the minimum number of concurrent
-processes allowed for a single interactive application. When null, the
-default Scheduler.MinProcesses is used. Applies only to content types
-that are executed on demand.}
-\item{\strong{max_conns_per_process}}{Specifies the maximum number of
+default \code{Scheduler.MinProcesses} is used. Applies only to content types
+that are executed on demand.
+\item \code{max_conns_per_process}: Specifies the maximum number of
client connections allowed to an individual process. Incoming connections
which will exceed this limit are routed to a new process or rejected.
-When null, the default Scheduler.MaxConnsPerProcess is used. Applies
-only to content types that are executed on demand.}
-\item{\strong{load_factor}}{Controls how aggressively new processes are spawned.
-When null, the default Scheduler.LoadFactor is used. Applies only to
-content types that are executed on demand.}
-\item{\strong{url}}{The URL associated with this content. Computed from
-the associated vanity URL or the identifiers for this content.}
-\item{\strong{vanity_url}}{The vanity url assigned to this app by an
-administrator}
-\item{\strong{name}}{A simple, URL-friendly identifier. Allows
-alpha-numeric characters, hyphens ("-"), and underscores ("_").}
-\item{\strong{title}}{The title of this content.}
-\item{\strong{bundle_id}}{The identifier for the active deployment bundle.
-Automatically assigned upon the successful deployment of that bundle.}
-\item{\strong{app_mode}}{The runtime model for this content. Has a value
+When null, the default \code{Scheduler.MaxConnsPerProcess} is used. Applies
+only to content types that are executed on demand.
+\item \code{load_factor}: Controls how aggressively new processes are spawned.
+When null, the default \code{Scheduler.LoadFactor} is used. Applies only to
+content types that are executed on demand.
+\item \code{url}: The URL associated with this content. Computed from
+the associated vanity URL or the identifiers for this content.
+\item \code{vanity_url}: The vanity url assigned to this app by an
+administrator
+\item \code{name}: A simple, URL-friendly identifier. Allows
+alpha-numeric characters, hyphens ("-"), and underscores ("_").
+\item \code{title}: The title of this content.
+\item \code{bundle_id}: The identifier for the active deployment bundle.
+Automatically assigned upon the successful deployment of that bundle.
+\item \code{app_mode}: The runtime model for this content. Has a value
of unknown before data is deployed to this item. Automatically assigned
-upon the first successful bundle deployment.}
-\item{\strong{content_category}}{Describes the specialization of the content
+upon the first successful bundle deployment.
+\item \code{content_category}: Describes the specialization of the content
runtime model. Automatically assigned upon the first successful bundle
-deployment.}
-\item{\strong{has_parameters}}{True when R Markdown rendered content
+deployment.
+\item \code{has_parameters}: True when R Markdown rendered content
allows parameter configuration. Automatically assigned upon the first
successful bundle deployment. Applies only to content with an app_mode
-of rmd-static.}
-\item{\strong{created_time}}{The timestamp (RFC3339) indicating when this
-content was created.}
-\item{\strong{last_deployed_time}}{The timestamp (RFC3339) indicating when
-this content last had a successful bundle deployment performed.}
-\item{\strong{r_version}}{The version of the R interpreter associated
+of rmd-static.
+\item \code{created_time}: The timestamp (RFC3339) indicating when this
+content was created.
+\item \code{last_deployed_time}: The timestamp (RFC3339) indicating when
+this content last had a successful bundle deployment performed.
+\item \code{r_version}: The version of the R interpreter associated
with this content. The value null represents that an R interpreter is
not used by this content or that the R package environment has not been
successfully restored. Automatically assigned upon the successful
-deployment of a bundle.}
-\item{\strong{py_version}}{The version of the Python interpreter
+deployment of a bundle.
+\item \code{py_version}: The version of the Python interpreter
associated with this content. The value null represents that a Python
interpreter is not used by this content or that the Python package
environment has not been successfully restored. Automatically assigned
-upon the successful deployment of a bundle.}
-\item{\strong{build_status}}{}
-\item{\strong{run_as}}{The UNIX user that executes this content.
+upon the successful deployment of a bundle.
+\item \code{build_status}:
+\item \code{run_as}: The UNIX user that executes this content.
When null, the default Applications.RunAs is used. Applies
-only to executable content types - not static.}
-\item{\strong{run_as_current_user}}{Indicates if this content is allowed
+only to executable content types - not static.
+\item \code{run_as_current_user}: Indicates if this content is allowed
to execute as the logged-in user when using PAM authentication.
-Applies only to executable content types - not static.}
-\item{\strong{description}}{A rich description of this content}
-\item{\strong{app_role}}{The relationship of the accessing user to this
+Applies only to executable content types - not static.
+\item \code{description}: A rich description of this content
+\item \code{app_role}: The relationship of the accessing user to this
content. A value of owner is returned for the content owner. editor
indicates a collaborator. The viewer value is given to users who are
permitted to view the content. A none role is returned for
administrators who cannot view the content but are permitted to view
-its configuration. Computed at the time of the request.}
-\item{\strong{owner_first_name}}{The first name of the owner of the
-content.}
-\item{\strong{owner_last_name}}{The last name of the owner of the
-content.}
-\item{\strong{owner_username}}{The username of the owner of the
-content.}
-\item{\strong{owner_guid}}{The unique identifier for the owner}
-\item{\strong{owner_email}}{The email of the content owner}
-\item{\strong{owner_locked}}{Is the owners user account locked?}
-\item{\strong{is_scheduled}}{Is this content scheduled?}
-\item{\strong{git}}{Is this content deployed via git or GitHub?}
+its configuration. Computed at the time of the request.
+\item \code{owner_first_name}: The first name of the owner of the
+content.
+\item \code{owner_last_name}: The last name of the owner of the
+content.
+\item \code{owner_username}: The username of the owner of the
+content.
+\item \code{owner_guid}: The unique identifier for the owner
+\item \code{owner_email}: The email of the content owner
+\item \code{owner_locked}: Is the owners user account locked?
+\item \code{is_scheduled}: Is this content scheduled?
+\item \code{git}: Is this content deployed via git or GitHub?
}
}
\description{
Get information about content on the Posit Connect server
}
\details{
-Please see https://docs.posit.co/connect/api/#getContent for more information
+Please see https://docs.posit.co/connect/api/#getContent for more
+information.
}
\examples{
\dontrun{
diff --git a/man/get_group_members.Rd b/man/get_group_members.Rd
index 7011c2d5..982815e8 100644
--- a/man/get_group_members.Rd
+++ b/man/get_group_members.Rd
@@ -14,30 +14,31 @@ get_group_members(src, guid)
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{email}}{The user's email}
-\item{\strong{username}}{The user's username}
-\item{\strong{first_name}}{The user's first name}
-\item{\strong{last_name}}{The user's last name}
-\item{\strong{user_role}}{The user's role. It may have a value of
-administrator, publisher or viewer.}
-\item{\strong{created_time}}{The timestamp (in RFC3339 format) when the
-user was created in the Posit Connect server}
-\item{\strong{updated_time}}{The timestamp (in RFC3339 format) when the
-user was last updated in the Posit Connect server}
-\item{\strong{active_time}}{The timestamp (in RFC3339 format) when the
-user was last active on the Posit Connect server}
-\item{\strong{confirmed}}{When false, the created user must confirm their
+\item \code{email}: The user's email
+\item \code{username}: The user's username
+\item \code{first_name}: The user's first name
+\item \code{last_name}: The user's last name
+\item \code{user_role}: The user's role. It may have a value of administrator,
+publisher or viewer.
+\item \code{created_time}: The timestamp (in RFC3339 format) when the user
+was created in the Posit Connect server
+\item \code{updated_time}: The timestamp (in RFC3339 format) when the user
+was last updated in the Posit Connect server
+\item \code{active_time}: The timestamp (in RFC3339 format) when the user
+was last active on the Posit Connect server
+\item \code{confirmed}: When false, the created user must confirm their
account through an email. This feature is unique to password
-authentication.}
-\item{\strong{locked}}{Whether or not the user is locked}
-\item{\strong{guid}}{The user's GUID, or unique identifier, in UUID RFC4122 format}
+authentication.
+\item \code{locked}: Whether or not the user is locked
+\item \code{guid}: The user's GUID, or unique identifier, in UUID RFC4122 format
}
}
\description{
Get users within a specific group
}
\details{
-Please see https://docs.posit.co/connect/api/#getGroupMembers for more information
+Please see https://docs.posit.co/connect/api/#getGroupMembers for more
+information.
}
\examples{
\dontrun{
diff --git a/man/get_groups.Rd b/man/get_groups.Rd
index 3174eb40..cfc48eef 100644
--- a/man/get_groups.Rd
+++ b/man/get_groups.Rd
@@ -19,18 +19,18 @@ The filter is case insensitive.}
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{guid}}{The unique identifier of the group}
-\item{\strong{name}}{The group name}
-\item{\strong{owner_guid}}{The group owner's unique identifier.
-When using LDAP, or Proxied authentication with group provisioning
-enabled this property will always be null.}
+\item \code{guid}: The unique identifier of the group
+\item \code{name}: The group name
+\item \code{owner_guid}: The group owner's unique identifier. When using LDAP or
+Proxied authentication with group provisioning enabled this property
+will always be null.
}
}
\description{
Get group information from the Posit Connect server
}
\details{
-Please see https://docs.posit.co/connect/api/#getGroups for more information
+Please see https://docs.posit.co/connect/api/#getGroups for more information.
}
\examples{
\dontrun{
diff --git a/man/get_procs.Rd b/man/get_procs.Rd
index 7c062bde..e82de40e 100644
--- a/man/get_procs.Rd
+++ b/man/get_procs.Rd
@@ -12,16 +12,16 @@ get_procs(src)
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{pid}}{The PID of the current process}
-\item{\strong{appId}}{The application ID}
-\item{\strong{appGuid}}{The application GUID}
-\item{\strong{appName}}{The application name}
-\item{\strong{appUrl}}{The application URL}
-\item{\strong{appRunAs}}{The application RunAs user}
-\item{\strong{type}}{The type of process}
-\item{\strong{cpuCurrent}}{The current CPU usage}
-\item{\strong{cpuTotal}}{The total CPU usage}
-\item{\strong{ram}}{The current RAM usage}
+\item \code{pid}: The PID of the current process
+\item \code{appId}: The application ID
+\item \code{appGuid}: The application GUID
+\item \code{appName}: The application name
+\item \code{appUrl}: The application URL
+\item \code{appRunAs}: The application RunAs user
+\item \code{type}: The type of process
+\item \code{cpuCurrent}: The current CPU usage
+\item \code{cpuTotal}: The total CPU usage
+\item \code{ram}: The current RAM usage
}
}
\description{
diff --git a/man/get_usage_shiny.Rd b/man/get_usage_shiny.Rd
index 02ad969e..446dee1f 100644
--- a/man/get_usage_shiny.Rd
+++ b/man/get_usage_shiny.Rd
@@ -54,24 +54,25 @@ Ordering is by the started timestamp field.}
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{content_guid}}{The GUID, in RFC4122 format, of the
-Shiny application this information pertains to.}
-\item{\strong{user_guid}}{The GUID, in RFC4122 format, of the user
-that visited the application.}
-\item{\strong{started}}{The timestamp, in RFC3339 format, when the
-user opened the application.}
-\item{\strong{ended}}{The timestamp, in RFC3339 format, when the
-user left the application.}
-\item{\strong{data_version}}{The data version the record was recorded
+\item \code{content_guid}: The GUID, in RFC4122 format, of the
+Shiny application this information pertains to.
+\item \code{user_guid}: The GUID, in RFC4122 format, of the user
+that visited the application.
+\item \code{started}: The timestamp, in RFC3339 format, when the
+user opened the application.
+\item \code{ended}: The timestamp, in RFC3339 format, when the
+user left the application.
+\item \code{data_version}: The data version the record was recorded
with. The Shiny Application Events section of the Posit Connect Admin
-Guide explains how to interpret data_version values.}
+Guide explains how to interpret data_version values.
}
}
\description{
Get usage information for deployed shiny applications
}
\details{
-Please see https://docs.posit.co/connect/api/#getShinyAppUsage for more information
+Please see https://docs.posit.co/connect/api/#getShinyAppUsage for more
+information.
}
\examples{
\dontrun{
diff --git a/man/get_usage_static.Rd b/man/get_usage_static.Rd
index 6686c7a0..693579d8 100644
--- a/man/get_usage_static.Rd
+++ b/man/get_usage_static.Rd
@@ -54,21 +54,21 @@ Ordering is by the started timestamp field.}
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{content_guid}}{The GUID, in RFC4122 format, of the Shiny
-application this information pertains to.}
-\item{\strong{user_guid}}{The GUID, in RFC4122 format, of the user that
-visited the application.}
-\item{\strong{variant_key}}{The key of the variant the user visited.
-This will be null for static content.}
-\item{\strong{time}}{The timestamp, in RFC3339 format, when the user
-visited the content.}
-\item{\strong{rendering_id}}{The ID of the rendering the user visited.
-This will be null for static content.}
-\item{\strong{bundle_id}}{The ID of the particular bundle used.}
-\item{\strong{data_version}}{The data version the record was recorded
+\item \code{content_guid}: The GUID, in RFC4122 format, of the Shiny
+application this information pertains to.
+\item \code{user_guid}: The GUID, in RFC4122 format, of the user that
+visited the application.
+\item \code{variant_key}: The key of the variant the user visited.
+This will be null for static content.
+\item \code{time}: The timestamp, in RFC3339 format, when the user
+visited the content.
+\item \code{rendering_id}: The ID of the rendering the user visited.
+This will be null for static content.
+\item \code{bundle_id}: The ID of the particular bundle used.
+\item \code{data_version}: The data version the record was recorded
with. The Rendered and Static Content Visit Events section of the
Posit Connect Admin Guide explains how to interpret data_version
-values.}
+values.
}
}
\description{
@@ -77,7 +77,7 @@ on the Posit Connect server (e.g. Rmarkdown, Jupyter Notebooks)
}
\details{
Please see https://docs.posit.co/connect/api/#getContentVisits for more
-information
+information.
}
\examples{
\dontrun{
diff --git a/man/get_users.Rd b/man/get_users.Rd
index 8776d6b0..f4e36fd3 100644
--- a/man/get_users.Rd
+++ b/man/get_users.Rd
@@ -19,30 +19,29 @@ The filter is case insensitive.}
\value{
A tibble with the following columns:
\itemize{
-\item{\strong{email}}{The user's email}
-\item{\strong{username}}{The user's username}
-\item{\strong{first_name}}{The user's first name}
-\item{\strong{last_name}}{The user's last name}
-\item{\strong{user_role}}{The user's role. It may have a value of
-administrator, publisher or viewer.}
-\item{\strong{created_time}}{The timestamp (in RFC3339 format) when the
-user was created in the Posit Connect server}
-\item{\strong{updated_time}}{The timestamp (in RFC3339 format) when the
-user was last updated in the Posit Connect server}
-\item{\strong{active_time}}{The timestamp (in RFC3339 format) when the
-user was last active on the Posit Connect server}
-\item{\strong{confirmed}}{When false, the created user must confirm their
-account through an email. This feature is unique to password
-authentication.}
-\item{\strong{locked}}{Whether or not the user is locked}
-\item{\strong{guid}}{The user's GUID, or unique identifier, in UUID RFC4122 format}
+\item \code{email}: The user's email
+\item \code{username}: The user's username
+\item \code{first_name}: The user's first name
+\item \code{last_name}: The user's last name
+\item \code{user_role}: The user's role. It may have a value of administrator,
+publisher or viewer.
+\item \code{created_time}: The timestamp (in RFC3339 format) when the user was
+created in the Posit Connect server
+\item \code{updated_time}: The timestamp (in RFC3339 format) when the user was last
+updated in the Posit Connect server
+\item \code{active_time}: The timestamp (in RFC3339 format) when the user was last
+active on the Posit Connect server
+\item \code{confirmed}: When false, the created user must confirm their account
+through an email. This feature is unique to password authentication.
+\item \code{locked}: Whether or not the user is locked
+\item \code{guid}: The user's GUID, or unique identifier, in UUID RFC4122 format
}
}
\description{
Get user information from the Posit Connect server
}
\details{
-Please see https://docs.posit.co/connect/api/#getUsers for more information
+Please see https://docs.posit.co/connect/api/#getUsers for more information.
}
\examples{
\dontrun{