1516663 - Update chrome_settings_overrides search_provider documentation

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: Add-ons, enhancement, P3)

Description

[Tom S. (please needinfo tschuster)]

The compatibility table https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_settings_overrides#Browser_compatibility doesn't seem to match the code: https://searchfox.org/mozilla-central/rev/7a922172a94cfe24c7a48e0a581577895e1da8c4/toolkit/components/search/nsSearchService.js#3960

At least: 
 - suggestURL
 - suggestPostParams
 - encoding

Some of these seem to have been introduced a long time ago?

Comment 1

[Will Bamberg [:wbamberg]]

Thanks for filing, :evilpie.

It looks like suggestURL and suggestPostParams were added in bug 1486819 (Firefox 64), and the docs were updated, but the page wasn't refreshed so it didn't show up. I've now refreshed the page and they are there.

It looks like encoding was added in bug 1500741 (Firefox 65) but noone added dev-doc-needed, so the docs were not updated. I've added dev-doc-needed to that bug.

Unless there are other search_provider properties that need to be updated then I'd suggest we close this bug and track encoding in bug 1500741. From your link (https://searchfox.org/mozilla-central/rev/7a922172a94cfe24c7a48e0a581577895e1da8c4/toolkit/components/search/nsSearchService.js#3960) I don't see any obvious omissions (note that bug 1486819 comment 15 suggests that we might not want to document search_provider.params, and FWIW I don't think we should).

Comment 2

[Will Bamberg [:wbamberg]]

:evilpie, are there any properties that aren't covered in comment 1? Otherwise I would like to close this bug.

Comment 3

[Tom S. (please needinfo tschuster)]

Looks like everything is documented now (minus "params" as mentioned). The change doesn't show up on MDN yet, because browser-compat-data needs a new release.