wcm.io Caravan
hal-docs:generate-json-schema
Full name:
io.wcm.caravan.maven.plugins:hal-docs-maven-plugin:0.6.0-SNAPSHOT:generate-json-schema
Description:
Generates JSON schema files for Java POJOs using Jackson 'jackson-module-jsonSchema'. The generated files are attached as resources and included in the JAR file.
Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Binds by default to the lifecycle phase:
process-classes.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<includes> |
Set<String> |
- |
Ant-style include patterns for java package names to include. Use "." as separator. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<excludes> |
Set<String> |
- |
Ant-style exclude patterns for java package names to exclude. Use "." as separator. |
<generatedResourcesDirectory> |
String |
- |
(no description) Default value is: generated-json-schema-resources. |
<source> |
String |
- |
Paths containing the class files to generate JSON schema for. Default value is: ${project.build.directory}/classes. |
<target> |
String |
- |
Relative target path for the generated resources. Default value is: JSON-SCHEMA-INF. |
Parameter Details
<excludes>
Ant-style exclude patterns for java package names to exclude. Use "." as separator.
- Type:
java.util.Set<java.lang.String> - Required:
No
<generatedResourcesDirectory>
(no description)
- Type:
java.lang.String - Required:
No - Default:
generated-json-schema-resources
<includes>
Ant-style include patterns for java package names to include. Use "." as separator.
- Type:
java.util.Set<java.lang.String> - Required:
Yes
<source>
Paths containing the class files to generate JSON schema for.
- Type:
java.lang.String - Required:
No - Default:
${project.build.directory}/classes
<target>
Relative target path for the generated resources.
- Type:
java.lang.String - Required:
No - Default:
JSON-SCHEMA-INF