arno/clair
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

readme: clarify "marked as read" notifications

Browse Source
This commit is contained in:
Jimmy Zelinskie 2016-02-25 13:49:24 -05:00
parent d1e9a21e0e
commit 2140995a54
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api/v1/README.md
View File

@ -560,6 +560,7 @@ Server: clair
###### Description ###### Description
The delete route for the Notifications resource marks a Notification as read. 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. 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 ###### Example Request

5
notifier/README.md
View File

@ -1,8 +1,9 @@
# Notifications # Notifications
Notifications are a way for Clair to inform an endpoint that changes to tracked vulnerabilities have occurred. 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, Clair should only send 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. 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 ## Webhook