Skip to content

Commit

Permalink
Document property includeStandardJavaModules in Maven plugin README (
Browse files Browse the repository at this point in the history
…#2041)

Signed-off-by: Michael Edgar <[email protected]>
  • Loading branch information
MikeEdgar authored Oct 30, 2024
1 parent a4d6fd1 commit 93d70a5
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion tools/maven-plugin/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Add this to your pom.xml:
</plugin>
----

The schema will appear as `target/generated/openapi.yaml` and `target/generated/openapi.json` by default.
The schema will appear as `target/generated/openapi.yaml` and `target/generated/openapi.json` by default.

== m2e integration

Expand All @@ -61,6 +61,7 @@ E.g. for includeDependenciesScopes could be configured as:
- `scanDependenciesDisable` (boolean, default: false) - Disable scanning the project's dependencies for OpenAPI model classes too
- `includeDependenciesScopes` (List<String>, default: compile, system) - If the above `scanDependenciesDisable` is true, you can control what scopes should be included.
- `includeDependenciesTypes` (List<String>, default: jar) - If the above `scanDependenciesDisable` is true, you can control what types should be included.
- `includeStandardJavaModules` (List<String>, default: empty list) - List of Java modules to be indexed and available for introspection by the annotation scanner. Use with caution as introspection of the core Java modules generally is not useful for generation of the OpenAPI definition.
- `configProperties` (String) - Load any properties from a file. Example `${basedir}/src/main/resources/application.properties`.
- `attachArtifacts` (boolean, default: false) - Attach the built OpenAPI schema as build artifact.
- `skip` (boolean, default: false) - Skip execution of the plugin.
Expand Down

0 comments on commit 93d70a5

Please sign in to comment.