Home

Welcome to the 'cubx-webpackage-document-api' wiki!

The cubx-webpackage-document-api provides the schema and schema-validation functions for the manifest.webpackage -file. A manifest.webpackage looks like this:

{
  "name": "my-webpackage",
  "groupId": "org.example",
  "version": "0.2.0",
  "modelVersion": "8.3.0",
  "docType": "webpackage",
  "author": {
    "name": "John Doe",
    "email": "john.doe@example.org"
  },
  "license": "MIT",
  "homepage": "http://project.home.com",
  "keywords": [
    "connectors",
    "energy"
  ],
  "runnables": [
      {
        "name": "readme",
        "path": "/doc/readme.html",
        "description": "Read this ..."
      }
  ],
  "artifacts": {
    "compoundComponents": [
  [...]
}

manifest.webpackage: modelVersion (Change Notes)

version	changes	links
8.0.0	Fundamental changes. Includes (multi-) "artifacts -support_ and "runnables".	schema doc
8.1.0	New Feature "repeatedValues on connections": Connections allow a new (optional) property "repeatedValues". Set it to false to prevent the repeated transfer of unchanged values.	schema doc
8.2.0	New Feature "runnables on artifact-level": It´s now possible to define "runnables" globally AND per artifact.	schema doc
8.3.0	New Feature "camelCase notation for slotIds": From now on you are allowed to name slots using the camelCase-notation ("slotId": "mySlot")	schema doc