Bug 1503501 - Minor changes to addressBook API documentation; r=me
authorGeoff Lankow <geoff@darktrojan.net>
Tue, 13 Nov 2018 21:42:21 +1300
changeset 33850 fae04892480f29b9c9ecc7921954989c0e9f91b4
parent 33849 dc28b75394da57d8a5601382e3e6a4bda010007f
child 33851 c665681e7f02fa6bf60236e918576fc039b6f060
push id388
push userclokep@gmail.com
push dateMon, 28 Jan 2019 20:54:56 +0000
reviewersme
bugs1503501
Bug 1503501 - Minor changes to addressBook API documentation; r=me
mail/components/extensions/schemas/addressBook.json
mail/components/extensions/schemas/browserAction.json
--- a/mail/components/extensions/schemas/addressBook.json
+++ b/mail/components/extensions/schemas/addressBook.json
@@ -24,17 +24,17 @@
       {
         "id": "NodeType",
         "type": "string",
         "enum": [
           "addressBook",
           "contact",
           "mailingList"
         ],
-        "description": "Indicates the type of a Node, which can be one of addressBook, contact, or mailingList."
+        "description": "Indicates the type of a Node, which can be one of <code>addressBook</code>, <code>contact</code>, or <code>mailingList</code>."
       },
       {
         "id": "AddressBookNode",
         "type": "object",
         "description": "A node representing an address book.",
         "properties": {
           "id": {
             "type": "string",
@@ -42,39 +42,39 @@
           },
           "parentId": {
             "type": "string",
             "optional": true,
             "description": "The <code>id</code> of the parent object."
           },
           "type": {
             "$ref": "NodeType",
-            "description": "Indicates the type of a Node, which can be one of addressBook, contact, or mailingList."
+            "description": "Always set to <code>addressBook</code>."
           },
           "readOnly": {
             "type": "boolean",
             "optional": true,
             "description": "Indicates if the object is read-only. Currently this returns false in all cases, as read-only address books are ignored by the API."
           },
           "name": {
             "type": "string"
           },
           "contacts": {
             "type": "array",
             "optional": true,
             "items": {
-              "$ref": "Node"
+              "$ref": "contacts.ContactNode"
             },
             "description": "A list of contacts held by this node's address book or mailing list."
           },
           "mailingLists": {
             "type": "array",
             "optional": true,
             "items": {
-              "$ref": "Node"
+              "$ref": "mailingLists.MailingListNode"
             },
             "description": "A list of mailingLists in this node's address book."
           }
         }
       }
     ],
     "functions": [
       {
@@ -227,18 +227,18 @@
             "description": "The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the program is restarted."
           },
           "parentId": {
             "type": "string",
             "optional": true,
             "description": "The <code>id</code> of the parent object."
           },
           "type": {
-            "$ref": "NodeType",
-            "description": "Indicates the type of a Node, which can be one of addressBook, contact, or mailingList."
+            "$ref": "addressBooks.NodeType",
+            "description": "Always set to <code>contact</code>."
           },
           "readOnly": {
             "type": "boolean",
             "optional": true,
             "description": "Indicates if the object is read-only. Currently this returns false in all cases, as read-only address books are ignored by the API."
           },
           "properties": {
             "$ref": "ContactProperties"
@@ -393,18 +393,18 @@
             "description": "The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the program is restarted."
           },
           "parentId": {
             "type": "string",
             "optional": true,
             "description": "The <code>id</code> of the parent object."
           },
           "type": {
-            "$ref": "NodeType",
-            "description": "Indicates the type of a Node, which can be one of addressBook, contact, or mailingList."
+            "$ref": "addressBooks.NodeType",
+            "description": "Always set to <code>mailingList</code>."
           },
           "readOnly": {
             "type": "boolean",
             "optional": true,
             "description": "Indicates if the object is read-only. Currently this returns false in all cases, as read-only address books are ignored by the API."
           },
           "name": {
             "type": "string"
@@ -414,17 +414,17 @@
           },
           "description": {
             "type": "string"
           },
           "contacts": {
             "type": "array",
             "optional": true,
             "items": {
-              "$ref": "Node"
+              "$ref": "contacts.ContactNode"
             },
             "description": "A list of contacts held by this node's address book or mailing list."
           }
         }
       }
     ],
     "functions": [
       {
@@ -606,17 +606,17 @@
       },
       {
         "name": "onMemberAdded",
         "type": "function",
         "description": "Fired when a contact is added to the mailing list.",
         "parameters": [
           {
             "name": "node",
-            "$ref": "ContactNode"
+            "$ref": "contacts.ContactNode"
           }
         ]
       },
       {
         "name": "onMemberRemoved",
         "type": "function",
         "description": "Fired when a contact is removed from the mailing list.",
         "parameters": [
--- a/mail/components/extensions/schemas/browserAction.json
+++ b/mail/components/extensions/schemas/browserAction.json
@@ -32,19 +32,18 @@
                 "preprocess": "localize"
               },
               "browser_style": {
                 "type": "boolean",
                 "optional": true,
                 "default": false
               },
               "default_area": {
-                "description": "Defines the location the browserAction will appear by default.  The default location is navbar.",
+                "description": "Currently unused.",
                 "type": "string",
-                "enum": [],
                 "optional": true
               }
             },
             "optional": true
           }
         }
       }
     ]