https://github.com/codelens-io/thorntail-json-schema-generator

Thorntail configuration schema generator
https://github.com/codelens-io/thorntail-json-schema-generator

java java-8 json-schema json-schema-generator thorntail wildfly-swarm yaml yaml-validator yml

Last synced: about 1 month ago
JSON representation

Thorntail configuration schema generator

• Host: GitHub
• URL: https://github.com/codelens-io/thorntail-json-schema-generator
• Owner: codelens-io
• License: other
• Created: 2018-08-07T12:59:57.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-21T21:16:48.000Z (over 5 years ago)
• Last Synced: 2024-11-15T21:59:29.094Z (about 2 months ago)
• Topics: java, java-8, json-schema, json-schema-generator, thorntail, wildfly-swarm, yaml, yaml-validator, yml
• Language: Java
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![License](https://img.shields.io/:license-Apache2-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

[![Build Status](https://travis-ci.org/codelens-io/thorntail-json-schema-generator.svg?branch=master)](https://travis-ci.org/codelens-io/thorntail-json-schema-generator)

[![Coverage Status](https://coveralls.io/repos/github/codelens-io/thorntail-json-schema-generator/badge.svg?branch=master)](https://coveralls.io/github/codelens-io/thorntail-json-schema-generator?branch=master)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.codelens/thorntail-json-schema-generator/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.codelens/thorntail-json-schema-generator)

# Thorntail (*formerly wildfly-swarm*) configuration schema generator

This utility can be used to generate a **JSON Schema** which can be used to validate

**[Thorntail](https://thorntail.io)** (*[wildfly-swarm](http://wildfly-swarm.io)*) `YAML` configuration files (eg.: `project-defaults.yml`).

The currently generated schema files can be downloaded from [the releases page](https://github.com/codelens-io/thorntail-json-schema-generator/releases)

* thorntail-schema-2.4.0.json

* thorntail-schema-2.4.0-compact.json

* thorntail-schema-2.4.0.properties

## Usage

To generate schema files build the project, and run the jar:

```

$ mvn clean package

$ cd target;

$ java -jar thorntail-json-schema-generator-1.1.1.jar 2.4.0 ~/Developer/thorntail

Thorntail schema generator

============================================================

version: 2.4.0

output directory: /Users/user/Developer/thorntail/

building schema model...

writing schema files...

... done

```

The jar file requires at least one parameter, which is the **version**, the second parameter is the

**output directory**. If omitted, the current directory will be used.

The result `thorntail-schema--compact.json` can be used in **[IntelliJ IDEA](https://www.jetbrains.com/idea)** to

validate the configuration file, ot the validation can be done with other command line tools,

like: [pajv](https://www.npmjs.com/package/pajv)

```

pajv -s path/to/thorntail-schema-2.4.0.json -d path/to/project-defaults.yml

```

The utility also builds a `properties` file with the available parameters (*with type and documentation*). 

## License

This project is licensed under [Apache 2.0 license]( http://www.apache.org/licenses/LICENSE-2.0).