Skip to content

Commit

Permalink
README.md: document events
Browse files Browse the repository at this point in the history
Signed-off-by: Felix Fietkau <nbd@nbd.name>
  • Loading branch information
nbd168 committed Feb 15, 2017
1 parent 73012c4 commit c0b11c5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Expand Up @@ -30,6 +30,22 @@ Object: scald

Example: { "models": { "tr-181": { "plugins": [ "example" ] } } }

The object will send out notifications for changes made to the data model.
The notify type describes the change type: ("set", "add", "remove")
They contain the following fields:
- plugin:
Name of the plugin providing the object/parameter being accessed
- model:
Name of the affected data model
- path:
Path to the object
- param:
Name of the affected parameter
- value:
New value of the affected parameter

The same events can also be received on a per-datamodel basis on the
data model object described below.

Object: scald.<datamodel>
All methods that refer to an object (or an object path) take a string array
Expand Down

0 comments on commit c0b11c5

Please sign in to comment.