gecko-dev/browser/components/extensions/schemas/search.json

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

[
  {
    "namespace": "manifest",
    "types": [
      {
        "$extend": "OptionalPermissionNoPrompt",
        "choices": [{
          "type": "string",
          "enum": [
            "search"
          ]
        }]
      }
    ]
  },
  {
    "namespace": "search",
    "description": "Use browser.search to interact with search engines.",
    "permissions": ["search"],
    "types": [
      {
        "id": "SearchEngine",
        "type": "object",
        "description": "An object encapsulating a search engine",
        "properties": {
          "name": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          },
          "alias": {
            "type": "string",
            "optional": true
          },
          "favIconUrl": {
            "type": "string",
            "optional": true,
            "format": "url"
          }
        }
      }
    ],
    "functions": [
      {
        "name": "get",
        "type": "function",
        "description": "Gets a list of search engines.",
        "async": true,
        "parameters": []
      },
      {
        "name": "search",
        "type": "function",
        "description": "Perform a search.",
        "async": true,
        "parameters": [
          {
            "type": "object",
            "name": "searchProperties",
            "properties": {
              "query": {
                "type": "string",
                "description": "Terms to search for."
              },
              "engine": {
                "type": "string",
                "optional": true,
                "description": "Search engine to use. Uses the default if not specified."
              },
              "tabId": {
                "type": "integer",
                "optional": true,
                "description": "The ID of the tab for the search results. If not specified, a new tab is created."
              }
            }
          }
        ]
      }
    ]
  }
]