diff --git a/api/v1/README.md b/api/v1/README.md index 2206ebcf..27ce7e5a 100644 --- 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 index 21204d7b..90807917 100644 --- 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