[gradle] Clarify defining multiple tasks (#5167)

This commit is contained in:
Jim Schubert
2020-01-30 16:00:13 -05:00
committed by GitHub
parent 845acce4af
commit 97c8009ccb
2 changed files with 34 additions and 1 deletions

View File

@@ -9,7 +9,6 @@ These map almost fully 1:1 with the options you'd pass to the CLI or Maven plugi
Tasks are listed under the "OpenAPI Tools" tasks heading.
.OpenAPI Tools Tasks
|===
|task name |description
@@ -38,6 +37,30 @@ compileJava.dependsOn tasks.openApiGenerate
```
====
All extensions can be rewritten as tasks. Where you can have only a single extension defined in your gradle file, you may have multiple tasks.
.One Extension, multiple tasks
[source,groovy]
----
// Validating a single specification
openApiValidate {
inputSpec = "$rootDir/petstore-v3.0-invalid.yaml".toString()
}
// Define a task for validating one specification
task validateGoodSpec(type: org.openapitools.generator.gradle.plugin.tasks.ValidateTask){
inputSpec = "$rootDir/petstore-v3.0.yaml".toString()
}
// Define a task for validating another specification
task validateBadSpec(type: org.openapitools.generator.gradle.plugin.tasks.ValidateTask){
inputSpec = "$rootDir/petstore-v3.0-invalid.yaml".toString()
}
// Define a task for batch validations
task validateSpecs(dependsOn: ['validateGoodSpec', 'validateBadSpec'])
----
== Plugin Setup
//# RELEASE_VERSION

View File

@@ -91,3 +91,13 @@ task generateGoWithInvalidSpec(type: org.openapitools.generator.gradle.plugin.ta
dateLibrary: "threetenp"
]
}
task validateGoodSpec(type: org.openapitools.generator.gradle.plugin.tasks.ValidateTask){
inputSpec = "$rootDir/petstore-v3.0.yaml".toString()
}
task validateBadSpec(type: org.openapitools.generator.gradle.plugin.tasks.ValidateTask){
inputSpec = "$rootDir/petstore-v3.0-invalid.yaml".toString()
}
task validateSpecs(dependsOn: ['validateGoodSpec', 'validateBadSpec'])