plugin-metadata - click on schema id to expand documentation

plugin-metadata - click on schema id to expand

Specification for metadata to be placed into tba plugins.

Operations

SEND iqb_data_structures
Operation IDPlease select one schema
Accepts the following message:
select_schema
Message IDselect_schema
Examples

Schemas

object [TBA Plugin Metadata]
uid: plugin-metadata@3.1
id
required
string
must match: ^[A-Za-z][A-Za-z0-9_-]*$
The id will be used as reference by any application using this module

required
array<object>
non-empty
object
lang
required
string
must match: ^[a-z]{2}$
This language code declares the language of the value.

Default value:"de"
Examples values:
"en"
"fr"
value
required
string
non-empty
Additional properties are NOT allowed.
type
required
string
Allowed values:
"EDITOR"
"PLAYER"
"SCHEMER"
"WIDGET"
model
string
Specifies the type more precisely. This can be the WIDGET model like 'CALC' or 'PSE' or the data type used by the module like 'iqb-aspect@12.5'.

array<object>
non-empty
object
lang
required
string
must match: ^[a-z]{2}$
This language code declares the language of the value.

Default value:"de"
Examples values:
"en"
"fr"
value
required
string
non-empty
Additional properties are NOT allowed.
version
required
string
must match: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Semantic Versioning 2.0.0 required (MAJOR.MINOR.PATCH).

Examples values:
"1.5.2"
"0.12.4-beta"
"12.0.0-rc.1"
specVersion
required
string
must match: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
Version of the Verona specification supported by this module in the form 'MAJOR.MINOR'.

Examples values:
"1.5"
"4.12"
metadataVersion
required
string
must match: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
Version of the Verona Metadata specification supported by this metadata in the form of 'MAJOR.MINOR'.

Examples values:
"1.5"
"4.12"
array<object>
Packages needed during runtime.

object
id
required
string
Used to load or access on demand.

description
string
Helps to understand the function of the package or service.

type
required
string
Type of dependency. This helps to find and access the dependency.

Allowed values:
"FILE"
"WIDGET"
"SERVICE"
required
boolean
States whether this packages or service is needed for all use cases of the Verona module or only for some special use cases.

Default value:false
Additional properties are NOT allowed.
object [Maintainer]
Maintainer of the verona module

array<object>
non-empty
object
lang
required
string
must match: ^[a-z]{2}$
This language code declares the language of the value.

Default value:"de"
Examples values:
"en"
"fr"
value
required
string
non-empty
Additional properties are NOT allowed.
url
string
format: uri
email
string
format: email
Additional properties are NOT allowed.
object [Code]
Data about source code

repositoryType
string
Default value:"git"
Examples values:
"svn"
"mercurial"
repositoryUrl
string
format: uri
licenseType
string
Default value:"MIT"
Examples values:
"BSD-3-Clause"
"ISC"
licenseUrl
string
format: uri
Default value:"https://opensource.org/licenses/MIT"
Additional properties are NOT allowed.
Additional properties are NOT allowed.

Operations

SEND iqb_data_structures

Examples

Schemas