Package io.smallrye.openapi.gradleplugin

Class SmallryeOpenApiExtension

java.lang.Object

io.smallrye.openapi.gradleplugin.SmallryeOpenApiExtension

All Implemented Interfaces:

SmallryeOpenApiProperties

public class SmallryeOpenApiExtension
extends Object

Gradle extension objects, which allows Gradle project wide defaults, or just easier configuration in Gradle build scripts.

See SmallryeOpenApiProperties for information about the individual options.

Constructor Summary

Constructors

Constructor	Description
SmallryeOpenApiExtension(org.gradle.api.model.ObjectFactory objects)

Method Summary

Modifier and Type	Method	Description
org.gradle.api.provider.Property<Boolean>	getApplicationPathDisable()	Disable scanning of the javax.ws.rs.Path (and jakarta.ws.rs.Path) for the application path.
org.gradle.api.file.RegularFileProperty	getConfigProperties()	Load any properties from a file.
org.gradle.api.provider.Property<String>	getCustomSchemaRegistryClass()	Fully qualified name of a CustomSchemaRegistry, which can be used to specify a custom schema for a type.
org.gradle.api.provider.Property<io.smallrye.openapi.api.OpenApiConfig.DuplicateOperationIdBehavior>	getDuplicateOperationIdBehavior()	Configuration property to specify what should happen if duplicate operationIds occur.
org.gradle.api.provider.Property<String>	getEncoding()	Output encoding for openapi document.
org.gradle.api.provider.Property<String>	getFilter()	Configuration property to specify the fully qualified name of the OASFilter implementation.
org.gradle.api.provider.Property<String>	getInfoContactEmail()
org.gradle.api.provider.Property<String>	getInfoContactName()
org.gradle.api.provider.Property<String>	getInfoContactUrl()
org.gradle.api.provider.Property<String>	getInfoDescription()
org.gradle.api.provider.Property<String>	getInfoLicenseName()
org.gradle.api.provider.Property<String>	getInfoLicenseUrl()
org.gradle.api.provider.Property<String>	getInfoSummary()
org.gradle.api.provider.Property<String>	getInfoTermsOfService()
org.gradle.api.provider.Property<String>	getInfoTitle()
org.gradle.api.provider.Property<String>	getInfoVersion()
org.gradle.api.provider.Property<String>	getModelReader()	Configuration property to specify the fully qualified name of the OASModelReader implementation.
org.gradle.api.provider.Property<String>	getOpenApiVersion()	To specify a custom OpenAPI version.
org.gradle.api.provider.Property<io.smallrye.openapi.api.OpenApiConfig.OperationIdStrategy>	getOperationIdStrategy()	Configuration property to specify how the operationid is generated.
org.gradle.api.provider.MapProperty<String,String>	getOperationServers()	Prefix of the configuration property to specify an alternative list of servers to service an operation.
org.gradle.api.provider.Property<String>	getOutputFileTypeFilter()	Filter the type of files that will be generated, allowed values are ALL, YAML and JSON.
org.gradle.api.provider.MapProperty<String,String>	getPathServers()	Prefix of the configuration property to specify an alternative list of servers to service all operations in a path
org.gradle.api.provider.ListProperty<String>	getScanClasses()	Configuration property to specify the list of classes to scan.
org.gradle.api.provider.Property<Boolean>	getScanDependenciesDisable()	Disable scanning the project's dependencies for OpenAPI model classes too
org.gradle.api.provider.Property<Boolean>	getScanDisabled()	Configuration property to disable annotation scanning.
org.gradle.api.provider.ListProperty<String>	getScanExcludeClasses()	Configuration property to specify the list of classes to exclude from scans.
org.gradle.api.provider.ListProperty<String>	getScanExcludePackages()	Configuration property to specify the list of packages to exclude from scans.
org.gradle.api.provider.ListProperty<String>	getScanExcludeProfiles()	Profiles which explicitly exclude operations.
org.gradle.api.provider.ListProperty<String>	getScanPackages()	Configuration property to specify the list of packages to scan.
org.gradle.api.provider.ListProperty<String>	getScanProfiles()	Profiles which explicitly include operations.
org.gradle.api.provider.MapProperty<String,String>	getScanResourceClasses()
org.gradle.api.provider.Property<String>	getSchemaFilename()	Filename of the schema Defaults to openapi.
org.gradle.api.provider.ListProperty<String>	getServers()	Configuration property to specify the list of global servers that provide connectivity information.

