Retrieve endpoints for a given API

Retrieve endpoints for a given API

List OpenAPI endpoints for an API

Usage

bunddev_endpoints(id)

bunddev_endpoints(id)

Arguments

id

Registry id.

Value

A tibble with columns method, path, operation_id, summary

A tibble with one row per OpenAPI operation:

method

HTTP method in lower-case, e.g. "get" (character).

path

OpenAPI path template, e.g. "/v1/items/{id}" (character).

operation_id

OpenAPI operationId (character or NA).

summary

Operation summary from the spec (character or NA).

Details

Parses the cached OpenAPI spec and returns every available path + method with its operationId and summary, if provided.

See also

bunddev_parameters() to inspect parameters and bunddev_spec() to access the full spec.

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

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

Examples

if (FALSE) { # \dontrun{
bunddev_endpoints("autobahn")
} # }