Interface SmallryeOpenApiProperties

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.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.
    • Method Detail

      • 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<java.lang.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<java.lang.Boolean> getScanDependenciesDisable()
        Disable scanning the project's dependencies for OpenAPI model classes too
      • getModelReader

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

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

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

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

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

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

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

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

        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
      • getOperationServers

        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.
      • getCustomSchemaRegistryClass

        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.
      • getApplicationPathDisable

        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.
      • getOpenApiVersion

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

        org.gradle.api.provider.Property<java.lang.String> getInfoTitle()
      • getInfoVersion

        org.gradle.api.provider.Property<java.lang.String> getInfoVersion()
      • getInfoDescription

        org.gradle.api.provider.Property<java.lang.String> getInfoDescription()
      • getInfoTermsOfService

        org.gradle.api.provider.Property<java.lang.String> getInfoTermsOfService()
      • getInfoContactEmail

        org.gradle.api.provider.Property<java.lang.String> getInfoContactEmail()
      • getInfoContactName

        org.gradle.api.provider.Property<java.lang.String> getInfoContactName()
      • getInfoContactUrl

        org.gradle.api.provider.Property<java.lang.String> getInfoContactUrl()
      • getInfoLicenseName

        org.gradle.api.provider.Property<java.lang.String> getInfoLicenseName()
      • getInfoLicenseUrl

        org.gradle.api.provider.Property<java.lang.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.SetProperty<java.lang.String> getScanProfiles()
        Profiles which explicitly include operations. Any operation without a matching profile is excluded.
      • getScanExcludeProfiles

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

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