Improve Dropbox Watch Agent event payload documentation.

Guilherme J. Tramontina 10 年之前
父節點
當前提交
5da7832025
共有 1 個文件被更改,包括 11 次插入8 次删除
  1. 11 8
      app/models/agents/dropbox_watch_agent.rb

+ 11 - 8
app/models/agents/dropbox_watch_agent.rb

@@ -9,14 +9,17 @@ module Agents
9 9
     MD
10 10
 
11 11
     event_description <<-MD
12
-      The event payload will contain the following fields, when applicable:
13
-      ```
14
-      {
15
-        "added": [ "path/to/new/file" ],
16
-        "removed": [ "path/to/removed/file" ],
17
-        "updated": [ "path/to/updated/file" ]
18
-      }
19
-      ```
12
+      The event payload will contain the following fields:
13
+
14
+          {
15
+            "added": [ {
16
+              "path": "/path/to/added/file",
17
+              "rev": "1526952fd5",
18
+              "modified": "Fri, 10 Oct 2014 19:00:43 +0000"
19
+            } ],
20
+            "removed": [ … ],
21
+            "updated": [ … ]
22
+          }
20 23
     MD
21 24
 
22 25
     def default_options