From c4510c1abf2c353a55f2a7dc91ffba6c42c9d247 Mon Sep 17 00:00:00 2001 From: David Jay Date: Tue, 20 Dec 2016 13:43:38 -0800 Subject: [PATCH] Updating action documentation. --- client/coral-framework/actions/items.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/client/coral-framework/actions/items.js b/client/coral-framework/actions/items.js index 160dcb24c..243429863 100644 --- a/client/coral-framework/actions/items.js +++ b/client/coral-framework/actions/items.js @@ -208,7 +208,9 @@ export function postItem (item, type, id) { * * @params * id - the id of the item on which the action is taking place -* action - the name of the action +* action - the action object. +* Must include an 'action_type' string. +* May optionally include a `metadata` object with arbitrary action data. * user - the user performing the action * host - the coral host *