@bpmn-io/form-json-schema
v1.8.4
Published
JSON Schema for form-js
Downloads
66
Readme
ℹ️ This project is a development tool and not intended for production usage.
@bpmn-io/form-json-schema
JSON Schema for form-js. The schema is built on top of and validated by json-schema@draft-07
.
Usage
Set the $schema
attribute to reference the JSON Schema definition.
{
"$schema": "https://unpkg.com/@bpmn-io/form-json-schema/resources/schema.json",
"type": "default",
"schemaVersion": 11,
"components": []
}
You can also use a specific version.
"$schema": "https://unpkg.com/@bpmn-io/[email protected]/resources/schema.json"
Build and Run
Prepare the project by installing all dependencies:
npm install
Bundle the source schema files together
npm run build
Execute the following command to run the generated schema against the tests
npm run test
Schema compatibility notice
This schema is currently only compatible with following form-js schema versions.
| JSON schema version | form-js schema version | | ------------------- | ---------------------- | | >= 1.5.0 | <= 13 | | >= 1.6.0 | <= 14 |
License
Use under the terms of the bpmn.io license.