From 7f2da755c21c8e33e6b88d9839daf3eef5ecd6be Mon Sep 17 00:00:00 2001 From: Bryan Strassner Date: Sat, 27 Jan 2018 18:23:52 -0600 Subject: [PATCH] Add diagnostic field info for ValidationMessage Change-Id: Id7a936b9d8cfaacf2b878f0c8bec128fcc998fce --- docs/source/api-conventions.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/api-conventions.rst b/docs/source/api-conventions.rst index 4568a246..98c1e890 100644 --- a/docs/source/api-conventions.rst +++ b/docs/source/api-conventions.rst @@ -230,6 +230,8 @@ ValidationMessage: name that identifies the validation among a full set of validations. It is preferred to use non-action words to identify the validation. E.g. "MTU in bounds" is preferred instead of "Check MTU in bounds" +- diagnostic (optional): Provides further contextual information that may help + with determining the source of the validation or provide further details. Health Check API ----------------