redoc_spec: Redoc Index File with OpenAPI Path

In redoc: Generates 'Redoc' Documentation from an 'OpenAPI' Specification

Redoc Index File with OpenAPI Path

Description

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

Usage

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

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

## End(Not run)

redoc documentation built on Nov. 18, 2023, 1:07 a.m.