airship
/
airship-in-a-bottle
Code Issues Proposed changes

Add diagnostic field info for ValidationMessage 

Change-Id: Id7a936b9d8cfaacf2b878f0c8bec128fcc998fce
This commit is contained in:
Bryan Strassner 2018-01-27 18:23:52 -06:00
parent d0bc4e28fd
commit 7f2da755c2
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/api-conventions.rst
View File

@ -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
----------------