Uses of Class
com.kingsrook.qqq.openapi.model.OpenAPI

Packages that use OpenAPI

Package	Description
com.kingsrook.qqq.api.model.actions
com.kingsrook.qqq.middleware.javalin.specs
com.kingsrook.qqq.middleware.javalin.tools	This tools path - is for non-production code - rather, development and CI/CD tools.
com.kingsrook.qqq.openapi.model	The POJOs in this package represent a model of an OpenAPI spec file.

Uses of OpenAPI in com.kingsrook.qqq.api.model.actions

Methods in com.kingsrook.qqq.api.model.actions that return OpenAPI

Modifier and Type	Method	Description
OpenAPI	GenerateOpenApiSpecOutput.getOpenAPI()	Getter for openAPI

Methods in com.kingsrook.qqq.api.model.actions with parameters of type OpenAPI

Modifier and Type	Method	Description
void	GenerateOpenApiSpecOutput.setOpenAPI(OpenAPI openAPI)	Setter for openAPI
GenerateOpenApiSpecOutput	GenerateOpenApiSpecOutput.withOpenAPI(OpenAPI openAPI)	Fluent setter for openAPI

Uses of OpenAPI in com.kingsrook.qqq.middleware.javalin.specs

Methods in com.kingsrook.qqq.middleware.javalin.specs that return OpenAPI

Modifier and Type	Method	Description
OpenAPI	AbstractMiddlewareVersion.generateExtensionOpenAPIModel(String basePath, MiddlewareSpecExtension extension)	The OpenAPI document of one extension alone (its paths and the component schemas its specs define) - what a qbit commits and contract-tests.
OpenAPI	AbstractMiddlewareVersion.generateOpenAPIModel(String basePath)

Uses of OpenAPI in com.kingsrook.qqq.middleware.javalin.tools

Methods in com.kingsrook.qqq.middleware.javalin.tools with parameters of type OpenAPI

Modifier and Type	Method	Description
static String	UiApiContract.toYaml(OpenAPI openAPI)	Serialize an OpenAPI model the way the committed files are written.

Uses of OpenAPI in com.kingsrook.qqq.openapi.model

Methods in com.kingsrook.qqq.openapi.model that return OpenAPI

Modifier and Type	Method	Description
OpenAPI	OpenAPI.withComponents(Components components)	Fluent setter for components
OpenAPI	OpenAPI.withExternalDocs(ExternalDocs externalDocs)	Fluent setter for externalDocs
OpenAPI	OpenAPI.withInfo(Info info)	Fluent setter for info
OpenAPI	OpenAPI.withPaths(Map<String,Path> paths)	Fluent setter for paths
OpenAPI	OpenAPI.withServers(List<Server> servers)	Fluent setter for servers
OpenAPI	OpenAPI.withTags(List<Tag> tags)	Fluent setter for tags
OpenAPI	OpenAPI.withVersion(String version)	Fluent setter for version