io.github.tabilzad.ktor.KtorDocsExtension.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ktor-docs-plugin-gradle Show documentation

Provides Gradle bridge for ktor-docs-plugin

There is a newer version: 0.6.5-alpha

Show newest version

package io.github.tabilzad.ktor

open class DocumentationOptions(
    var docsTitle: String = "Open API Specification",
    var docsDescription: String = "Generated using Ktor Docs Plugin",
    var docsVersion: String = "1.0.0",
    var generateRequestSchemas: Boolean = true,
    var hideTransientFields: Boolean = true,
    var hidePrivateAndInternalFields: Boolean = true,
    var deriveFieldRequirementFromTypeNullability: Boolean = true
)

open class PluginOptions(
    var enabled: Boolean = true,
    var saveInBuild: Boolean = true,
    var filePath: String? = null,
    var format: String = "json"
)

open class KtorDocsExtension(
    var documentation: DocumentationOptions = DocumentationOptions(),
    var pluginOptions: PluginOptions = PluginOptions(),
)