From 67225b3a4bdc09986da7cdf1a125d610862fece3 Mon Sep 17 00:00:00 2001 From: David Jay Date: Tue, 20 Dec 2016 13:39:04 -0800 Subject: [PATCH] Updating documentation for actions. --- docs/swagger.yaml | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/swagger.yaml b/docs/swagger.yaml index f6aba4d25..808e11dfd 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -458,14 +458,22 @@ definitions: properties: item_id: type: string + description: The ID of the item which these actions target item_type: - type: string # comment, user... + type: string + description: The type of item which these actions target (comment, user, etc.) type: - type: string # flagged, likes, upvotes... + type: string + description: The type of action (like, flag, etc.) count: type: integer + description: The number of this type of actions performed on this item. + metadata: + type: array + description: An array of metadata from the actions performed on this item. This metadata can be defined differently for each action type. current_user: - type: boolean + type: Object + description: Will include the action performed by the currently logged in user if that user has taken an action on this item. Otherwise will return null. Action: type: object properties: