added documentation schema for fields

2015-01-04 17:14:17 +01:00 · 2015-01-04 17:14:17 +01:00 · 3d13e11e13
parent e0f4ed4034
commit 3d13e11e13
1 changed files with 16 additions and 1 deletions
--- a/structure-schema.yml
+++ b/structure-schema.yml
@ -79,4 +79,19 @@ mapping:
                  "fields":
                    type: seq
                    sequence: *fieldsseq
-      #"documentation":  #todo!
+      "documentation": 
+        type: map
+        mapping:
+          "summary": # a summary about this protocol (optional)
+            type: str
+          "descriptions": # descriptions of the fields
+            type: seq
+            sequence:
+              - type: map
+                mapping:
+                  "field":  # field name as defined in the protocol structure
+                    type: str
+                    required: yes
+                  "desc":   # description 
+                    type: str
+                    required: yes