Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 2.2 KB

README.md

File metadata and controls

85 lines (54 loc) · 2.2 KB
Raw

element-templates-json-schema

Build Status

JSON Schema for (Camunda) Element Templates. The schema is built on top of and validated by json-schema@draft-07.

Usage

This library exports several Element Templates JSON Schema definitions.

There exist different ways to consume the definition. Many tools, like IDEs, support schema validation out of the box. To activate those, simply specify the $schema attribute to an element template.

{
  "$schema": "https://unpkg.com/@camunda/element-templates-json-schema/resources/schema.json",
  "name": "Mail Task",
  "id": "com.camunda.example.MailTask",
  "appliesTo": [ "bpmn:ServiceTask" ],
  "properties": []
}

You can also use a specific version.

"$schema": "https://unpkg.com/@camunda/[email protected]/resources/schema.json"

Additionally, it's possible to use the schema on top of existing validation libraries and tools. Follow the example for further instructions.

Build and Run

Prepare the project by installing all dependencies:

npm install

Then, depending on your use case, bundle the source schema files together

# bundle all schema files
npm run build

# bundle C7 schema
npm run build:camunda

# bundle C8 schema
npm run build:zeebe

Furthermore, execute the following command to run the generated schema against our tests

npm run test

Run tests in individual packages:

npm run dev -- @camunda/zeebe-element-templates-json-schema

Release

We use lerna to publish releases. All packages can be released independently (lerna will take care of this).

# release stable version
npm run release

# release alpha version
npm run release:alpha

# execute dry run
npm run release:dry

License

MIT