A policy to parse a response body as JSON

Create a reusable tidy policy that applies resp_tidy_json().

Usage

tidy_policy_json(spec = NULL, unspecified = "list", subset_path = NULL)

Arguments

spec

(tspec or NULL) A specification used by tibblify::tibblify() to parse the extracted body of resp. When spec is NULL (the default), tibblify::tibblify() will attempt to guess a spec.

unspecified

(length-1 character) A string that describes what happens if the extracted body of resp contains fields that are not specified in spec. While tibblify::tibblify() defaults to NULL for this value, we set it to list so that the body will still parse when resp contains extra data without throwing errors.

subset_path

(character) An optional vector indicating the path to the "real" object within the body of resp. For example, many APIs return a body with information about the status of the response, cache information, perhaps pagination information, and then the actual data in a field such as data. If the desired part of the response body is in data$objects, the value of this argument should be c("data", "object").

Value

A list with class "nectar_tidy_policy" and elements tidy_fn and tidy_args.

See also

Other opinionated response parsers: req_tidy_policy(), resp_tidy(), resp_tidy_json(), resp_tidy_unknown(), tidy_policy_body_auto(), tidy_policy_prepare(), tidy_policy_unknown()

Examples

tidy_policy_json(subset_path = "data")
#> $tidy_fn
#> function (resp, spec = NULL, unspecified = "list", subset_path = NULL) 
#> {
#>     rlang::check_installed("tibblify", "to tidy the JSON response body.")
#>     subset_path <- stbl::to_chr(subset_path)
#>     result <- httr2::resp_body_json(resp)
#>     result <- purrr::pluck(result, !!!subset_path)
#>     if (length(result)) {
#>         return(tibblify::tibblify(result, spec = spec, unspecified = unspecified))
#>     }
#>     return(NULL)
#> }
#> <bytecode: 0x55d53faea7c0>
#> <environment: namespace:nectar>
#> 
#> $tidy_args
#> $tidy_args$spec
#> NULL
#> 
#> $tidy_args$unspecified
#> [1] "list"
#> 
#> $tidy_args$subset_path
#> [1] "data"
#> 
#> 
#> attr(,"class")
#> [1] "nectar_tidy_policy"