Schema Export

Kayan can export both JSON Schema and Markdown docs for the consumer-owned Gradle DSL.

Configuration

kayan {
    jsonSchemaOutputFile.set(
        layout.projectDirectory.file(
            "config/kayan.schema.json"
        )
    )
    markdownSchemaOutputFile.set(
        layout.projectDirectory.file(
            "docs/config-schema.md"
        )
    )
}

Running the export

./gradlew exportKayanSchema

The export validates raw config types, required keys, the required flavors object, and unknown keys at both the top level and inside each flavor.