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

Class AddToOpenAPIDefinitionBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.smallrye.openapi.deployment.spi.AddToOpenAPIDefinitionBuildItem

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

Constructor Summary

Constructors

Constructor	Description
AddToOpenAPIDefinitionBuildItem(org.eclipse.microprofile.openapi.OASFilter filter)	Deprecated.
AddToOpenAPIDefinitionBuildItem(org.eclipse.microprofile.openapi.OASFilter filter, String documentName)

Method Summary

Modifier and Type	Method	Description
String	getDocumentName()	The name of the OpenAPI document this BuildItem should be applied to, null if it should be applied to all OpenAPI documents, or OpenAPISPIConstants.DEFAULT_DOCUMENT_NAME for the default document.
org.eclipse.microprofile.openapi.OASFilter	getOASFilter()

Methods inherited from class java.lang.Object

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

Constructor Details

AddToOpenAPIDefinitionBuildItem

@Deprecated
public AddToOpenAPIDefinitionBuildItem(org.eclipse.microprofile.openapi.OASFilter filter)

Deprecated.

Applies to the default OpenAPI document

Parameters:

filter - the filter to be applied when building the OpenAPI document

AddToOpenAPIDefinitionBuildItem

public AddToOpenAPIDefinitionBuildItem(org.eclipse.microprofile.openapi.OASFilter filter,
 String documentName)

Parameters:

filter - the filter to be applied when building the OpenAPI document

documentName - the name of the document this filter applies to, null for all documents, or OpenAPISPIConstants.DEFAULT_DOCUMENT_NAME for the default document

Method Details

getOASFilter

public org.eclipse.microprofile.openapi.OASFilter getOASFilter()

getDocumentName

public String getDocumentName()

The name of the OpenAPI document this BuildItem should be applied to, null if it should be applied to all OpenAPI documents, or OpenAPISPIConstants.DEFAULT_DOCUMENT_NAME for the default document.