List OpenAPI parameters for an API

List OpenAPI parameters for an API

Usage

bunddev_parameters(id, name = NULL, path = NULL, method = NULL)

Arguments

id

Registry id.

name

Optional parameter name to filter.

path

Optional endpoint path to filter.

method

Optional HTTP method to filter.

Value

A tibble with one row per parameter definition:

method

HTTP method in lower-case (character).

path

OpenAPI path template where the parameter applies (character).

name

Parameter name (character).

location

Parameter location such as "query" or "path" (character).

required

Whether the parameter is required (TRUE/FALSE).

description

Parameter description from the spec (character or NA).

schema_type

OpenAPI schema type, e.g. "string" (character or NA).

enum

List-column of allowed values (list of character vectors).

Details

Returns one row per parameter defined in the OpenAPI spec. Enumerations are stored in a list-column (enum). Use the filter arguments to narrow down results to a specific endpoint or parameter name.

See also

bunddev_parameters_for() for adapter-specific parameters and bunddev_parameter_values() for enum values.

Other OpenAPI: bunddev_cache_dir(), bunddev_call(), bunddev_call_tidy(), bunddev_endpoints(), bunddev_ms_to_posix(), bunddev_parameter_values(), bunddev_parameters_for(), bunddev_spec(), bunddev_spec_path(), bunddev_timestamp_to_ms()

Examples

if (FALSE) { # \dontrun{
bunddev_parameters("smard", name = "resolution")
} # }