generator/io.github.edricchan03.koogle_api.plugin.generator/KoogleApiGeneratorPluginExtension

KoogleApiGeneratorPluginExtension

abstract class KoogleApiGeneratorPluginExtension(source)

Configuration options for the Koogle API generator plugin.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
abstract val discoveryDocsOutputDir: DirectoryProperty

The directory to save all discovery documents to.

Link copied to clipboard
abstract val discoveryUrl: Property<URI>

The discovery URL to use.

Link copied to clipboard
abstract val outputFileNameMapper: Property<SchemaFileNameMapper>

Mapping function used to generate the output file name based from the specified DirectoryItem.

Link copied to clipboard
abstract val rootDiscoveryDocOutputFile: RegularFileProperty

The file to output to.

Functions

Link copied to clipboard
fun discoveryUrl(file: File)

The discovery file to use.

fun discoveryUrl(path: Path)

The discovery file to use, as a Path.

fun discoveryUrl(url: String)

The discovery URL to use.

fun discoveryUrl(file: RegularFile)

The discovery file to use, as a RegularFile.

@JvmName(name = "discoveryUrlProviderFile")
fun discoveryUrl(file: Provider<File>)

The discovery file to use, as a Provider.

@JvmName(name = "discoveryUrlProviderPath")
fun discoveryUrl(path: Provider<Path>)

The discovery file to use, as a Provider of Path.

@JvmName(name = "discoveryUrlProviderString")
fun discoveryUrl(url: Provider<String>)

The discovery URL to use, as a Provider.

@JvmName(name = "discoveryUrlProviderRegularFile")
fun discoveryUrl(file: Provider<RegularFile>)

The discovery file to use, as a Provider of RegularFile.

Link copied to clipboard
fun outputFileNameMapper(mapper: SchemaFileNameMapper)

Mapping function used to generate the output file name based from the specified DirectoryItem.