Built by Maven

modello:jsonschema

Full name:

org.codehaus.modello:modello-maven-plugin:2.5.1: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
<basedir> String - Base directory of the project, from where the Modello models are loaded.
Default: ${basedir}
<models> String[] - List of relative paths to mdo files containing the models.
<outputDirectory> File - 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: ${project.build.directory}/generated-site/jsonschema
<packageWithVersion> boolean - True if the generated package names should include the version.
Default: false
User Property: packageWithVersion
<version> String - The version of the model we will be working on.
User Property: version

Optional Parameters

Name Type Since Description
<jsonSchemaFileName> String - No description.
<licenseFile> File 2.3.1 The file that contains license header text. If both configured, the licenseText prevails.
<licenseText> String 2.3.1 The contents of license header text, verbatim.
<packagedVersions> List<String> - Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.
<pluralExceptions> Map<String,String> 2.5.0 Additional exceptions to the singularization rules, changing plural noun to singular.

As a key we provide plural noun and as value we provide singular noun, example:

    <kisses>kiss</kisses>

Parameter Details

<basedir>

Base directory of the project, from where the Modello models are loaded.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${basedir}

<jsonSchemaFileName>

No description.
  • Type: java.lang.String
  • Required: No

<licenseFile>

The file that contains license header text. If both configured, the licenseText prevails.
  • Type: java.io.File
  • Since: 2.3.1
  • Required: No

<licenseText>

The contents of license header text, verbatim.
  • Type: java.lang.String
  • Since: 2.3.1
  • Required: No

<models>

List of relative paths to mdo files containing the models.
  • Type: java.lang.String[]
  • 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
  • Required: Yes
  • Default: ${project.build.directory}/generated-site/jsonschema

<packageWithVersion>

True if the generated package names should include the version.
  • Type: boolean
  • 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<java.lang.String>
  • Required: No

<pluralExceptions>

Additional exceptions to the singularization rules, changing plural noun to singular.

As a key we provide plural noun and as value we provide singular noun, example:

    <kisses>kiss</kisses>
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 2.5.0
  • Required: No

<version>

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