From 738f584a2a130de61f0ce6ad1a4737da15c9630d Mon Sep 17 00:00:00 2001 From: lwalejko Date: Fri, 23 Feb 2024 20:31:24 +0000 Subject: [PATCH] Update documentation --- man/AuditLog.Rd | 10 ---------- man/setup_audit_trail.Rd | 4 +--- 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/man/AuditLog.Rd b/man/AuditLog.Rd index 1618a48..2bb79f0 100644 --- a/man/AuditLog.Rd +++ b/man/AuditLog.Rd @@ -11,7 +11,6 @@ This class is used internally to store audit logs for each request. \itemize{ \item \href{#method-AuditLog-new}{\code{AuditLog$new()}} \item \href{#method-AuditLog-disable}{\code{AuditLog$disable()}} -\item \href{#method-AuditLog-enable}{\code{AuditLog$enable()}} \item \href{#method-AuditLog-is_enabled}{\code{AuditLog$is_enabled()}} \item \href{#method-AuditLog-set_request_body}{\code{AuditLog$set_request_body()}} \item \href{#method-AuditLog-set_response_body}{\code{AuditLog$set_response_body()}} @@ -40,15 +39,6 @@ This class is used internally to store audit logs for each request. \if{html}{\out{
}}\preformatted{AuditLog$disable()}\if{html}{\out{
}} } -} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-AuditLog-enable}{}}} -\subsection{Method \code{enable()}}{ -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{AuditLog$enable()}\if{html}{\out{
}} -} - } \if{html}{\out{
}} \if{html}{\out{}} diff --git a/man/setup_audit_trail.Rd b/man/setup_audit_trail.Rd index d33091e..129039f 100644 --- a/man/setup_audit_trail.Rd +++ b/man/setup_audit_trail.Rd @@ -4,7 +4,7 @@ \alias{setup_audit_trail} \title{Set up audit trail} \usage{ -setup_audit_trail(pr, endpoints) +setup_audit_trail(pr, endpoints = list()) } \arguments{ \item{pr}{A plumber router for which the audit trail is to be set up.} @@ -20,8 +20,6 @@ information before routing (preroute) and after serializing the response (postse } \details{ This function modifies the plumber router in place and returns the updated router. - -The audit trail is only enabled if the AUDIT_LOG_ENABLED environment variable is set to "true". } \examples{ pr <- plumber::plumb("your-api-definition.R") |>