Format
Interfaces are described using a JSON document. Each interface is identified by an unique interface name of maximum 128 characters, which must be a Reverse Domain Name. As a convention, the interface name usually contains its author's URI Reverse Internet Domain Name.
An example skeleton looks like this:
{
"interface_name": "com.test.MyInterfaceName",
"version_major": 1,
"version_minor": 0,
"type": "datastream",
"ownership": "device",
"aggregation": "individual",
"mappings": [...]
}
Valid values and variables are listed in the Interface Schema.
Name limitations
A valid interface name consists of a Reverse Domain Name containing alphanumeric characters, hyphens and dots. By design, both the top level domain and last domain component cannot contain hyphens, although hypens are allowed in other parts of the interface name (e.g.: org.astarte-platform.Values is a valid interface name).
Interface names have to be fully-defined Reverse Domain Names. Values will not be accepted as an Data Orchestrator interface name, whereas org.astarte-platform.Values is a valid one.
Interface's uniqueness is also case insensitive. This means you cannot install two interfaces with the same name and different casing (e.g.: org.astarte-platform.MyValues and org.astarte-platform.Myvalues). This also applies to Major versioning: interfaces sharing the same name, even with a different major version, cannot have different casing.
Although not enforced, naming conventions for Data Orchestrator Interfaces require lowercasing for anything but the last part of the Interface name, which should be CamelCase.
Examples of names following conventions are:
org.astarte-platform.ValidInterfaceNameorg.astarte-platform.conventions.satisfied.ValidInterfaceNameorg.astarte-platform.conventions-satisfied.ValidInterfaceName
While examples of names not following conventions are:
org.astarte-platform.validInterfaceNameorg.astarte-platform.Conventions.NotSatisfied.ValidInterfaceNameorg.astarte-platform.Conventions.not-satisfied.ValidInterfaceName