Built by Maven

openapi-toolkit:split

Full name:

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

Description:

Splits a single-file OpenAPI 3 or AsyncAPI description into a multi-file tree (redocly split). Usually run once from the command line; does not read redocly.yaml.

Attributes:

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

Required Parameters

Name Type Since Description
<api> String - The description to split: a path relative to the project base directory.
User Property: openapi.toolkit.split.api
<outputDirectory> File - Directory the file tree is written to.
User Property: openapi.toolkit.split.outputDirectory

Optional Parameters

Name Type Since Description
<separator> String - Separator in file names generated from paths: with the default, /users/{id} becomes users_{id}.yaml.
Default: _
User Property: openapi.toolkit.split.separator
<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
<skipSplit> boolean - Skip this goal only; openapi.toolkit.skip skips every goal of the plugin.
Default: false
User Property: openapi.toolkit.split.skip

Parameter Details

<api>

The description to split: a path relative to the project base directory.
  • Type: java.lang.String
  • Required: Yes
  • User Property: openapi.toolkit.split.api

<outputDirectory>

Directory the file tree is written to.
  • Type: java.io.File
  • Required: Yes
  • User Property: openapi.toolkit.split.outputDirectory

<separator>

Separator in file names generated from paths: with the default, /users/{id} becomes users_{id}.yaml.
  • Type: java.lang.String
  • Required: No
  • User Property: openapi.toolkit.split.separator
  • Default: _

<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

<skipSplit>

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