Built by Maven

openapi-toolkit:score

Full name:

net.mwalser:openapi-toolkit-maven-plugin:0.2.0:score

Description:

Scores OpenAPI 3 descriptions for integration simplicity and agent readiness (redocly score). Fails the build when a score is below minScore.

Attributes:

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

Optional Parameters

Name Type Since Description
<apis> List<String> - The API descriptions to process: aliases from the apis section of the configuration file, paths relative to the project base directory, or URLs. Empty: every API in the configuration file. Without a configuration file, paths or URLs are required and Redocly's built-in recommended ruleset applies.
User Property: openapi.toolkit.apis
<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 - Output format: stylish or json.
Default: stylish
User Property: openapi.toolkit.score.format
<lintConfig> String - Severity of problems in the configuration file, which is linted before the goal runs: warn (reported, invalid entries are ignored), error (fails the build) or off.
Default: warn
User Property: openapi.toolkit.lintConfig
<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
<minScore> Double - Minimum agent-readiness score, 0 to 100; the build fails when any selected API scores lower. Unset: never fails.
User Property: openapi.toolkit.score.minScore
<operationDetails> boolean - Include per-operation details in the stylish output.
Default: false
User Property: openapi.toolkit.score.operationDetails
<outputFile> File - File to write the score report to instead of the build log. Requires a single selected API.
User Property: openapi.toolkit.score.outputFile
<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
<skipScore> boolean - Skip this goal only; openapi.toolkit.skip skips every goal of the plugin.
Default: false
User Property: openapi.toolkit.score.skip

Parameter Details

<apis>

The API descriptions to process: aliases from the apis section of the configuration file, paths relative to the project base directory, or URLs. Empty: every API in the configuration file. Without a configuration file, paths or URLs are required and Redocly's built-in recommended ruleset applies.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: openapi.toolkit.apis

<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>

Output format: stylish or json.
  • Type: java.lang.String
  • Required: No
  • User Property: openapi.toolkit.score.format
  • Default: stylish

<lintConfig>

Severity of problems in the configuration file, which is linted before the goal runs: warn (reported, invalid entries are ignored), error (fails the build) or off.
  • Type: java.lang.String
  • Required: No
  • User Property: openapi.toolkit.lintConfig
  • Default: warn

<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

<minScore>

Minimum agent-readiness score, 0 to 100; the build fails when any selected API scores lower. Unset: never fails.
  • Type: java.lang.Double
  • Required: No
  • User Property: openapi.toolkit.score.minScore

<operationDetails>

Include per-operation details in the stylish output.
  • Type: boolean
  • Required: No
  • User Property: openapi.toolkit.score.operationDetails
  • Default: false

<outputFile>

File to write the score report to instead of the build log. Requires a single selected API.
  • Type: java.io.File
  • Required: No
  • User Property: openapi.toolkit.score.outputFile

<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

<skipScore>

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