Package io.smallrye.openapi.gradleplugin

Interface SmallryeOpenApiProperties

All Known Implementing Classes:
SmallryeOpenApiExtension, SmallryeOpenApiTask
public interface SmallryeOpenApiProperties

  • Method Details

    • getConfigProperties

      org.gradle.api.file.RegularFileProperty getConfigProperties()
      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`.

    • getSchemaFilename

      org.gradle.api.provider.Property<String> getSchemaFilename()
      Filename of the schema Defaults to openapi. So the files created will be openapi.yaml and openapi.json.

    • getScanDependenciesDisable

      org.gradle.api.provider.Property<Boolean> getScanDependenciesDisable()
      Disable scanning the project's dependencies for OpenAPI model classes too

    • getModelReader

      org.gradle.api.provider.Property<String> getModelReader()
      Configuration property to specify the fully qualified name of the OASModelReader implementation.

    • getFilter

      org.gradle.api.provider.Property<String> getFilter()
      Configuration property to specify the fully qualified name of the OASFilter implementation.

    • getScanDisabled

      org.gradle.api.provider.Property<Boolean> getScanDisabled()
      Configuration property to disable annotation scanning.

    • getScanPackages

      org.gradle.api.provider.ListProperty<String> getScanPackages()
      Configuration property to specify the list of packages to scan.

    • getScanClasses

      org.gradle.api.provider.ListProperty<String> getScanClasses()
      Configuration property to specify the list of classes to scan.

    • getScanExcludePackages

      org.gradle.api.provider.ListProperty<String> getScanExcludePackages()
      Configuration property to specify the list of packages to exclude from scans.

    • getScanExcludeClasses

      org.gradle.api.provider.ListProperty<String> getScanExcludeClasses()
      Configuration property to specify the list of classes to exclude from scans.

    • getServers

      org.gradle.api.provider.ListProperty<String> getServers()
      Configuration property to specify the list of global servers that provide connectivity information.

    • getPathServers

      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

    • getOperationServers

      org.gradle.api.provider.MapProperty<String,String> getOperationServers()
      Prefix of the configuration property to specify an alternative list of servers to service an operation.

    • getCustomSchemaRegistryClass

      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.

    • getApplicationPathDisable

      org.gradle.api.provider.Property<Boolean> getApplicationPathDisable()
      Disable scanning of the javax.ws.rs.Path (and jakarta.ws.rs.Path) for the application path.

    • getOpenApiVersion

      org.gradle.api.provider.Property<String> getOpenApiVersion()
      To specify a custom OpenAPI version.

    • getInfoTitle

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

    • getInfoVersion

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

    • getInfoDescription

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

    • getInfoTermsOfService

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

    • getInfoContactEmail

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

    • getInfoContactName

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

    • getInfoContactUrl

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

    • getInfoLicenseName

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

    • getInfoLicenseUrl

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

    • getOperationIdStrategy

      org.gradle.api.provider.Property<io.smallrye.openapi.api.OpenApiConfig.OperationIdStrategy> getOperationIdStrategy()
      Configuration property to specify how the operationid is generated. Can be used to minimize risk of collisions between operations.

    • getDuplicateOperationIdBehavior

      org.gradle.api.provider.Property<io.smallrye.openapi.api.OpenApiConfig.DuplicateOperationIdBehavior> getDuplicateOperationIdBehavior()
      Configuration property to specify what should happen if duplicate operationIds occur.

    • getScanProfiles

      org.gradle.api.provider.ListProperty<String> getScanProfiles()
      Profiles which explicitly include operations. Any operation without a matching profile is excluded.

    • getScanExcludeProfiles

      org.gradle.api.provider.ListProperty<String> getScanExcludeProfiles()
      Profiles which explicitly exclude operations. Any operation without a matching profile is included.

    • getScanResourceClasses

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

    • getOutputFileTypeFilter

      org.gradle.api.provider.Property<String> getOutputFileTypeFilter()
      Filter the type of files that will be generated, allowed values are ALL, YAML and JSON.

    • getEncoding

      org.gradle.api.provider.Property<String> getEncoding()
      Output encoding for openapi document.