validate_api_spec function

Validate OpenAPI Spec

Validate OpenAPI Spec

Validate an OpenAPI Spec using list("@redocly/cli").

validate_api_spec( pr, ..., ruleset = c("minimal", "recommended", "recommended-strict"), verbose = TRUE )

Arguments

  • pr: A Plumber API
  • ...: Ignored
  • ruleset: Character that determines the ruleset to use for validation. Can be one of "minimal", "recommended", or "recommended-strict". Defaults to "minimal". See c("list("@redocly/cli")", " options") for more details.
  • verbose: Logical that determines if a "is valid" statement is displayed. Defaults to TRUE

Details

If any warning or error is presented, an error will be thrown.

This function is and may be altered, changed, or removed in the future.

Examples

## Not run: pr <- plumb_api("plumber", "01-append") validate_api_spec(pr) ## End(Not run)
  • Maintainer: Barret Schloerke
  • License: MIT + file LICENSE
  • Last published: 2025-02-19