Basic alerts api documentation

This commit is contained in:
emanuele-f 2019-06-28 12:17:03 +02:00
parent d25c8e638a
commit e78039c2f2
2 changed files with 63 additions and 63 deletions

View file

@ -40,6 +40,15 @@ end
-- ##############################################
--
-- Creates a alert object
--
-- Metadata is a table which contains the following mandatory parameters:
-- - entity: the entity type
-- - type: the type of the alert
-- - severity the alert severity
-- See https://github.com/ntop/ntopng/blob/dev/doc/README.alerts for more details
--
function alerts:newAlert(metadata)
if(metadata == nil) then
alertErrorTraceback("alerts:newAlert() missing argument")