Enum Data Type

A enum data type represents a selection of allowed discrete data values.

Features/Limitations

• Supports Referencing Feature. Adds an option to lookup values in other namespaces.
• Data type conversion is not supported

Enum Definition Syntax

Table

Key/Option	Type	Default Value	Restrictions	Description
type	str		'enum'
description	str			Data type description
default_value			Must match data type's type(s)	Value used to set as default value
allowed_values	list			Data must match one of these values
- < value >	any		Must match data type's type(s)
template	str		must be definded in schema	Merge options from this template
template_merge_options	dict			Define schema-global template merge instructions
recursive	bool	True		Merge data type definition options in template options recursively. If false, data type defintion options overwrites template options.
list_merge	str	append_rp	Allowed values: - append - append_rp - prepend - prepend_rp - replace	How lists within options data should be merged.
reference	dict|str
option 1	str			Reference keys (implies unique global mode)
option 2	dict
key	str		required
mode	str		Allowed values: - unique - producer - consumer
unique_scope	str		Allowed values: - global - namespace
producer_scope	str		Allowed values: - global - namespace
consumer_scope	str		Allowed values: - global - namespace
allow_orphan_producer	bool	True
credit	int	1 (if mode consumer)	min: 0
references	list[dict|str]
-	dict|str
option 1	str			Reference keys (implies unique global mode)
option 2	dict
key	str		required
mode	str		Allowed values: - unique - producer - consumer
unique_scope	str		Allowed values: - global - namespace
producer_scope	str		Allowed values: - global - namespace
consumer_scope	str		Allowed values: - global - namespace
allow_orphan_producer	bool	True
credit	int	1 (if mode consumer)	min: 0
doc_value_name	str			Set value name for documentation

YAML

type: enum
description: <str>
default_value: <default_value>

allowed_values:
  - <any>

template: <str>
template_merge_options:
  recursive: <true|false>
  list_merge: <append|append_rp|prepend|prepend_rp|replace>

reference: <reference_definition>
  # Multitype!!!
  <str>
  # or:
  key: <str>
  mode: <unique|producer|consumer>
  unique_scope: <global|namespace>
  producer_scope: <global|namespace>
  consumer_scope: <global|namespace>
  allow_orphan_producer: <true|false>
  credits: <int>
references:
  - <reference_definition>
    # Multitype!!!
    <str>
    # or
    key: <str>
    mode: <unique|producer|consumer>
    unique_scope: <global|namespace>
    producer_scope: <global|namespace>
    consumer_scope: <global|namespace>
    allow_orphan_producer: <true|false>
    credits: <int>

doc_value_name: <str>

Example

type: enum
description: "Example enum definition"
default_value: 1

allowed_values:
  - key1: 1
    key2: string2
  - 1
  - 2
  -
    - nadap
    - rulez!

reference:
  key: ref_key
  mode: producer