From 3d13e11e13c40694e424be468c9fca60c90bae5c Mon Sep 17 00:00:00 2001 From: Marcel Date: Sun, 4 Jan 2015 17:14:17 +0100 Subject: [PATCH] added documentation schema for fields --- structure-schema.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/structure-schema.yml b/structure-schema.yml index 449c7c5..a9439f4 100644 --- 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