Releases: posit-dev/connectapi
Releases · posit-dev/connectapi
connectapi 0.9.0
- New
set_integrations()function to set the OAuth integration
associations for a content item. (#414) - New
get_integration()function to retrieve details of a specific OAuth integration
from a Connect server. (#431) get_integrations()can now be passed aContentclass object to retrieve a
list of integrations associated with that piece of content. (#432)- New functions allow you to manage the OAuth integrations on your Connect
server:create_integration(),update_integration()and
delete_integration(). (#434) - New
search_content()function which lets you search and filter content items
on the Connect server. (#272, #447) - New
lock_content()andunlock_content()functions for locking and unlocking
content items. (#453) - Updated git-backed deployment functions to use v1 APIs (#459)
connectapi 0.8.0
Breaking changes
get_apps()has been removed in favor ofget_content().
dashboard_url_chr()has been removed. (#415)
New features
- New
get_usage()function returns content usage data from Connect'sGET v1/instrumentation/content/hitsendpoint on Connect v2025.04.0 and higher.
(#390) - The
get_oauth_credentials()andconnect()functions have a newaudience
parameter. On Connect v2025.07.0 and higher, pass the GUID of an integration
to this parameter to specify which OAuth integration you wish to use. (#423) - New
get_integrations()function lists all OAuth integrations available on the
Connect server from theGET v1/oauth/integrationsendpoint on Connect v2024.12.0
and higher. (#413)
Enhancements and fixes
get_groups()now paginates through all results when aprefixis provided,
if the Connect server API version supports pagination. (#328)- Timestamps from the Connect server are now displayed in your local time zone,
rather than in UTC. (#400) get_content()now includes vanity URLs in the returned data frame on Connect
v2024.06.0 and later. (#398)- Removed unnecessary null check with default from
get_oauth_credentials()and
get_oauth_content_credentials()functions forrequested_token_typeparameter
that was causing issues with Connect < 2025.03.0. (#407) Connect$content()now respects theincludeargument when aguidis
provided. (#411)
connectapi 0.7.0
New features
- New
get_packages()function to get a data frame of all packages on a Connect
server. (#374) - New
get_content_packages()function to get a data frame of all package
dependencies for a content item. (#374) - New
get_aws_credentials()andget_aws_content_credentials()functions for interacting with Connect's
/v1/oauth/integrations/credentialsendpoint. This endpoint allows content running on Posit Connect to
obtain temporary AWS credentials for an AWS IAM role specified by the system administrator.
(#380).
connectapi 0.6.0
New features
- New
get_log()function which lets you get the log for a given job.
(#341) - New
get_job_list()function returns a list of jobs for a content item.
(#341) - New
tokenparameter toconnect()function allows you to create a Connect
client with permissions scoped to the content visitor when running on a Connect
server. (#362)
Enhancements and fixes
swap_vanity_urls()can correctly perform a swap involving a content item
with no vanity URL. (#360)swap_vanity_urls()handles permissions errors gracefully, attempting to roll
back any changes made. (#360)get_jobs()andget_job_list()return objects containcontent_idand
content_guidfields. These contain the same values asapp_idand
app_guid, which are deprecated and will be removed in a future update.
Newly deprecated
get_job()(singular) is now deprecated, its functionality taken care of by
other functions, includingget_log().swap_vanity_url(old, new)has been deprecated and renamed to
swap_vanity_urls(content_a, content_b).
connectapi 0.5.0
Breaking changes
get_jobs()now uses the publicv1jobs endpoint when available, and as a
result, the data returned by this function has changed. In particular, the
finalizedcolumn is no longer present, replaced bystatus.status == 0
corresponds toisFALSE(finalized). See?get_jobs()for more details about
the new return data format. (#340)
New features
get_users()has new parameters for filtering users byaccount_statusand
user_role. This allows you to find, for example, all licensed users on a
Connect server. (#311)- The new
get_group_content()function lets you view the content that groups
have permission to access. (#334) - The new
terminate_jobs()function lets you terminate processes associated
with a content item. (#332) - The new
get_vanity_urls()function lets you get all vanity URLs on a Connect
server (#333) - Added new
get_oauth_content_credentials()function for interacting with
Connect's/v1/oauth/integrations/credentialsendpoint. This endpoint allows
content running on Posit Connect to obtain an OAuth access token using the
client credentials flow. (#344).
Minor improvements and fixes
- The task returned by
content_render()now has the expectedtask_id
parameter and is able to be polled. (#338)
connectapi 0.4.0
New features
- New functions
set_thumbnail(),get_thumbnail(),delete_thumbnail()and
has_thumbnail()let you interact with content thumbnails, replacing older
*_image()functions. (#294, #304) groups_create_remote()now has anexactparameter. Settingexactcauses
the function to consider only exact group name matches when searching for
remote groups and checking for existing local groups. (#216)- New functions to let you view and delete runtime caches on a Connect server:
get_runtime_caches(),delete_runtime_cache()(#312) - New
get_runtimes()lets you view available runtimes and versions on a
Connect server. (#311)
Lifecycle changes
Newly deprecated
set_image_path(),set_image_url(), andset_image_webshot()have been
deprecated and will be removed in a future update. They have been replaced by
set_thumbnail(), which works both with local file paths and remote URLs to
images. Likewise,has_image()anddelete_image()have been deprecated in
favor ofhas_thumbnail()anddelete_thumbnail(). (#294, #304)Connect$server_settings_r()has been deprecated in favor of
get_runtimes(client, "r"). (#311)
Minor improvements and fixes
- Upgrade
pkgdownto bootstrap 5 to enable search (@fh-mthomson, #275) - The
get_timezones()function now uses thev1/timezonesendpoint if
available. (#300) connect$DELETE()now respects theparserargument rather than always using
NULL.get_groups()no longer hangs when a searchprefixis provided. (#319)
v0.3.0
Breaking changes
GET_URL(),GET_RESULT(), andGET_RESULT_URL()have been eliminated in
favor ofGET()(#274).- The
.empty_objectargument has been removed fromPUT/PATCH/POST(#274).
New features
- New
content_render()andcontent_restart()functions.content_render()
allows you to programmatically re-render content such as Quarto and R Markdown
reports and Jupyter notebooks, optionally passing in avariant_keyto render
a specific variant of parameterized content.content_restart()lets you
restart interactive content, such as Shiny applications, APIs, or dashboards
(#283, #289) - New
get_oauth_credentials()function for interacting with Connect's
/v1/oauth/integrations/credentialsendpoint. This endpoint allows content
running on Posit Connect to obtain the content viewer's OAuth access token
(#297).
Minor improvements and fixes
- Timestamps with non-zero offsets received from Connect no longer parse as
NA
(#290). - Timestamps sent to Connect are now correctly converted to UTC, instead of
simply being labeled as GMT (#291). - Functions to render variants and email reports now contain the request
query that Connect expects (#277). - HTTP verb functions can take any URL, not just one relative to API root, and
can optionally return thehttr_responseobject (#274).
What's Changed
- refactor: consolidate HTTP request methods by @nealrichardson in #274
- Prune variant render and sender API requests by @nealrichardson in #277
- Remove unnecessary dev dependency from pkgdown.yaml by @nealrichardson in #282
- Deprecate get_variant_default by @nealrichardson in #284
- chore: update renv environment and infra by @toph-allen in #285
- chore: update DESCRIPTION with new authors & maintainer by @toph-allen in #286
- feat:
content_render()andcontent_restart()implementations by @toph-allen in #283 - fix: parsing time stamps with time zone offsets containing colons by @toph-allen in #291
- Add initial oauth integration credential exchange impl by @dbkegley in #292
- feat:
content_render()can take avariant_keyargument to render non-default variants. by @toph-allen in #289
New Contributors
- @toph-allen made their first contribution in #285
- @dbkegley made their first contribution in #292
Full Changelog: v0.2.0...v0.3.0
v0.2.0
Full Changelog: v0.1.3.1...v0.2.0
New Contributors
- @aronatkins made their first contribution in #190
- @nealrichardson made their first contribution in #206
- @olivroy made their first contribution in #212
- @cormach made their first contribution in #203
- @csgillespie made their first contribution in #179
First alpha release
This is an alpha release with currently minimal testing / validation.