Link to OAuth article since it's not a vignette

Fixes #398
r-lib · Sep 6, 2024 · e7501a7 · e7501a7
1 parent fc1384b
commit e7501a7
Show file tree

Hide file tree

Showing 13 changed files with 29 additions and 17 deletions.
diff --git a/R/oauth-flow-auth-code.R b/R/oauth-flow-auth-code.R
@@ -11,7 +11,8 @@
 #' running on a hosted platform like RStudio Server), provide a custom
 #' `redirect_uri` and httr2 will prompt the user to enter the code manually.
 #'
-#' Learn more about the overall OAuth authentication flow in `vignette("oauth")`.
+#' Learn more about the overall OAuth authentication flow in
+#' <https://httr2.r-lib.org/articles/oauth.html>.
 #'
 #' # Security considerations
 #'
@@ -77,7 +78,7 @@
 #'   the number of times that you need to re-authenticate at the cost of
 #'   storing access credentials on disk.
 #'
-#'   Learn more in `vignette("oauth")`
+#'   Learn more in <https://httr2.r-lib.org/articles/oauth.html>.
 #' @param cache_key If you want to cache multiple tokens per app, use this
 #'   key to disambiguate them.
 #' @returns `req_oauth_auth_code()` returns a modified HTTP [request] that will

diff --git a/R/oauth-flow-client-credentials.R b/R/oauth-flow-client-credentials.R
@@ -5,7 +5,8 @@
 #' `r rfc(6749, 4.4)`. It is used to allow the client to access resources that
 #' it controls directly, not on behalf of an user.
 #'
-#' Learn more about the overall OAuth authentication flow in `vignette("oauth")`.
+#' Learn more about the overall OAuth authentication flow in
+#' <https://httr2.r-lib.org/articles/oauth.html>.
 #'
 #' @export
 #' @family OAuth flows

diff --git a/R/oauth-flow-device.R b/R/oauth-flow-device.R
@@ -6,7 +6,8 @@
 #' ever authenticated an app on your TV, this is probably the flow you've used),
 #' but it also works well from within R.
 #'
-#' Learn more about the overall OAuth authentication flow in `vignette("oauth")`.
+#' Learn more about the overall OAuth authentication flow in
+#' <https://httr2.r-lib.org/articles/oauth.html>.
 #'
 #' @export
 #' @inheritParams oauth_flow_password

diff --git a/R/oauth-flow-jwt.R b/R/oauth-flow-jwt.R
@@ -6,7 +6,8 @@
 #' It is often used for service accounts, accounts that are used primarily in
 #' automated environments.
 #'
-#' Learn more about the overall OAuth authentication flow in `vignette("oauth")`.
+#' Learn more about the overall OAuth authentication flow in
+#' <https://httr2.r-lib.org/articles/oauth.html>.
 #'
 #' @export
 #' @family OAuth flows

diff --git a/R/oauth-flow-password.R b/R/oauth-flow-password.R
@@ -5,7 +5,8 @@
 #' defined by `r rfc(6749, 4.3)`. It allows the user to supply their password
 #' once, exchanging it for an access token that can be cached locally.
 #'
-#' Learn more about the overall OAuth authentication flow in `vignette("oauth")`.
+#' Learn more about the overall OAuth authentication flow in
+#' <https://httr2.r-lib.org/articles/oauth.html>
 #'
 #' @export
 #' @family OAuth flows

diff --git a/R/oauth-flow-refresh.R b/R/oauth-flow-refresh.R
@@ -15,7 +15,8 @@
 #' this happening a lot, it's a sign that you should be using a different flow
 #' in your automated tests.
 #'
-#' Learn more about the overall OAuth authentication flow in `vignette("oauth")`.
+#' Learn more about the overall OAuth authentication flow in
+#' <https://httr2.r-lib.org/articles/oauth.html>.
 #'
 #' @inheritParams req_oauth_auth_code
 #' @param refresh_token A refresh token. This is equivalent to a password

diff --git a/man/oauth_token_cached.Rd b/man/oauth_token_cached.Rd
diff --git a/man/req_oauth_auth_code.Rd b/man/req_oauth_auth_code.Rd
diff --git a/man/req_oauth_bearer_jwt.Rd b/man/req_oauth_bearer_jwt.Rd
diff --git a/man/req_oauth_client_credentials.Rd b/man/req_oauth_client_credentials.Rd
diff --git a/man/req_oauth_device.Rd b/man/req_oauth_device.Rd
diff --git a/man/req_oauth_password.Rd b/man/req_oauth_password.Rd
diff --git a/man/req_oauth_refresh.Rd b/man/req_oauth_refresh.Rd