validate_api_spec: Validate OpenAPI Spec

View source: R/validate_api_spec.R

validate_api_specR Documentation

Validate OpenAPI Spec

Description

Validate an OpenAPI Spec using Swagger CLI which calls Swagger Parser.

Usage

validate_api_spec(pr, verbose = TRUE)

Arguments

pr

A Plumber API

verbose

Logical that determines if a "is valid" statement is displayed. Defaults to TRUE

Details

If the api is deemed invalid, an error will be thrown.

This function is VERY \lifecycleexperimental 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)

plumber documentation built on Sept. 7, 2022, 1:05 a.m.