wcm.io Caravan
hal-docs:generate-hal-docs-json
Full name:
io.wcm.caravan.maven.plugins:hal-docs-maven-plugin:0.6.0-SNAPSHOT:generate-hal-docs-json
Description:
Generates HAL documentation JSON files for service.
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope:
compile. - The goal is thread-safe and supports parallel builds.
- Binds by default to the lifecycle phase:
process-classes.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<generatedResourcesDirectory> |
String |
- |
(no description) Default value is: generated-hal-docs-resources. |
<serviceId> |
String |
- |
Service ID. If not given it is tried to detect it automatically from maven-bundle-plugin configuration, instruction Caravan-JaxRs-ApplicationPath. If no Servce ID is found no documentation files are generated. |
<source> |
String |
- |
Paths containing the java source files. Default value is: ${basedir}/src/main/java. |
<target> |
String |
- |
Relative target path for the generated resources. Default value is: HAL-DOCS-INF. |
Parameter Details
<generatedResourcesDirectory>
(no description)
- Type:
java.lang.String - Required:
No - Default:
generated-hal-docs-resources
<serviceId>
Service ID. If not given it is tried to detect it automatically from
maven-bundle-plugin configuration, instruction Caravan-JaxRs-ApplicationPath. If no Servce ID is found no documentation files are generated.
- Type:
java.lang.String - Required:
No
<source>
Paths containing the java source files.
- Type:
java.lang.String - Required:
No - Default:
${basedir}/src/main/java
<target>
Relative target path for the generated resources.
- Type:
java.lang.String - Required:
No - Default:
HAL-DOCS-INF