metadata
The metadata section allows you to specify further information about your service in a structured way.
Properties
Property | Type | Required |
---|---|---|
| Optional | |
| Optional | |
| Required | |
| Optional | |
| Optional |
homepage
URL to the homepage of the provider
is optional
type:
string
format:
uri
– Uniformous Resource Identifier (according to RFC3986)
icon
A link to an icon image typically used in UI representation
is optional
type:
string
name
A short title typically used in UI representation.
It is allowed to use parameter substitutions in this property, for example setting it to !sub 'Machine ${machineNum}'
if there exists a parameter machineNum.
The auto-generated default Service ID will be generated from this string by removing all characters that are not allowed for the Service ID. For backward-compatibility reasons, in Connectware version 1.0.x all characters are changed to lowercase and also all punctuation is removed, including underscore and period.
required
type:
string
maximum length: 80 characters
provider
The provider/author of the this service commissioning file
is optional
type:
string
version
Semantic version of the service. The version identifies the capabilities of the commissioning file. The latest version is 1 and is the only valid value.
is optional
type:
string
Example
Last updated