Skip to content

Schema Definition: com.lawo.emberplus.labels

Benoit Quiniou edited this page May 20, 2021 · 2 revisions

General

This schema is intended to provide a standard way for an Ember+ provider to publish labels for entities like channels or signals.

Changes

Version 1.0

Initial schema definition.

Identifier

The identifier of this schema is com.lawo.emberplus.labels.v<VERSIONMAJOR>.<VERSIONMINOR>
The current major version is: 1
The current minor version is: 0

A consumer implementing this schema may expect that future versions of this schema are backwards compatible to the one it implements if the major version number is unchanged and the minor version number is greater than the one it implements. Changes to the major version number must be considered breaking changes.

Scope

This schema defines the layout of an Ember+ node, defining the parameters it must contain as direct children.

Rules

An Ember+ node that implements this schema MUST contain two parameters:

  1. Name: startup
    Type: STRING
    Access: Read Only or Read / Write
    The initial label of this entity, intended to be provided by the system and not supposed to be changed by the user. This label can be used as a reference to find the entity, whatever are the possible ways for the user to give it a user-defined label.

  2. Name: user
    Type: STRING
    Access: Read Only or Read / Write
    The user-defined label of this entity, intended to be provided and modified by the user.

In addition the node MAY contain any additional parameters.