Bug 1511945 - Mark some cloud file provider properties as deprecated in the schema. r=philipp a=jorgk
authorGeoff Lankow <geoff@darktrojan.net>
Wed, 06 Feb 2019 12:14:17 +1300
changeset 34340 543cc9e2a444a74e035224aca7f1ea77bbcfe05d
parent 34339 7316649f4ef849c3b2d653d69134a954e43fce11
child 34341 d18975332fe6db31ca7542f63d75782494de42d7
push id389
push userclokep@gmail.com
push dateMon, 18 Mar 2019 19:01:53 +0000
reviewersphilipp, jorgk
bugs1511945
Bug 1511945 - Mark some cloud file provider properties as deprecated in the schema. r=philipp a=jorgk
mail/components/extensions/schemas/cloudFile.json
--- a/mail/components/extensions/schemas/cloudFile.json
+++ b/mail/components/extensions/schemas/cloudFile.json
@@ -8,35 +8,43 @@
           "cloud_file": {
             "type": "object",
             "additionalProperties": {
               "$ref": "UnrecognizedProperty"
             },
             "properties": {
               "name": {
                 "type": "string",
-                "preprocess": "localize"
+                "preprocess": "localize",
+                "description": "Name of the cloud file service."
               },
               "service_url": {
                 "type": "string",
-                "optional": true
+                "optional": true,
+                "description": "URL to the web page of the cloud file service."
               },
               "new_account_url": {
                 "type": "string",
-                "optional": true
+                "optional": true,
+                "deprecated": true,
+                "description": "This property was never used."
               },
               "settings_url": {
                 "type": "string",
                 "format": "relativeUrl",
-                "preprocess": "localize"
+                "preprocess": "localize",
+                "optional": true,
+                "deprecated": true,
+                "description": "A page for configuring accounts, this is obsolete after Thunderbird 60."
               },
               "management_url": {
                 "type": "string",
                 "format": "relativeUrl",
-                "preprocess": "localize"
+                "preprocess": "localize",
+                "description": "A page for configuring accounts, to be displayed in the preferences UI."
               }
             },
             "optional": true
           }
         }
       }
     ]
   },
@@ -84,17 +92,18 @@
           {
             "name": "account",
             "$ref": "CloudFileAccount",
             "description": "The created account"
           },
           {
             "type": "integer",
             "name": "fileId",
-            "minimum": 1
+            "minimum": 1,
+            "description": "An identifier for this file"
           }
         ]
       },
       {
         "name": "onFileDeleted",
         "type": "function",
         "description": "Fired when a file previously uploaded should be deleted",
         "parameters": [
@@ -102,17 +111,17 @@
             "name": "account",
             "$ref": "CloudFileAccount",
             "description": "The created account"
           },
           {
             "type": "integer",
             "name": "fileId",
             "minimum": 1,
-            "description": "An identifier for this file, TODO might go away"
+            "description": "An identifier for this file"
           }
         ]
       },
       {
         "name": "onAccountAdded",
         "type": "function",
         "description": "Fired when a cloud file account of this add-on was created",
         "parameters": [
@@ -138,17 +147,18 @@
     ],
     "types": [
       {
         "id": "CloudFileAccount",
         "type": "object",
         "description": "Information about a cloud file account",
         "properties": {
           "id": {
-            "type": "string"
+            "type": "string",
+            "description": "Unique identifier of the account"
           },
           "configured": {
             "type": "boolean",
             "description": "If true, the account is configured and ready to use. This property is currently ignored and all accounts are assumed to be configured."
           },
           "name": {
             "type": "string",
             "description": "A user-friendly name for this account."
@@ -168,55 +178,63 @@
           "spaceUsed": {
             "type": "integer",
             "minimum": -1,
             "optional": true,
             "description": "The amount of space already used on the cloud provider, in bytes. Set to -1 if unsupported."
           },
           "managementUrl": {
             "type": "string",
-            "format": "relativeUrl"
+            "format": "relativeUrl",
+            "description": "A page for configuring accounts, to be displayed in the preferences UI."
           },
           "settingsUrl": {
             "type": "string",
-            "format": "relativeUrl"
+            "format": "relativeUrl",
+            "optional": true,
+            "deprecated": true,
+            "description": "A page for configuring accounts, this is obsolete after Thunderbird 60."
           }
         }
       },
       {
         "id": "CloudFile",
         "type": "object",
         "description": "Information about a cloud file",
         "properties": {
           "id": {
             "type": "integer",
-            "minimum": 1
+            "minimum": 1,
+            "description": "An identifier for this file"
           },
           "name": {
-            "type": "string"
+            "type": "string",
+            "description": "Filename of the file to be transferred"
           },
           "data": {
             "type": "object",
             "isInstanceOf": "ArrayBuffer",
-            "additionalProperties": true
+            "additionalProperties": true,
+            "description": "Contents of the file to be transferred"
           }
         }
       }
     ],
     "functions": [
       {
         "name": "getAccount",
         "type": "function",
         "description": "Retrieve information about a single cloud file account",
         "allowedContexts": ["content"],
         "async": true,
         "parameters": [
           {
             "name": "accountId",
-            "type": "string"
+            "type": "string",
+            "description": "Unique identifier of the account"
           }
         ]
       },
       {
         "name": "getAllAccounts",
         "type": "function",
         "description": "Retrieve all cloud file accounts for the current add-on",
         "allowedContexts": ["content"],
@@ -227,17 +245,18 @@
         "name": "updateAccount",
         "type": "function",
         "description": "Update a cloud file account",
         "allowedContexts": ["content"],
         "async": true,
         "parameters": [
           {
             "name": "accountId",
-            "type": "string"
+            "type": "string",
+            "description": "Unique identifier of the account"
           },
           {
             "name": "updateProperties",
             "type": "object",
             "properties": {
               "configured": {
                 "type": "boolean",
                 "optional": true,
@@ -259,22 +278,25 @@
                 "type": "integer",
                 "minimum": -1,
                 "optional": true,
                 "description": "The amount of space already used on the cloud provider, in bytes. Set to -1 if unsupported."
               },
               "managementUrl": {
                 "type": "string",
                 "format": "relativeUrl",
-                "optional": true
+                "optional": true,
+                "description": "A page for configuring accounts, to be displayed in the preferences UI."
               },
               "settingsUrl": {
                 "type": "string",
                 "format": "relativeUrl",
-                "optional": true
+                "optional": true,
+                "deprecated": true,
+                "description": "A page for configuring accounts, this is obsolete after Thunderbird 60."
               }
             }
           }
         ]
       }
     ]
   }
 ]