Bug 1503501 - Improve some accounts API documentation; rs=docs-only
authorGeoff Lankow <geoff@darktrojan.net>
Wed, 16 Jan 2019 17:55:29 +1300
changeset 33359 c145816dfef3
parent 33358 172542e8cd4a
child 33360 e5d328de82da
push id2368
push userclokep@gmail.com
push dateMon, 28 Jan 2019 21:12:50 +0000
treeherdercomm-beta@56d23c07d815 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersdocs-only
bugs1503501
Bug 1503501 - Improve some accounts API documentation; rs=docs-only
mail/components/extensions/schemas/accounts.json
--- a/mail/components/extensions/schemas/accounts.json
+++ b/mail/components/extensions/schemas/accounts.json
@@ -19,27 +19,30 @@
     "namespace": "accounts",
     "permissions": [
       "accountsRead"
     ],
     "types": [
       {
         "id": "MailFolder",
         "type": "object",
-        "description": "A folder object, as returned by the <var>list</var> and <var>get</var> methods.",
+        "description": "A folder object, as returned by the <var>list</var> and <var>get</var> methods. Use the accountId and path properties to refer to a folder.",
         "properties": {
           "accountId": {
-            "type": "string"
+            "type": "string",
+            "description": "The account this folder belongs to."
           },
           "name": {
             "type": "string",
-            "optional": true
+            "optional": true,
+            "description": "The human-friendly name of this folder."
           },
           "path": {
-            "type": "string"
+            "type": "string",
+            "description": "Path to this folder in the account. Although paths look predictable, never guess a folder's path, as there are a number of reasons why it may not be what you think it is."
           }
         }
       }
     ],
     "functions": [
       {
         "name": "list",
         "type": "function",