From 54d15ab5c587673248c8cf98825462d922eb6f52 Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Sun, 17 Feb 2019 12:13:06 +0100
Subject: [PATCH] src/api_schema/schema.rs: improve docu

---
 src/api_schema/schema.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/api_schema/schema.rs b/src/api_schema/schema.rs
index 86e786d1..fbe2c839 100644
--- a/src/api_schema/schema.rs
+++ b/src/api_schema/schema.rs
@@ -11,6 +11,14 @@ pub struct ParameterError {
     error_list: Vec<Error>,
 }
 
+/// Error type for schema validation
+///
+/// The validation functions may produce several error message,
+/// i.e. when validation objects, it can produce one message for each
+/// erroneous object property.
+
+// fixme: record parameter names, to make it usefull to display errord
+// on HTML forms.
 impl ParameterError {
 
     pub fn new() -> Self {