Package io.quarkus.smallrye.openapi.deployment.spi

Class OpenApiDocumentBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.smallrye.openapi.deployment.spi.OpenApiDocumentBuildItem

public final class OpenApiDocumentBuildItem
extends io.quarkus.builder.item.MultiBuildItem

The final OpenAPI Documents as generated by the Extension.

Constructor Summary

Constructors

Constructor	Description
OpenApiDocumentBuildItem(io.smallrye.openapi.api.OpenApiDocument openApiDocument, io.smallrye.openapi.api.SmallRyeOpenAPI smallRyeOpenAPI, String documentName)

Method Summary

Modifier and Type	Method	Description
String	getDocumentName()	Returns the document name as configured using quarkus.smallrye-openapi.<document-name>, or OpenAPISPIConstants.DEFAULT_DOCUMENT_NAME for the default unnamed document.
io.smallrye.openapi.api.OpenApiDocument	getOpenApiDocument()
io.smallrye.openapi.api.SmallRyeOpenAPI	getSmallRyeOpenAPI()
boolean	isDefaultDocument()	Helper method to figure out if this build item is for the default document

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenApiDocumentBuildItem

public OpenApiDocumentBuildItem(io.smallrye.openapi.api.OpenApiDocument openApiDocument,
 io.smallrye.openapi.api.SmallRyeOpenAPI smallRyeOpenAPI,
 String documentName)

Method Details

getOpenApiDocument

public io.smallrye.openapi.api.OpenApiDocument getOpenApiDocument()

getSmallRyeOpenAPI

public io.smallrye.openapi.api.SmallRyeOpenAPI getSmallRyeOpenAPI()

getDocumentName

public String getDocumentName()

Returns the document name as configured using quarkus.smallrye-openapi.<document-name>, or OpenAPISPIConstants.DEFAULT_DOCUMENT_NAME for the default unnamed document.

isDefaultDocument

public boolean isDefaultDocument()

Helper method to figure out if this build item is for the default document