1323225 - Document need for WebExtension ID on MDN

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: Add-ons, defect)

Description

[Ethan Glasser-Camp (:glasserc)]

Although WebExtensions' IDs are "non-mandatory", under certain circumstances, certain APIs cannot function correctly withuot an ID. However, the documentation on when to use an ID in your WebExtension manifest and how is a little thin. :andym suggests that we should update https://developer.mozilla.org/en-US/Add-ons/WebExtensions/WebExtensions_and_the_Add-on_ID as well as any API documentation for the APIs listed in https://github.com/mozilla/addons-linter/issues/1064. Ideally, the MDN pages also explain that although https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/applications says that you cannot use this key in Chrome, what that means is that Chrome will report an error in your manifest, but load the extension anyhow (so, it's safe to use).

Comment 1

[Will Bamberg [:wbamberg]]

I've had a go at this.

In particular here:
https://developer.mozilla.org/en-US/Add-ons/WebExtensions/WebExtensions_and_the_Add-on_ID#When_do_you_need_an_Add-on_ID
https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/applications
https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/storage/sync

identity.getRedirectURL isn't documented yet.

Please let me know if this covers it.

Comment 2

[Ethan Glasser-Camp (:glasserc)]

Looks good to me, thanks!