Documentation

gitHub

YAML file

Hackolade dynamically generates a sample document in JSON or YAML as you construct the document fields and structure.  You may even define the sample data you wish to see appear in that sample document.  The sample document can be viewed in the right-hand pane of the JSON Preview tab:

YAML Document

 

To create a YAML document file of your entity, choose the menu Tools > Forward Engineering > YAML Document:

 

Forward-Engineering - YAML Document

 

In case of a choice (oneOf or anyOf) the following logic is used for the YAML Data document generation:

Subschema for generation is choosing by priority:

  1. Fields with user defined "sample"/"default" property
  2. Non empty "array"/"object" fields 
  3. Any other fields with not “null” YAML Data sample
  4. “Null" fields