Methods inherited from class java.lang.Object

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

Constructor Details

SmallryeOpenApiExtension

@Inject
public SmallryeOpenApiExtension(org.gradle.api.model.ObjectFactory objects)

Method Details

getConfigProperties

public org.gradle.api.file.RegularFileProperty getConfigProperties()

Description copied from interface: SmallryeOpenApiProperties

Load any properties from a file. This file is loaded first, and gets overwritten by explicitly set properties in the maven configuration. Example `${basedir}/src/main/resources/application.properties`.

Specified by:

getConfigProperties in interface SmallryeOpenApiProperties

getSchemaFilename

public org.gradle.api.provider.Property<String> getSchemaFilename()

Description copied from interface: SmallryeOpenApiProperties

Filename of the schema Defaults to openapi. So the files created will be openapi.yaml and openapi.json.

Specified by:

getSchemaFilename in interface SmallryeOpenApiProperties

getScanDependenciesDisable

public org.gradle.api.provider.Property<Boolean> getScanDependenciesDisable()

Description copied from interface: SmallryeOpenApiProperties

Disable scanning the project's dependencies for OpenAPI model classes too

Specified by:

getScanDependenciesDisable in interface SmallryeOpenApiProperties

getModelReader

public org.gradle.api.provider.Property<String> getModelReader()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify the fully qualified name of the OASModelReader implementation.

Specified by:

getModelReader in interface SmallryeOpenApiProperties

getFilter

public org.gradle.api.provider.Property<String> getFilter()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify the fully qualified name of the OASFilter implementation.

Specified by:

getFilter in interface SmallryeOpenApiProperties

getScanDisabled

public org.gradle.api.provider.Property<Boolean> getScanDisabled()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to disable annotation scanning.

Specified by:

getScanDisabled in interface SmallryeOpenApiProperties

getScanPackages

public org.gradle.api.provider.ListProperty<String> getScanPackages()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify the list of packages to scan.

Specified by:

getScanPackages in interface SmallryeOpenApiProperties

getScanClasses

public org.gradle.api.provider.ListProperty<String> getScanClasses()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify the list of classes to scan.

Specified by:

getScanClasses in interface SmallryeOpenApiProperties

getScanExcludePackages

public org.gradle.api.provider.ListProperty<String> getScanExcludePackages()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify the list of packages to exclude from scans.

Specified by:

getScanExcludePackages in interface SmallryeOpenApiProperties

getScanExcludeClasses

public org.gradle.api.provider.ListProperty<String> getScanExcludeClasses()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify the list of classes to exclude from scans.

Specified by:

getScanExcludeClasses in interface SmallryeOpenApiProperties

getServers

public org.gradle.api.provider.ListProperty<String> getServers()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify the list of global servers that provide connectivity information.

Specified by:

getServers in interface SmallryeOpenApiProperties

getPathServers

public org.gradle.api.provider.MapProperty<String,String> getPathServers()

Description copied from interface: SmallryeOpenApiProperties

Prefix of the configuration property to specify an alternative list of servers to service all operations in a path

Specified by:

getPathServers in interface SmallryeOpenApiProperties

getOperationServers

public org.gradle.api.provider.MapProperty<String,String> getOperationServers()

Description copied from interface: SmallryeOpenApiProperties

Prefix of the configuration property to specify an alternative list of servers to service an operation.

Specified by:

getOperationServers in interface SmallryeOpenApiProperties

getCustomSchemaRegistryClass

public org.gradle.api.provider.Property<String> getCustomSchemaRegistryClass()

Description copied from interface: SmallryeOpenApiProperties

Fully qualified name of a CustomSchemaRegistry, which can be used to specify a custom schema for a type.

Specified by:

getCustomSchemaRegistryClass in interface SmallryeOpenApiProperties

getApplicationPathDisable

public org.gradle.api.provider.Property<Boolean> getApplicationPathDisable()

Description copied from interface: SmallryeOpenApiProperties

Disable scanning of the javax.ws.rs.Path (and jakarta.ws.rs.Path) for the application path.

