Package io.smallrye.openapi.gradleplugin

Class SmallryeOpenApiTask

  • All Implemented Interfaces:
    SmallryeOpenApiProperties, java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
    @CacheableTask
public class SmallryeOpenApiTask
extends org.gradle.api.DefaultTask
implements SmallryeOpenApiProperties
    Schema generation task implementation.

    See SmallryeOpenApiProperties for information about the individual options.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gradle.api.Task

        org.gradle.api.Task.Namer

    • Field Summary

      • Fields inherited from interface org.gradle.api.Task

        TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

    • Constructor Summary

      Constructors 
      Constructor Description
      SmallryeOpenApiTask​(SmallryeOpenApiExtension ext, org.gradle.api.model.ObjectFactory objects, org.gradle.api.file.ProjectLayout layout, org.gradle.api.NamedDomainObjectProvider<org.gradle.api.artifacts.Configuration> configProvider, org.gradle.api.file.FileCollection resourcesSrcDirs, org.gradle.api.file.FileCollection classesDirs)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void generate()  
      org.gradle.api.provider.Property<java.lang.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<java.lang.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<java.lang.String> getEncoding()
      Output encoding for openapi document.
      org.gradle.api.provider.Property<java.lang.String> getFilter()
      Configuration property to specify the fully qualified name of the OASFilter implementation.
      org.gradle.api.provider.Property<java.lang.String> getInfoContactEmail()  
      org.gradle.api.provider.Property<java.lang.String> getInfoContactName()  
      org.gradle.api.provider.Property<java.lang.String> getInfoContactUrl()  
      org.gradle.api.provider.Property<java.lang.String> getInfoDescription()  
      org.gradle.api.provider.Property<java.lang.String> getInfoLicenseName()  
      org.gradle.api.provider.Property<java.lang.String> getInfoLicenseUrl()  
      org.gradle.api.provider.Property<java.lang.String> getInfoTermsOfService()  
      org.gradle.api.provider.Property<java.lang.String> getInfoTitle()  
      org.gradle.api.provider.Property<java.lang.String> getInfoVersion()  
      org.gradle.api.provider.Property<java.lang.String> getModelReader()
      Configuration property to specify the fully qualified name of the OASModelReader implementation.
      org.gradle.api.provider.Property<java.lang.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<java.lang.String,​java.lang.String> getOperationServers()
      Prefix of the configuration property to specify an alternative list of servers to service an operation.
      org.gradle.api.file.DirectoryProperty getOutputDirectory()
      Directory where to output the schemas.
      org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.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<java.lang.String> getScanClasses()
      Configuration property to specify the list of classes to scan.
      org.gradle.api.provider.Property<java.lang.Boolean> getScanDependenciesDisable()
      Disable scanning the project's dependencies for OpenAPI model classes too
      org.gradle.api.provider.Property<java.lang.Boolean> getScanDisabled()
      Configuration property to disable annotation scanning.
      org.gradle.api.provider.ListProperty<java.lang.String> getScanExcludeClasses()
      Configuration property to specify the list of classes to exclude from scans.
      org.gradle.api.provider.ListProperty<java.lang.String> getScanExcludePackages()
      Configuration property to specify the list of packages to exclude from scans.
      org.gradle.api.provider.SetProperty<java.lang.String> getScanExcludeProfiles()
      Profiles which explicitly exclude operations.
      org.gradle.api.provider.ListProperty<java.lang.String> getScanPackages()
      Configuration property to specify the list of packages to scan.
      org.gradle.api.provider.SetProperty<java.lang.String> getScanProfiles()
      Profiles which explicitly include operations.
      org.gradle.api.provider.Property<java.lang.String> getSchemaFilename()
      Filename of the schema Defaults to openapi.
      org.gradle.api.provider.ListProperty<java.lang.String> getServers()
      Configuration property to specify the list of global servers that provide connectivity information.

      • Methods inherited from class org.gradle.api.DefaultTask

        compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class org.gradle.api.internal.AbstractTask

        appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.gradle.api.Task

        doNotTrackState, getConvention, notCompatibleWithConfigurationCache

    • Constructor Detail

      • SmallryeOpenApiTask

        @Inject
public SmallryeOpenApiTask​(SmallryeOpenApiExtension ext,
                           org.gradle.api.model.ObjectFactory objects,
                           org.gradle.api.file.ProjectLayout layout,
                           org.gradle.api.NamedDomainObjectProvider<org.gradle.api.artifacts.Configuration> configProvider,
                           org.gradle.api.file.FileCollection resourcesSrcDirs,
                           org.gradle.api.file.FileCollection classesDirs)

    • Method Detail

      • generate

        public void generate()

      • getOutputDirectory

        @OutputDirectory
public org.gradle.api.file.DirectoryProperty getOutputDirectory()
        Directory where to output the schemas. If no path is specified, the schema will be printed to the log.

      • getConfigProperties

        @InputFile
@PathSensitive(RELATIVE)
@Optional
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

        @Input
public org.gradle.api.provider.Property<java.lang.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

      • getModelReader

        @Input
@Optional
public org.gradle.api.provider.Property<java.lang.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

        @Input
@Optional
public org.gradle.api.provider.Property<java.lang.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

      • getServers

        @Input
@Optional
public org.gradle.api.provider.ListProperty<java.lang.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

        @Input
@Optional
public org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.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

        @Input
@Optional
public org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.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

      • getOperationIdStrategy

        @Input
@Optional
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

        @Input
@Optional
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

        @Input
@Optional
public org.gradle.api.provider.SetProperty<java.lang.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

        @Input
@Optional
public org.gradle.api.provider.SetProperty<java.lang.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