YAML Model Support

Synopsis

Overview

File Extension yaml, yml
Example Link
Supporting Tool(s) https://onlineyamltools.com/edit-yaml http://www.yamllint.com/
Purpose
Application Refactoring New Application
NO YES

Specification

entities

An entity is any important non technical thing that is used by an application.

field required Description
name Yes Unique name amongst entities
parentName No Must be an entity found in the model
data
name Yes Unique name amongst data for this entity
type No If not provided, defaults to String Options:
  • String
  • int
  • double
  • float
  • boolean
  • Date
  • Any enum defined within the model
defaultValue No If not assigned, defaults to an empty value
relations
name Yes Uniquely named amongst relations for this entity
type Yes Any entity defined within the model
multiplicity No If none assigned, defaults to OneToOne, Options:
  • OneToOne
  • OneToMany
  • ManyToOne
  • ManyToMany

enums

An enum or enumerated type is a type whose legal values consist of a fixed set of constants. Common examples include compass directions, which take the values North, South, East and West.

field required Description
name Yes Unique name amongst enums
data
name Yes Unique amongst data for this enum