Specified by:

getApplicationPathDisable in interface SmallryeOpenApiProperties

getOpenApiVersion

public org.gradle.api.provider.Property<String> getOpenApiVersion()

Description copied from interface: SmallryeOpenApiProperties

To specify a custom OpenAPI version.

Specified by:

getOpenApiVersion in interface SmallryeOpenApiProperties

getInfoTitle

public org.gradle.api.provider.Property<String> getInfoTitle()

Specified by:

getInfoTitle in interface SmallryeOpenApiProperties

getInfoVersion

public org.gradle.api.provider.Property<String> getInfoVersion()

Specified by:

getInfoVersion in interface SmallryeOpenApiProperties

getInfoDescription

public org.gradle.api.provider.Property<String> getInfoDescription()

Specified by:

getInfoDescription in interface SmallryeOpenApiProperties

getInfoSummary

public org.gradle.api.provider.Property<String> getInfoSummary()

Specified by:

getInfoSummary in interface SmallryeOpenApiProperties

getInfoTermsOfService

public org.gradle.api.provider.Property<String> getInfoTermsOfService()

Specified by:

getInfoTermsOfService in interface SmallryeOpenApiProperties

getInfoContactEmail

public org.gradle.api.provider.Property<String> getInfoContactEmail()

Specified by:

getInfoContactEmail in interface SmallryeOpenApiProperties

getInfoContactName

public org.gradle.api.provider.Property<String> getInfoContactName()

Specified by:

getInfoContactName in interface SmallryeOpenApiProperties

getInfoContactUrl

public org.gradle.api.provider.Property<String> getInfoContactUrl()

Specified by:

getInfoContactUrl in interface SmallryeOpenApiProperties

getInfoLicenseName

public org.gradle.api.provider.Property<String> getInfoLicenseName()

Specified by:

getInfoLicenseName in interface SmallryeOpenApiProperties

getInfoLicenseUrl

public org.gradle.api.provider.Property<String> getInfoLicenseUrl()

Specified by:

getInfoLicenseUrl in interface SmallryeOpenApiProperties

getOperationIdStrategy

public org.gradle.api.provider.Property<io.smallrye.openapi.api.OpenApiConfig.OperationIdStrategy> getOperationIdStrategy()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify how the operationid is generated. Can be used to minimize risk of collisions between operations.

Specified by:

getOperationIdStrategy in interface SmallryeOpenApiProperties

getDuplicateOperationIdBehavior

public org.gradle.api.provider.Property<io.smallrye.openapi.api.OpenApiConfig.DuplicateOperationIdBehavior> getDuplicateOperationIdBehavior()

Description copied from interface: SmallryeOpenApiProperties

Configuration property to specify what should happen if duplicate operationIds occur.

Specified by:

getDuplicateOperationIdBehavior in interface SmallryeOpenApiProperties

getScanProfiles

public org.gradle.api.provider.ListProperty<String> getScanProfiles()

Description copied from interface: SmallryeOpenApiProperties

Profiles which explicitly include operations. Any operation without a matching profile is excluded.

Specified by:

getScanProfiles in interface SmallryeOpenApiProperties

getScanExcludeProfiles

public org.gradle.api.provider.ListProperty<String> getScanExcludeProfiles()

Description copied from interface: SmallryeOpenApiProperties

Profiles which explicitly exclude operations. Any operation without a matching profile is included.

Specified by:

getScanExcludeProfiles in interface SmallryeOpenApiProperties

getScanResourceClasses

public org.gradle.api.provider.MapProperty<String,String> getScanResourceClasses()

Specified by:

getScanResourceClasses in interface SmallryeOpenApiProperties

getOutputFileTypeFilter

public org.gradle.api.provider.Property<String> getOutputFileTypeFilter()

Description copied from interface: SmallryeOpenApiProperties

Filter the type of files that will be generated, allowed values are ALL, YAML and JSON.

Specified by:

getOutputFileTypeFilter in interface SmallryeOpenApiProperties

getEncoding

public org.gradle.api.provider.Property<String> getEncoding()

Description copied from interface: SmallryeOpenApiProperties

Output encoding for openapi document.

Specified by:

getEncoding in interface SmallryeOpenApiProperties