Built by Maven

openapi-toolkit:join

Full name:

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

Description:

Joins two or more OpenAPI 3 descriptions, selected with apis, into one file (redocly join; experimental upstream).

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
<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
<outputFile> File - File to write the joined description to; its extension (yaml, yml or json) sets the format.
Default: ${project.build.directory}/generated-resources/openapi/joined.yaml
User Property: openapi.toolkit.join.outputFile
<prefixComponentsWithInfoProp> String - Prefix component names with this info property of their source description, for example title.
User Property: openapi.toolkit.join.prefixComponentsWithInfoProp
<prefixTagsWithFilename> boolean - Prefix tags with the file name of their source description. Exclusive with prefixTagsWithInfoProp and withoutXTagGroups.
Default: false
User Property: openapi.toolkit.join.prefixTagsWithFilename
<prefixTagsWithInfoProp> String - Prefix tags with this info property of their source description, for example title. Exclusive with prefixTagsWithFilename and withoutXTagGroups.
User Property: openapi.toolkit.join.prefixTagsWithInfoProp
<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
<skipJoin> boolean - Skip this goal only; openapi.toolkit.skip skips every goal of the plugin.
Default: false
User Property: openapi.toolkit.join.skip
<withoutXTagGroups> boolean - Do not generate x-tagGroups. Exclusive with prefixTagsWithInfoProp and prefixTagsWithFilename.
Default: false
User Property: openapi.toolkit.join.withoutXTagGroups

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

<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

<outputFile>

File to write the joined description to; its extension (yaml, yml or json) sets the format.
  • Type: java.io.File
  • Required: No
  • User Property: openapi.toolkit.join.outputFile
  • Default: ${project.build.directory}/generated-resources/openapi/joined.yaml

<prefixComponentsWithInfoProp>

Prefix component names with this info property of their source description, for example title.
  • Type: java.lang.String
  • Required: No
  • User Property: openapi.toolkit.join.prefixComponentsWithInfoProp

<prefixTagsWithFilename>

Prefix tags with the file name of their source description. Exclusive with prefixTagsWithInfoProp and withoutXTagGroups.
  • Type: boolean
  • Required: No
  • User Property: openapi.toolkit.join.prefixTagsWithFilename
  • Default: false

<prefixTagsWithInfoProp>

Prefix tags with this info property of their source description, for example title. Exclusive with prefixTagsWithFilename and withoutXTagGroups.
  • Type: java.lang.String
  • Required: No
  • User Property: openapi.toolkit.join.prefixTagsWithInfoProp

<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

<skipJoin>

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

<withoutXTagGroups>

Do not generate x-tagGroups. Exclusive with prefixTagsWithInfoProp and prefixTagsWithFilename.
  • Type: boolean
  • Required: No
  • User Property: openapi.toolkit.join.withoutXTagGroups
  • Default: false