module

ActionController::OpenAPI

Constants

OPENAPI_VERSIONS = {"3.1.0", "3.0.3"}

the OpenAPI versions that can be generated, the first is the default

Instance methods

generate_open_api_docs(title : String, version : String, openapi : String = OPENAPI_VERSIONS[0], composition : Composition = Composition.default, **info)

returns a NamedTuple that represents the OpenAPI docs for the current application.

openapi is the version of the document, "3.1.0" (the default) or "3.0.3". the info hash splat accepts any of the keys from the info object

Source