readme: clarify "marked as read" notifications

quay · Feb 25, 2016 · 2140995 · 2140995
1 parent d1e9a21
commit 2140995
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/api/v1/README.md b/api/v1/README.md
@@ -560,6 +560,7 @@ Server: clair
 ###### Description
 
 The delete route for the Notifications resource marks a Notification as read.
+If a notification is not marked as read, Clair will continue to notify the provided endpoints.
 The time at which this Notification was marked as read can be seen in the `Notified` property of the response GET route for Notification.
 
 ###### Example Request

diff --git a/notifier/README.md b/notifier/README.md
@@ -1,8 +1,9 @@
 # Notifications
 
 Notifications are a way for Clair to inform an endpoint that changes to tracked vulnerabilities have occurred.
-Notifications should contain only the name of a notification.
-Because notification data can require pagination, it is expected that the receiving endpoint calls the Clair API for reading notifications and marking them as read after being notified.
+Because notification data can require pagination, Clair should only send the name of a notification.
+It is expected that the receiving endpoint calls the Clair API for reading notifications and marking them as read after being notified.
+If the notification is never marked as read, Clair will continue attempting to send the same notification to the endpoint indefinitely.
 
 ## Webhook