Skip to content

Commit 86617bb

Browse files
toph-allentoph-allen
committed
update documentation and tests
1 parent 20f0c35 commit 86617bb

File tree

6 files changed

+58
-35
lines changed

6 files changed

+58
-35
lines changed

‎R/integrations.R‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,8 +346,13 @@ get_associations <- function(x) {
346346
#' @description
347347
#' Creates a new OAuth integration on the Posit Connect server. OAuth integrations
348348
#' allow content to access external resources using OAuth credentials.
349+
#'
349350
#' You must have administrator privileges to perform this action.
350351
#'
352+
#' See the Posit Connect documentation on
353+
#' [OAuth integrations](https://docs.posit.co/connect/admin/integrations/oauth-integrations/) for
354+
#' more information.
355+
#'
351356
#' @param client A `Connect` R6 client object.
352357
#' @param name A descriptive name to identify the integration.
353358
#' @param description Optional, default `NULL.` A brief description of the integration.
@@ -423,8 +428,13 @@ create_integration <- function(
423428
#' @description
424429
#' Updates an existing OAuth integration. All fields except `integration` are optional,
425430
#' and are unchanged if not provided.
431+
#'
426432
#' You must have administrator privileges to perform this action.
427433
#'
434+
#' See the Posit Connect documentation on
435+
#' [OAuth integrations](https://docs.posit.co/connect/admin/integrations/oauth-integrations/) for
436+
#' more information.
437+
#'
428438
#' @param integration A `connect_integration` object (as returned by [get_integrations()],
429439
#' [get_integration()], or [create_integration()]).
430440
#' @param name A new name for the integration.
@@ -495,8 +505,13 @@ update_integration <- function(
495505
#' @description
496506
#' Deletes an OAuth integration from the Posit Connect server. This permanently
497507
#' removes the integration and any associated content associations.
508+
#'
498509
#' You must have administrator privileges to perform this action.
499510
#'
511+
#' See the Posit Connect documentation on
512+
#' [OAuth integrations](https://docs.posit.co/connect/admin/integrations/oauth-integrations/) for
513+
#' more information.
514+
#'
500515
#' @param integration A `connect_integration` object (as returned by [get_integrations()],
501516
#' [get_integration()], or [create_integration()]).
502517
#'

‎man/create_integration.Rd‎

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/delete_integration.Rd‎

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/update_integration.Rd‎

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/testthat/2025.07.0/__api__/v1/oauth/integrations-7ae937-POST.R‎

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,14 @@
1-
structure(list(url = "__api__/v1/oauth/integrations", status_code = 400L,
2-
headers = structure(list(date = "Wed, 06 Aug 2025 23:06:37 GMT",
3-
`content-type` = "application/json", `content-length` = "103",
4-
`set-cookie` = "AWSALB=9mN5qlJwx5BLvdRYWDHEJjg7DOZzKW/EG88UrtYfTluTTzuV6cGdvXdvesJWTq3QmWoKGmO6CjIwib30wDgHv7xPqaXHB3OQRrXs9tMhZtst8L+/YCrnJdpmAljL; Expires=Wed, 13 Aug 2025 23:06:37 GMT; Path=/",
5-
`set-cookie` = "AWSALBCORS=9mN5qlJwx5BLvdRYWDHEJjg7DOZzKW/EG88UrtYfTluTTzuV6cGdvXdvesJWTq3QmWoKGmO6CjIwib30wDgHv7xPqaXHB3OQRrXs9tMhZtst8L+/YCrnJdpmAljL; Expires=Wed, 13 Aug 2025 23:06:37 GMT; Path=/; SameSite=None; Secure",
6-
`cache-control` = "no-cache, no-store, must-revalidate",
7-
expires = "0", pragma = "no-cache", server = "Posit Connect v2025.08.0-dev+23-gc5b3d6bdf1",
8-
`x-content-type-options` = "nosniff", `x-correlation-id` = "98227671-62fe-495d-ba88-a2c48c45ca59"), class = c("insensitive",
9-
"list")), all_headers = list(list(status = 400L, version = "HTTP/2",
10-
headers = structure(list(date = "Wed, 06 Aug 2025 23:06:37 GMT",
11-
`content-type` = "application/json", `content-length` = "103",
12-
`set-cookie` = "AWSALB=9mN5qlJwx5BLvdRYWDHEJjg7DOZzKW/EG88UrtYfTluTTzuV6cGdvXdvesJWTq3QmWoKGmO6CjIwib30wDgHv7xPqaXHB3OQRrXs9tMhZtst8L+/YCrnJdpmAljL; Expires=Wed, 13 Aug 2025 23:06:37 GMT; Path=/",
13-
`set-cookie` = "AWSALBCORS=9mN5qlJwx5BLvdRYWDHEJjg7DOZzKW/EG88UrtYfTluTTzuV6cGdvXdvesJWTq3QmWoKGmO6CjIwib30wDgHv7xPqaXHB3OQRrXs9tMhZtst8L+/YCrnJdpmAljL; Expires=Wed, 13 Aug 2025 23:06:37 GMT; Path=/; SameSite=None; Secure",
14-
`cache-control` = "no-cache, no-store, must-revalidate",
15-
expires = "0", pragma = "no-cache", server = "Posit Connect v2025.08.0-dev+23-gc5b3d6bdf1",
16-
`x-content-type-options` = "nosniff", `x-correlation-id` = "98227671-62fe-495d-ba88-a2c48c45ca59"), class = c("insensitive",
17-
"list")))), cookies = structure(list(domain = c("dogfood.team.pct.posit.it",
18-
"dogfood.team.pct.posit.it"), flag = c(FALSE, FALSE), path = c("/",
19-
"/"), secure = c(FALSE, TRUE), expiration = structure(c(1755126397,
20-
1755126397), class = c("POSIXct", "POSIXt")), name = c("AWSALB",
21-
"AWSALBCORS"), value = c("9mN5qlJwx5BLvdRYWDHEJjg7DOZzKW/EG88UrtYfTluTTzuV6cGdvXdvesJWTq3QmWoKGmO6CjIwib30wDgHv7xPqaXHB3OQRrXs9tMhZtst8L+/YCrnJdpmAljL",
22-
"9mN5qlJwx5BLvdRYWDHEJjg7DOZzKW/EG88UrtYfTluTTzuV6cGdvXdvesJWTq3QmWoKGmO6CjIwib30wDgHv7xPqaXHB3OQRrXs9tMhZtst8L+/YCrnJdpmAljL"
23-
)), row.names = c(NA, -2L), class = "data.frame"), content = charToRaw("{\"code\":228,\"error\":\"The config key max_role must be one of (Viewer, Publisher, Admin)\",\"payload\":null}"),
24-
date = structure(1754521597, class = c("POSIXct", "POSIXt"
25-
), tzone = "GMT"), times = c(redirect = 0, namelookup = 0,
26-
connect = 0, pretransfer = 0.000177, starttransfer = 0.132928,
27-
total = 0.133044)), class = "response")
1+
structure(
2+
list(
3+
url = "__api__/v1/oauth/integrations",
4+
status_code = 400L,
5+
headers = structure(
6+
list(`content-type` = "application/json"),
7+
class = c("insensitive", "list")
8+
),
9+
content = charToRaw(
10+
"{\"code\":228,\"error\":\"The config key max_role must be one of (Viewer, Publisher, Admin)\",\"payload\":null}"
11+
)
12+
),
13+
class = "response"
14+
)

‎tests/testthat/2025.07.0/__api__/v1/oauth/integrations/60586f1c-b90ada-PATCH.R‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
structure(list(url = "__api__/v1/oauth/integrations/60586f1c",
2-
status_code = 400L, headers = structure(list(
3-
`content-type` = "application/json", `content-length` = "103",
4-
)), row.names = c(NA, -2L), class = "data.frame"), content = charToRaw("{\"code\":228,\"error\":\"The config key max_role must be one of (Viewer, Publisher, Admin)\",\"payload\":null}"),
5-
date = structure(1754521611, class = c("POSIXct", "POSIXt"
6-
), tzone = "GMT"), times = c(redirect = 0, namelookup = 0,
7-
connect = 0, pretransfer = 0.000134, starttransfer = 0.13414,
8-
total = 0.134243)), class = "response")
1+
structure(
2+
list(
3+
url = "__api__/v1/oauth/integrations/60586f1c",
4+
status_code = 400L,
5+
headers = structure(
6+
list(`content-type` = "application/json"),
7+
class = c("insensitive", "list")
8+
),
9+
content = charToRaw(
10+
"{\"code\":228,\"error\":\"The config key max_role must be one of (Viewer, Publisher, Admin)\",\"payload\":null}"
11+
)
12+
),
13+
class = "response"
14+
)

0 commit comments

Comments
 (0)