document parser option

Author: hauner

docs/modules/ROOT/pages/gradle.adoc

@@ -35,7 +35,7 @@ openapiProcessor {
         apiPath "$projectDir/src/api/openapi.yaml"
         targetDir "$projectDir/build/openapi"
         mapping "$projectDir/mapping.yaml"
-        showWarnings true
+        parser "INTERNAL"
     }
 
 }
@@ -60,8 +60,14 @@ to yaml file. See xref:processor/configuration.adoc[Configuration] for a descrip
 yaml. This replaces the `typeMappings` option.
 
 * `showWarnings`: (**optional**) `true` to show warnings from the open api parser or `false`
-(default) to show no warnings.
-
+(default) to show no warnings (this option has currently no effect).
+
+* `parser`: (**optional**), sets the openapi parser used to read the OpenAPI description. Available values are `SWAGGER` (default), `OPENAPI4J` or `INTERNAL`.
+** `SWAGGER`: link:{swagger-parser}:[Swagger OpenAPI parser, window="_blank"], supports *OpenAPI 3.0.x*
+** `OPENAPI4J`: link:{openapi4j}[openapi4j OpenAPI parser, window="_blank"], supports *OpenAPI 3.0.x*. It provides better validation than `SWAGGER`, unfortunately it is no longer maintained.
+** `INTERNAL`: link:{openapi-parser}:[internal OpenAPI parser, window="_blank"], supports *OpenAPI 3.0.x* & *OpenAPI 3.1.0*.
+*** the 3.0.x parser provides JSON schema validation.
+*** the 3.1.0 parser is *experimental* and has no validation at the moment.
 
 == running processor-spring
 

docs/modules/ROOT/partials/links.adoc

@@ -27,6 +27,7 @@
 
 :swagger-parser: https://github.com/swagger-api/swagger-parser
 :openapi4j: https://github.com/openapi4j/openapi4j
+:openapi-parser: https://github.com/openapi-processor/openapi-parser
 
 :springboot: https://spring.io/projects/spring-boot
 :license: http://www.apache.org/licenses/LICENSE-2.0.txt