Plugin Details

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Description
openapi-toolkit:build-docs	Renders each API description as an HTML reference page with Redoc (`redocly build-docs`). The page is pre-rendered and self-contained apart from the Redoc script, which it loads from Redocly's CDN, and the Google Fonts stylesheet.
openapi-toolkit:bundle	Bundles each API description into a single file (`redocly bundle`): resolves `$ref`s to other files and applies the decorators configured in `redocly.yaml`.
openapi-toolkit:check-config	Lints the Redocly configuration file (`redocly check-config`).
openapi-toolkit:help	Display help information on openapi-toolkit-maven-plugin. Call `mvn openapi-toolkit:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
openapi-toolkit:join	Joins two or more OpenAPI 3 descriptions, selected with `apis`, into one file (`redocly join`; experimental upstream).
openapi-toolkit:lint	Lints API descriptions (`redocly lint`). Fails the build on problems with severity `error`; see `failOnErrors` and `failOnWarnings`.
openapi-toolkit:score	Scores OpenAPI 3 descriptions for integration simplicity and agent readiness (`redocly score`). Fails the build when a score is below `minScore`.
openapi-toolkit:split	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`.
openapi-toolkit:stats	Prints statistics of API descriptions (`redocly stats`): references, external documents, schemas, parameters, links, path items, webhooks, operations and tags.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.9.0
JDK	21

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version	Maven	JDK
0.1.0	3.9.0	21

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>net.mwalser</groupId>
          <artifactId>openapi-toolkit-maven-plugin</artifactId>
          <version>0.2.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>net.mwalser</groupId>
        <artifactId>openapi-toolkit-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"