Change format of the empty status message
authorMichele Tartara <mtartara@google.com>
Thu, 7 Mar 2013 17:36:42 +0000 (18:36 +0100)
committerMichele Tartara <mtartara@google.com>
Thu, 28 Mar 2013 13:11:55 +0000 (14:11 +0100)
Having 'null' instead of an empty string for an empty status message
increases the complexity of the code with no real improvement.

This patch modifies the monitoring agent design document solving this issue.

Signed-off-by: Michele Tartara <mtartara@google.com>
Reviewed-by: Bernardo Dal Seno <bdalseno@google.com>

doc/design-monitoring-agent.rst

index 8bcec6f..13702f5 100644 (file)
@@ -197,8 +197,9 @@ in its ``data`` section, at least the following field:
     A message to better explain the reason of the status.
     The exact format of the message string is data collector dependent.
 
-    The field is mandatory, but the content can be ``null`` if the code is
-    ``0`` (working as intended) or ``1`` (being fixed automatically).
+    The field is mandatory, but the content can be an empty string if the
+    ``code`` is ``0`` (working as intended) or ``1`` (being fixed
+    automatically).
 
     If the status code is ``2``, the message should specify what has gone
     wrong.