Built by Maven

openapi-toolkit:check-config

Full name:

net.mwalser:openapi-toolkit-maven-plugin:0.2.0:check-config

Description:

Lints the Redocly configuration file (redocly check-config).

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Optional Parameters

Name Type Since Description
<configFile> File - The Redocly configuration file. Unset: redocly.yaml in the project base directory if it exists, otherwise no configuration file.
User Property: openapi.toolkit.configFile
<format> String - Format of the problems in the build log: stylish, codeframe, summary, markdown or github-actions.
Default: stylish
User Property: openapi.toolkit.checkConfig.format
<maxProblems> int - Maximum number of problems printed to the build log, per API description and for the configuration file. Report files are not limited.
Default: 100
User Property: openapi.toolkit.maxProblems
<severity> String - Severity of configuration problems: error (fails the build) or warn.
Default: error
User Property: openapi.toolkit.checkConfig.severity
<skip> boolean - Skip execution. As the property openapi.toolkit.skip it skips every goal of the plugin; the goal-specific properties such as openapi.toolkit.lint.skip skip one goal.
Default: false
User Property: openapi.toolkit.skip
<skipCheckConfig> boolean - Skip this goal only; openapi.toolkit.skip skips every goal of the plugin.
Default: false
User Property: openapi.toolkit.checkConfig.skip

Parameter Details

<configFile>

The Redocly configuration file. Unset: redocly.yaml in the project base directory if it exists, otherwise no configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: openapi.toolkit.configFile

<format>

Format of the problems in the build log: stylish, codeframe, summary, markdown or github-actions.
  • Type: java.lang.String
  • Required: No
  • User Property: openapi.toolkit.checkConfig.format
  • Default: stylish

<maxProblems>

Maximum number of problems printed to the build log, per API description and for the configuration file. Report files are not limited.
  • Type: int
  • Required: No
  • User Property: openapi.toolkit.maxProblems
  • Default: 100

<severity>

Severity of configuration problems: error (fails the build) or warn.
  • Type: java.lang.String
  • Required: No
  • User Property: openapi.toolkit.checkConfig.severity
  • Default: error

<skip>

Skip execution. As the property openapi.toolkit.skip it skips every goal of the plugin; the goal-specific properties such as openapi.toolkit.lint.skip skip one goal.
  • Type: boolean
  • Required: No
  • User Property: openapi.toolkit.skip
  • Default: false

<skipCheckConfig>

Skip this goal only; openapi.toolkit.skip skips every goal of the plugin.
  • Type: boolean
  • Required: No
  • User Property: openapi.toolkit.checkConfig.skip
  • Default: false