Redoc Index File with OpenAPI Path — redoc

Produces the content for a index.html file that will attempt to access a provided OpenAPI Specification URL.

redoc_spec(spec_url = "https://redocly.github.io/redoc/openapi.yaml", ...)

Arguments

spec_url: Url to an OpenAPI specification
...: Additional options for Redoc. See https://github.com/Redocly/redoc#redoc-options-object

Value

large string containing the contents of redoc_index() with the appropriate specification path changed to the spec_url value.

Examples

if (FALSE) { # \dontrun{
if (interactive()) {
  redoc_spec("https://docs.docker.com/engine/api/v1.38.yaml",
             scrollYOffset = 250,
             disableSearch = TRUE)
}
} # }