Package org.openapitools.generator.gradle.plugin.extensions

Class OpenApiGeneratorValidateExtension

  • All Implemented Interfaces:
    
public class OpenApiGeneratorValidateExtension

    Gradle project level extension object definition for the generators task

    Author:

    Jim Schubert

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final RegularFileProperty getInputSpec() The input specification to validate.
      final Property<String> getRemoteInputSpec() The remote input specification to validate.
      final Property<Boolean> getRecommend() Whether to offer recommendations related to the validated specification document.
      final Property<Boolean> getTreatWarningsAsErrors() Whether to treat warnings as errors and fail the task.
      final Unit setInputSpec(String path) Backwards-compatibility bridge for inputSpec
      final Unit set(RegularFileProperty $self, String path) Extension function to allow setting inputSpec with a String path in Kotlin DSL.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • OpenApiGeneratorValidateExtension

        OpenApiGeneratorValidateExtension(Project project)

    • Method Detail

      • getInputSpec

         final RegularFileProperty getInputSpec()

        The input specification to validate. Supports all formats supported by the Parser.

      • getRemoteInputSpec

         final Property<String> getRemoteInputSpec()

        The remote input specification to validate. Supports URLs/URIs.

      • getRecommend

         final Property<Boolean> getRecommend()

        Whether to offer recommendations related to the validated specification document. Defaults to true.

      • set

         final Unit set(RegularFileProperty $self, String path)

        Extension function to allow setting inputSpec with a String path in Kotlin DSL. Example: inputSpec.set("$rootDir/api.yaml")