Package io.smallrye.openapi.gradleplugin

Class SmallryeOpenApiTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.smallrye.openapi.gradleplugin.SmallryeOpenApiTask
All Implemented Interfaces:
SmallryeOpenApiProperties, 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.file.FileCollection classpath, org.gradle.api.file.FileCollection resourcesSrcDirs, org.gradle.api.file.FileCollection classesDirs)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generate()
     
    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.file.DirectoryProperty
    getOutputDirectory()
    Directory where to output the schemas.
    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 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, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

    acceptServiceReferences, 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