The description field is documented to This field might contain markdown. at https://mozilla.github.io/addons-server/topics/api/addons.html
based on documentation source at https://github.com/mozilla/addons-server/blob/d96a6f95302946e81c3ac686789c4cb35a7d5397/docs/topics/api/addons.rst?plain=1#L167
which was last changed in mozilla/addons-server#22956
But when I look at https://services.addons.mozilla.org/api/v4/addons/addon/ublock-origin/?lang=en-US for example, I see that the description contains rendered HTML, not the markdown source:
uBlock Origin is <strong>not</strong> an "ad blocker" ... <a href="https://prod.outgoing.prod.webservices.mozgcp.net/v1/6a44868e1580018df8d4d87adf8e97cc74b71b962a73dd5a64604f99db767287/https%3A//crowdin.net/project/ublock" rel="nofollow">Contributors @ Crowdin</a></li></ul>
I think that the original documentation (This field might contain some HTML tags.) should be restored. Even if the input is markdown, the output is clearly rendered HTML. If this were to change to markdown, then Firefox would be showing the raw markdown instead of the rendered HTML (with minimal formatting, post sanitization).
┆Issue is synchronized with this Jira Task
The
descriptionfield is documented toThis field might contain markdown.at https://mozilla.github.io/addons-server/topics/api/addons.htmlbased on documentation source at https://github.com/mozilla/addons-server/blob/d96a6f95302946e81c3ac686789c4cb35a7d5397/docs/topics/api/addons.rst?plain=1#L167
which was last changed in mozilla/addons-server#22956
But when I look at https://services.addons.mozilla.org/api/v4/addons/addon/ublock-origin/?lang=en-US for example, I see that the description contains rendered HTML, not the markdown source:
I think that the original documentation (
This field might contain some HTML tags.) should be restored. Even if the input is markdown, the output is clearly rendered HTML. If this were to change to markdown, then Firefox would be showing the raw markdown instead of the rendered HTML (with minimal formatting, post sanitization).┆Issue is synchronized with this Jira Task