Node

Summary

Below is the list of all available options to define a Node in the schema

Name	Type	Description	Mandatory
branch	Attribute	Type of branch support for the model.	False
children	Attribute	Expected Kind for the children nodes in a Hierarchy, default to the main generic defined if not defined.	False
default_filter	Attribute	Default filter used to search for a node in addition to its ID. (deprecated: please use human_friendly_id instead)	False
description	Attribute	Short description of the model, will be visible in the frontend.	False
display_label	Attribute	Attribute or Jinja2 template to use to generate the display label	False
display_labels	Attribute	List of attributes to use to generate the display label (deprecated)	False
documentation	Attribute	Link to a documentation associated with this object, can be internal or external.	False
generate_profile	Attribute	Indicate if a profile schema should be generated for this schema	False
generate_template	Attribute	Indicate if an object template schema should be generated for this schema	False
hierarchy	Attribute	Internal value to track the name of the Hierarchy, must match the name of a Generic supporting hierarchical mode	False
human_friendly_id	Attribute	Human friendly and unique identifier for the object.	False
icon	Attribute	Defines the icon to use in the menu. Must be a valid value from the MDI library https://icon-sets.iconify.design/mdi/	False
include_in_menu	Attribute	Defines if objects of this kind should be included in the menu.	False
inherit_from	Attribute	List of Generic Kind that this node is inheriting from	False
label	Attribute	Human friendly representation of the name/kind	False
menu_placement	Attribute	Defines where in the menu this object should be placed.	False
name	Attribute	Node name, must be unique within a namespace and must start with an uppercase letter.	True
namespace	Attribute	Node Namespace, Namespaces are used to organize models into logical groups and to prevent name collisions.	True
order_by	Attribute	List of attributes to use to order the results by default	False
parent	Attribute	Expected Kind for the parent node in a Hierarchy, default to the main generic defined if not defined.	False
state	Attribute	Expected state of the node/generic after loading the schema	False
uniqueness_constraints	Attribute	List of multi-element uniqueness constraints that can combine relationships and attributes	False
attributes	Relationship	List of supported Attributes for the Node.	False
relationships	Relationship	List of supported Relationships for the Node.	False

Reference Guide

branch

Key	Value
Name	branch
Kind	Text
Description	Type of branch support for the model.
Optional	True
Default Value	aware
Constraints
Accepted Values	aware agnostic local

children

Key	Value
Name	children
Kind	Text
Description	Expected Kind for the children nodes in a Hierarchy, default to the main generic defined if not defined.
Optional	True
Default Value
Constraints

default_filter

Key	Value
Name	default_filter
Kind	Text
Description	Default filter used to search for a node in addition to its ID. (deprecated: please use human_friendly_id instead)
Optional	True
Default Value
Constraints	Regex: ^[a-z0-9\_]*$

description

Key	Value
Name	description
Kind	Text
Description	Short description of the model, will be visible in the frontend.
Optional	True
Default Value
Constraints	Length: min -, max 128

display_label

Key	Value
Name	display_label
Kind	Text
Description	Attribute or Jinja2 template to use to generate the display label
Optional	True
Default Value
Constraints

display_labels

Key	Value
Name	display_labels
Kind	List
Description	List of attributes to use to generate the display label (deprecated)
Optional	True
Default Value
Constraints

documentation

Key	Value
Name	documentation
Kind	URL
Description	Link to a documentation associated with this object, can be internal or external.
Optional	True
Default Value
Constraints

generate_profile

Key	Value
Name	generate_profile
Kind	Boolean
Description	Indicate if a profile schema should be generated for this schema
Optional	True
Default Value	True
Constraints

generate_template

Key	Value
Name	generate_template
Kind	Boolean
Description	Indicate if an object template schema should be generated for this schema
Optional	True
Default Value	False
Constraints

hierarchy

Key	Value
Name	hierarchy
Kind	Text
Description	Internal value to track the name of the Hierarchy, must match the name of a Generic supporting hierarchical mode
Optional	True
Default Value
Constraints

human_friendly_id

Key	Value
Name	human_friendly_id
Kind	List
Description	Human friendly and unique identifier for the object.
Optional	True
Default Value
Constraints

icon

Key	Value
Name	icon
Kind	Text
Description	Defines the icon to use in the menu. Must be a valid value from the MDI library https://icon-sets.iconify.design/mdi/
Optional	True
Default Value
Constraints

include_in_menu

Key	Value
Name	include_in_menu
Kind	Boolean
Description	Defines if objects of this kind should be included in the menu.
Optional	True
Default Value	True
Constraints

inherit_from

Key	Value
Name	inherit_from
Kind	List
Description	List of Generic Kind that this node is inheriting from
Optional	True
Default Value
Constraints

label

Key	Value
Name	label
Kind	Text
Description	Human friendly representation of the name/kind
Optional	True
Default Value
Constraints	Length: min -, max 64

menu_placement

Key	Value
Name	menu_placement
Kind	Text
Description	Defines where in the menu this object should be placed.
Optional	True
Default Value
Constraints

name

Key	Value
Name	name
Kind	Text
Description	Node name, must be unique within a namespace and must start with an uppercase letter.
Optional	False
Default Value
Constraints	Regex: ^[A-Z][a-zA-Z0-9]+$ Length: min 2, max 32

namespace

Key	Value
Name	namespace
Kind	Text
Description	Node Namespace, Namespaces are used to organize models into logical groups and to prevent name collisions.
Optional	False
Default Value
Constraints	Regex: ^[A-Z][a-z0-9]+$ Length: min 3, max 64

order_by

Key	Value
Name	order_by
Kind	List
Description	List of attributes to use to order the results by default
Optional	True
Default Value
Constraints

parent

Key	Value
Name	parent
Kind	Text
Description	Expected Kind for the parent node in a Hierarchy, default to the main generic defined if not defined.
Optional	True
Default Value
Constraints

state

Key	Value
Name	state
Kind	Text
Description	Expected state of the node/generic after loading the schema
Optional	True
Default Value	present
Constraints
Accepted Values	present absent

uniqueness_constraints

Key	Value
Name	uniqueness_constraints
Kind	List
Description	List of multi-element uniqueness constraints that can combine relationships and attributes
Optional	True
Default Value
Constraints

attributes

Key	Value
Name	attributes
Kind	List
Description	List of supported Attributes for the Node.

relationships

Key	Value
Name	relationships
Kind	List
Description	List of supported Relationships for the Node.