From 90a438f760743235b1f92cdddd3142245e981e66 Mon Sep 17 00:00:00 2001
From: Djyp <jp@oclock.io>
Date: Tue, 5 Mar 2019 08:42:35 +0100
Subject: [PATCH] Recipe spec almost done

---
 doc/Models.md | 35 ++++++++++++++++++++++-------------
 1 file changed, 22 insertions(+), 13 deletions(-)

diff --git a/doc/Models.md b/doc/Models.md
index 4a9657c..f2d771a 100644
--- a/doc/Models.md
+++ b/doc/Models.md
@@ -46,7 +46,7 @@ A single ingredient used in the recipe, e.g. sugar, flour or garlic.
 
 ### recipeInstructions
 `String[]`  
-A step in making the recipe, in the form of a single item (document, video, etc.) or an ordered list with HowToStep and/or HowToSection items.
+A step in making the recipe, in the form of a single item (document, video, etc.) or an ordered list with HowToStep and/or HowToSection items.  
 The number of the step should never be the text.
 
 ### recipeYield
@@ -55,7 +55,7 @@ The quantity produced by the recipe (for example, number of people served, numbe
 
 ### suitableForDiet
 `Array` of selected keywords (DiabeticDiet, GlutenFreeDiet, HalalDiet, HinduDiet, KosherDiet, LowCalorieDiet, LowFatDiet, LowLactoseDiet, LowSaltDiet, VeganDiet, VegetarianDiet)  
-Indicates a dietary restriction or guideline for which this recipe or menu item is suitable, e.g. diabetic, halal etc.
+Indicates a dietary restriction or guideline for which this recipe or menu item is suitable, e.g. diabetic, halal etc.  
 TODO : Decide the best way to store the list... maybe in the model
 
 ---
@@ -79,39 +79,48 @@ TODO : define a comment
 A property to be shown in microdata/json-ld but in the model
 
 ### contributor
-If anyone contribute to the recipe they should appear here as a list of users
+Maybe add this later. One of the future features is to let someone edit his own version of a recipe. The original author can know about it, accept the changes and add the contributor to the list. But maybe it's too much...
 
-### dateModified
+### dateModified-
+`DateTime`  
 The most recent modification date
 
 ### datePublished
+`DateTime`  
 The date the first time the recipe appeared online
 
-### dicussionUrl ?
-PROBABLY NOT
+### dicussionUrl
+schema.org value for microdata & JSON-LD linking to the comments section of the recipe
 
 ### licence
+`String`  
+URL of the licence used for the recipe or a string such as "Public domain"
 
-### text ?
+### thumbnailUrl
+schema.org value for microdata & JSON-LD linking to the thumbnail image of the recipe
 
-### thumbnailUrl ?
-
-### version ?
+### version
+Unless there is a versioning system for the recipe there's no point to this
 
 ### description
-
-### identifier ?
+`Text`  
+The context of the recipe : history, source, ideas to serve it, personal notes, etc..
 
 ### image
+`String (255)`  
+URL of the image
 
 ### mainEntityOfPage ?
 
 ### name
+`String (255)`  
 The name of the recipe
 
-### url ?
+### url
+schema.org value for microdata & JSON-LD linking to the url of the recipe, given by the framework's router
 
 ### likesCount
+`Integer`  
 Calculated from the likes in the database
 
 ### difficulty