From cdfdb2dd2e81c910b408e4848baf0211eee3df6b Mon Sep 17 00:00:00 2001
From: Mark Burnett <mark.m.burnett@gmail.com>
Date: Sat, 15 Jul 2017 21:22:17 -0500
Subject: [PATCH] Move reporting of validation status

Moving status indications of individual validations into the tree of
each validationPolicy is necessary, because the validation may have
different expiration times for the different policies that rely on it.
---
 docs/design.md | 34 +++++++++++++++++-----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

diff --git a/docs/design.md b/docs/design.md
index 3341ea0b..b11e945b 100644
--- a/docs/design.md
+++ b/docs/design.md
@@ -426,26 +426,26 @@ validationPolicies:
   site-deploy-validation:
     url: https://deckhand/revisions/0/documents?schema=deckhand/ValidationPolicy/v1&name=site-deploy-validation
     status: failed
-    validationNames:
-      - deckhand-schema-validation
-      - drydock-site-validation
-      - promenade-site-validation
-      - armada-deployability-validation
-validations:
-  deckhand-schema-validation:
-    url: https://deckhand/revisions/0/validations/deckhand-schema-validation/0
-    status: success
-  drydock-site-validation:
-    status: missing
-  promenade-site-validation:
-    url: https://deckhand/revisions/0/validations/promenade-site-validation/0
-    status: expired
-  armada-deployability-validation:
-    url: https://deckhand/revisions/0/validations/armada-deployability-validation/0
-    status: failed
+    validations:
+      - name: deckhand-schema-validation
+        url: https://deckhand/revisions/0/validations/deckhand-schema-validation/0
+        status: success
+      - name: drydock-site-validation
+        status: missing
+      - name: promenade-site-validation
+        url: https://deckhand/revisions/0/validations/promenade-site-validation/0
+        status: expired
+      - name: armada-deployability-validation
+        url: https://deckhand/revisions/0/validations/armada-deployability-validation/0
+        status: failed
 ...
 ```
 
+Validation status is always for the most recent entry for a given validation.
+A status of `missing` indicates that no entries have been created. A status
+of `expired` indicates that the validation had succeeded, but the
+`expiresAfter` limit specified in the `ValidationPolicy` has been exceeded.
+
 ### POST `/revisions/{{revision_id}}/validations/{{name}}`
 
 Add the results of a validation for a particular revision.