Bug 1451767 - Add missing type in events API schema examples from the WebExtensions docs. draft
authorLuca Greco <lgreco@mozilla.com>
Thu, 05 Apr 2018 16:31:00 +0200
changeset 777932 eab1b959731a4b4aad0632a5d2afa9fbb5ac042a
parent 777823 1b258f938525fda65ef80ffa0408bc665d5d8948
push id105341
push userluca.greco@alcacoop.it
push dateThu, 05 Apr 2018 15:22:31 +0000
bugs1451767
milestone61.0a1
Bug 1451767 - Add missing type in events API schema examples from the WebExtensions docs. MozReview-Commit-ID: Job5tZbiwWm
toolkit/components/extensions/docs/events.rst
--- a/toolkit/components/extensions/docs/events.rst
+++ b/toolkit/components/extensions/docs/events.rst
@@ -10,16 +10,17 @@ The definition for a simple event looks 
 .. code-block:: json
 
    [
      {
        "namespace": "myapi",
        "events": [
          {
            "name": "onSomething",
+           "type": "function",
            "description": "Description of the event",
            "parameters": [
              {
                "name": "param1",
                "description": "Description of the first callback parameter",
                "type": "number"
              }
            ]
@@ -121,16 +122,17 @@ the ``extraParameters`` property.  For e
 .. code-block:: json
 
    [
      {
        "namespace": "myapi",
        "events": [
          {
            "name": "onSomething",
+           "type": "function",
            "description": "Description of the event",
            "parameters": [
              {
                "name": "param1",
                "description": "Description of the first callback parameter",
                "type": "number"
              }
            ],
@@ -181,16 +183,17 @@ This can be defined in the schema with t
 .. code-block:: json
 
    [
      {
        "namespace": "myapi",
        "events": [
          {
            "name": "onSomething",
+           "type": "function",
            "description": "Description of the event",
            "parameters": [
              {
                "name": "param1",
                "description": "Description of the first callback parameter",
                "type": "number"
              }
            ],