modello:jsonschema

Full name:

org.codehaus.modello:modello-maven-plugin:1.9.0-SNAPSHOT:jsonschema

Description:

Creates a JSON Schema from the model.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.8.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
models String[] 1.8 List of relative paths to mdo files containing the models.
outputDirectory File 1.8 The output directory of the generated JSON Schema. Hint: if you want to publish the schema automatically with the site, configure this parameter to ${basedir}/target/generated-site/resources/jsonschema.
Default value is: ${project.build.directory}/generated-site/jsonschema.
packageWithVersion boolean 1.8 True if the generated package names should include the version.
Default value is: false.
User property is: packageWithVersion.
version String 1.8 The version of the model we will be working on.
User property is: version.

Optional Parameters

Name Type Since Description
jsonSchemaFileName String 1.8 (no description)
packagedVersions List 1.8 Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.

Parameter Details

jsonSchemaFileName:

(no description)
  • Type: java.lang.String
  • Since: 1.8
  • Required: No

models:

List of relative paths to mdo files containing the models.
  • Type: java.lang.String[]
  • Since: 1.8
  • Required: Yes

outputDirectory:

The output directory of the generated JSON Schema. Hint: if you want to publish the schema automatically with the site, configure this parameter to ${basedir}/target/generated-site/resources/jsonschema.
  • Type: java.io.File
  • Since: 1.8
  • Required: Yes
  • Default: ${project.build.directory}/generated-site/jsonschema

packageWithVersion:

True if the generated package names should include the version.
  • Type: boolean
  • Since: 1.8
  • Required: Yes
  • User Property: packageWithVersion
  • Default: false

packagedVersions:

Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.
  • Type: java.util.List
  • Since: 1.8
  • Required: No

version:

The version of the model we will be working on.
  • Type: java.lang.String
  • Since: 1.8
  • Required: Yes
  • User Property: version